Skip to content

docs: document the --modules flag in the init command #32599

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 1 commit into from
Jul 15, 2025
Merged

docs: document the --modules flag in the init command #32599

merged 1 commit into from
Jul 15, 2025

Conversation

cjpearson
Copy link
Contributor

🔗 Linked issue

📚 Description

This change updates the docs to include the --modules and --no-modules args. https://github.com/nuxt/cli/blob/c7c4dd100ed0488bc84f97d3610b0d30474f9e73/packages/nuxi/src/commands/init.ts#L124

(--no-modules is only in an RC release at this point, so I can remove that if necessary)

@cjpearson cjpearson requested a review from danielroe as a code owner July 13, 2025 17:35
@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 Jul 13, 2025

Walkthrough

The documentation for the create nuxt init command was updated to include two new command-line options: --modules, which allows users to specify Nuxt modules to install as a comma-separated list without spaces, and --no-modules, which skips the module installation prompt during project initialisation. These additions expand the available options for controlling module installation behaviour during the setup process.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests 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.

coderabbitai[bot]
coderabbitai bot reviewed Jul 13, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
docs/3.api/4.commands/init.md (2)

41-41: Use the correct hyphenation for compound adjectives.

Replace “comma separated” with “comma-separated” to follow standard English usage and keep consistency with the rest of the options table.

-`--modules` |  | Nuxt modules to install (comma separated without spaces)
+`--modules` |  | Nuxt modules to install (comma-separated without spaces)

41-42: Clarify availability of --no-modules flag in stable releases.

The description notes elsewhere that --no-modules is currently only in an RC version. Adding a brief parenthetical note here prevents confusion for users on the latest stable CLI.

-`--no-modules` |  | Skip module installation prompt
+`--no-modules` |  | Skip module installation prompt (available in the current RC only)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3e76089 and 0282879.

📒 Files selected for processing (1)
  • docs/3.api/4.commands/init.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: lint-docs

@danielroe danielroe merged commit 7e5869f into nuxt:main Jul 15, 2025
8 of 9 checks passed
@github-actions github-actions bot mentioned this pull request Jul 15, 2025
Merged
danielroe pushed a commit that referenced this pull request Jul 21, 2025
@cjpearson @danielroe
docs: document the --modules flag in the init command (#32599)
1e414ad
This was referenced Jul 21, 2025
Closed
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@danielroe danielroe Awaiting requested review from danielroe danielroe is a code owner

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

Successfully merging this pull request may close these issues.
2 participants
@cjpearson @danielroe