Skip to content

docs: reverted to npx nuxi init where --template is used #31469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Mar 20, 2025
Merged

docs: reverted to npx nuxi init where --template is used #31469

merged 2 commits into from
Mar 20, 2025

Conversation

jhony1104
Copy link
Contributor

📚 Description

Since npm create nuxt does not support the --template option, this PR reverts all changes of fc4a8e8 that use --template.

@jhony1104 jhony1104 requested a review from danielroe as a code owner March 20, 2025 11:01
@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Mar 20, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The changes update the commands used in the documentation for creating Nuxt modules and layers. In the modules guide, the command for npm has been modified from npm create nuxt -t module my-module to npm create nuxt -- -t module my-module, and similarly, the command for pnpm has been changed from pnpm create nuxt -t module my-module to pnpm create nuxt -- -t module my-module. Additionally, in the layers guide, the command has been updated from npm create nuxt --template layer nuxt-layer to npm create nuxt -- --template layer nuxt-layer. These changes introduce the use of an additional -- to clarify command parsing. No modifications have been made to the declarations of exported or public entities.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ae8f341 and 65038a4.

📒 Files selected for processing (2)
  • docs/2.guide/3.going-further/3.modules.md (1 hunks)
  • docs/2.guide/3.going-further/7.layers.md (1 hunks)
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@danielroe
Copy link
Member

we should add an extra -- instead

@danielroe danielroe merged commit 6fbdc1b into nuxt:main Mar 20, 2025
5 of 7 checks passed
@github-actions github-actions bot mentioned this pull request Mar 20, 2025
Draft
@jhony1104 jhony1104 deleted the patch-1 branch March 20, 2025 11:39
@danielroe danielroe mentioned this pull request Mar 20, 2025
Closed
danielroe pushed a commit that referenced this pull request Mar 20, 2025
@jhony1104 @danielroe
docs: add missing -- before --template (#31469)
9e825a1
@github-actions github-actions bot mentioned this pull request Mar 20, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danielroe danielroe danielroe approved these changes

Assignees
No one assigned
Labels
3.x documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jhony1104 @danielroe
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy