docs: recommend nuxt command consistently
#32237
Conversation
|
|
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation to consistently recommend using the nuxt command instead of nuxi throughout the project. The changes simplify usage instructions and examples for new users while ensuring consistent terminology.
Reviewed Changes
Copilot reviewed 67 out of 67 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/2.guide/3.going-further/3.modules.md | Updated commands from “nuxi” to “nuxt” in module examples. |
| docs/2.guide/3.going-further/11.nightly-release-channel.md | Replaced nightly command references from “nuxi-nightly” to “@nuxt/cli-nightly”. |
| docs/2.guide/3.going-further/10.runtime-config.md | Changed “Nuxi CLI” to “Nuxt CLI” in runtime configuration notes. |
| docs/2.guide/3.going-further/1.internals.md | Updated internal command references from “nuxi” to “nuxt”. |
| docs/2.guide/2.directory-structure/2.env.md | Replaced “nuxi” with “nuxt” commands in environment file examples. |
| docs/2.guide/2.directory-structure/1.server.md | Updated server documentation to use “nuxt” instead of “nuxi”. |
| docs/2.guide/2.directory-structure/1.content.md | Changed command used to add content module from “nuxi” to “nuxt”. |
| docs/2.guide/2.directory-structure/1.composables.md | Updated composables section with the proper “nuxt” commands. |
| docs/2.guide/1.concepts/9.code-style.md | Replaced “nuxi” with “nuxt” when advising module installation for ESLint. |
| docs/2.guide/1.concepts/8.typescript.md | Updated multiple TypeScript command examples from “nuxi” to “nuxt”. |
| docs/2.guide/1.concepts/5.modules.md | Revised module system documentation to use “nuxt” commands consistently. |
| docs/2.guide/1.concepts/3.rendering.md | Updated static site rendering instructions to refer to “nuxt” commands. |
| docs/1.getting-started/18.upgrade.md | Replaced upgrade commands from “nuxi” to “nuxt” in upgrade instructions. |
| docs/1.getting-started/16.deployment.md | Updated deployment instructions to use “nuxt” commands. |
| docs/1.getting-started/15.prerendering.md | Revised prerendering examples to consistently reference “nuxt” commands. |
| docs/1.getting-started/11.state-management.md | Updated installation instructions for Pinia module to use “nuxt” commands. |
| docs/1.getting-started/03.configuration.md | Changed configuration examples from “nuxi” to “nuxt” commands. |
| docs/1.getting-started/01.introduction.md | Modified introduction to reflect updated CLI naming conventions. |
| .github/workflows/semantic-pull-requests.yml | Removed the “nuxi” scope in the PR workflow configuration. |
| .github/ISSUE_TEMPLATE/bug-report.yml | Updated the bug report template to instruct using “nuxt info” instead of “nuxi info”. |
@nuxt/kit
nuxt
@nuxt/rspack-builder
@nuxt/schema
@nuxt/vite-builder
@nuxt/webpack-builder
commit: |
antfu
left a comment
There was a problem hiding this comment.
Does this mean we are gradually deprecating the usage of nuxi (I agree it can be confusing two have two CLI)? If so should we have a section somewhere in our docs to explain the difference between nuxi and nuxt and tell users whether they should migrate/change over?
WalkthroughThis update systematically replaces references to the "nuxi" CLI with "nuxt" or "@nuxt/cli" across documentation, error messages, comments, test scripts, and internal code. Documentation commands, examples, and explanations have been updated to use the "nuxt" CLI for consistency. Internal code comments and error messages now refer to "@nuxt/cli" instead of "nuxi". Test scripts and setup commands have been modified to invoke "nuxt" rather than "nuxi". Some documentation also updates package names and corrects command usage. No exported or public entity signatures have been altered. ✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
docs/2.guide/2.directory-structure/1.composables.md (1)
53-53: Suggest improving phrasing for conciseness.
Consider replacing "in order to let Nuxt generate the types" with "to generate types" or "to let Nuxt generate types" for brevity.🧰 Tools
🪛 LanguageTool
[style] ~53-~53: Consider a more concise word here.
Context: ...nuxt build](/docs/api/commands/build) in order to let Nuxt generate the types. ::note If...(IN_ORDER_TO_PREMIUM)
docs/3.api/4.commands/init.md (1)
17-17: Suggest consistent command naming.
The description refers to thecreate-nuxtcommand (with a hyphen), whereas both the title and example usecreate nuxt(without a hyphen). For consistency, consider changing`create-nuxt`to`create nuxt`.docs/3.api/4.commands/add.md (1)
100-100: Optional: Consider adding comma for clarity.The static analysis tool suggests adding a comma after 'alternatively' for improved readability.
-* Modifier flags: `--method` (can accept `connect`, `delete`, `get`, `head`, `options`, `patch`, `post`, `put` or `trace`) or alternatively you can directly use `--get`, `--post`, etc. +* Modifier flags: `--method` (can accept `connect`, `delete`, `get`, `head`, `options`, `patch`, `post`, `put` or `trace`) or alternatively, you can directly use `--get`, `--post`, etc.🧰 Tools
🪛 LanguageTool
[typographical] ~100-~100: Consider adding a comma after ‘alternatively’ for more clarity.
Context: ...,patch,post,putortrace) or alternatively you can directly use--get,--post,...(RB_LY_COMMA)
docs/3.api/4.commands/dev.md (1)
53-53: Nit: improve phrasing for clarity
Consider rephrasing "Additionally to the above options" to "In addition to the above options" for smoother readability.docs/2.guide/3.going-further/3.modules.md (1)
62-62: Refine playground command phrasing
Consider replacing “used against” with “run on” for clearer phrasing:-All other `nuxt` commands can be used against the `playground` directory... +All other `nuxt` commands can be run on the `playground` directory...🧰 Tools
🪛 LanguageTool
[style] ~62-~62: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...ory (e.g.nuxt <COMMAND> playground). Feel free to declare additionaldev:*scripts with...(FEEL_FREE_TO_STYLE_ME)
[uncategorized] ~62-~62: Loose punctuation mark.
Context: ...json` referencing them for convenience. :: #### How to Test The module starter ...(UNLIKELY_OPENING_PUNCTUATION)
docs/2.guide/2.directory-structure/2.env.md (1)
60-60: Grammar refinement for production preview instruction
Consider pluralising “purpose” for smoother reading:-For local production preview purpose, we recommend using [`nuxt preview`](...) +For local production preview purposes, we recommend using [`nuxt preview`](...)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (11)
package.jsonis excluded by!package.json,!**/package.jsonplayground/package.jsonis excluded by!**/package.jsontest/fixtures/basic-types/package.jsonis excluded by!**/package.jsontest/fixtures/basic/package.jsonis excluded by!**/package.jsontest/fixtures/hmr/package.jsonis excluded by!**/package.jsontest/fixtures/minimal-pages/package.jsonis excluded by!**/package.jsontest/fixtures/minimal-types/package.jsonis excluded by!**/package.jsontest/fixtures/minimal/package.jsonis excluded by!**/package.jsontest/fixtures/runtime-compiler/package.jsonis excluded by!**/package.jsontest/fixtures/spa-loader/package.jsonis excluded by!**/package.jsontest/fixtures/suspense/package.jsonis excluded by!**/package.json
📒 Files selected for processing (56)
.github/ISSUE_TEMPLATE/bug-report.yml(1 hunks).github/workflows/semantic-pull-requests.yml(0 hunks)docs/1.getting-started/01.introduction.md(1 hunks)docs/1.getting-started/03.configuration.md(1 hunks)docs/1.getting-started/11.state-management.md(1 hunks)docs/1.getting-started/15.prerendering.md(2 hunks)docs/1.getting-started/16.deployment.md(1 hunks)docs/1.getting-started/18.upgrade.md(2 hunks)docs/2.guide/1.concepts/3.rendering.md(1 hunks)docs/2.guide/1.concepts/5.modules.md(1 hunks)docs/2.guide/1.concepts/8.typescript.md(4 hunks)docs/2.guide/1.concepts/9.code-style.md(1 hunks)docs/2.guide/2.directory-structure/1.composables.md(1 hunks)docs/2.guide/2.directory-structure/1.content.md(1 hunks)docs/2.guide/2.directory-structure/1.server.md(1 hunks)docs/2.guide/2.directory-structure/2.env.md(3 hunks)docs/2.guide/3.going-further/1.internals.md(2 hunks)docs/2.guide/3.going-further/10.runtime-config.md(1 hunks)docs/2.guide/3.going-further/11.nightly-release-channel.md(1 hunks)docs/2.guide/3.going-further/3.modules.md(2 hunks)docs/2.guide/3.going-further/9.debugging.md(1 hunks)docs/2.guide/4.recipes/4.sessions-and-authentication.md(1 hunks)docs/3.api/1.components/10.nuxt-picture.md(1 hunks)docs/3.api/1.components/9.nuxt-img.md(1 hunks)docs/3.api/2.composables/use-preview-mode.md(2 hunks)docs/3.api/4.commands/add.md(3 hunks)docs/3.api/4.commands/analyze.md(2 hunks)docs/3.api/4.commands/build-module.md(2 hunks)docs/3.api/4.commands/build.md(2 hunks)docs/3.api/4.commands/cleanup.md(2 hunks)docs/3.api/4.commands/dev.md(3 hunks)docs/3.api/4.commands/devtools.md(2 hunks)docs/3.api/4.commands/generate.md(2 hunks)docs/3.api/4.commands/info.md(2 hunks)docs/3.api/4.commands/init.md(2 hunks)docs/3.api/4.commands/module.md(4 hunks)docs/3.api/4.commands/prepare.md(2 hunks)docs/3.api/4.commands/preview.md(2 hunks)docs/3.api/4.commands/typecheck.md(2 hunks)docs/3.api/4.commands/upgrade.md(2 hunks)docs/3.api/6.advanced/1.hooks.md(1 hunks)docs/5.community/4.contribution.md(1 hunks)docs/5.community/7.changelog.md(1 hunks)docs/7.migration/2.configuration.md(2 hunks)packages/kit/src/template.ts(1 hunks)packages/nuxi/README.md(1 hunks)packages/nuxt/src/app/components/nuxt-stubs.ts(1 hunks)packages/nuxt/src/app/composables/script-stubs.ts(1 hunks)packages/nuxt/src/components/plugins/loader.ts(1 hunks)packages/nuxt/src/core/features.ts(1 hunks)packages/nuxt/src/core/nuxt.ts(1 hunks)packages/schema/src/types/hooks.ts(1 hunks)scripts/bump-edge.ts(1 hunks)test/bundle.test.ts(1 hunks)test/prepare.ts(1 hunks)test/typed-router.test.ts(1 hunks)
💤 Files with no reviewable changes (1)
- .github/workflows/semantic-pull-requests.yml
🧰 Additional context used
🧠 Learnings (1)
packages/nuxt/src/components/plugins/loader.ts (1)
Learnt from: GalacticHypernova
PR: nuxt/nuxt#26468
File: packages/nuxt/src/components/plugins/loader.ts:24-24
Timestamp: 2024-11-05T15:22:54.759Z
Learning: In `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distDir` are legacy code from before Nuxt used the new unplugin VFS and will be removed.
🪛 LanguageTool
docs/1.getting-started/11.state-management.md
[uncategorized] ~87-~87: Loose punctuation mark.
Context: ....vuejs.org/ssr/nuxt.html#Installation). :: ::code-group ```ts [stores/website.ts...
(UNLIKELY_OPENING_PUNCTUATION)
docs/2.guide/3.going-further/10.runtime-config.md
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ... your .env file will not be read. :read-more{to="/docs/guide/directory-stru...
(UNLIKELY_OPENING_PUNCTUATION)
docs/1.getting-started/15.prerendering.md
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ... site's pages they link to, and so on. ::code-group{sync="pm"} ```bash [npm] np...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...more about the nuxt generate command. :: ### Selective Pre-rendering You can ...
(UNLIKELY_OPENING_PUNCTUATION)
docs/1.getting-started/16.deployment.md
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...at cannot be server rendered (if any). :read-more{title="Nuxt prerendering" to="...
(UNLIKELY_OPENING_PUNCTUATION)
docs/2.guide/2.directory-structure/1.composables.md
[style] ~53-~53: Consider a more concise word here.
Context: ...nuxt build](/docs/api/commands/build) in order to let Nuxt generate the types. ::note If...
(IN_ORDER_TO_PREMIUM)
docs/3.api/2.composables/use-preview-mode.md
[uncategorized] ~117-~117: Loose punctuation mark.
Context: ...eview) is not related to preview mode.) ::
(UNLIKELY_OPENING_PUNCTUATION)
docs/2.guide/1.concepts/3.rendering.md
[uncategorized] ~100-~100: Loose punctuation mark.
Context: ...y page as a separate static HTML file. ::warning If you prerender your app with ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...unctionality, use nuxt build instead. :: If you are using purely client-side r...
(UNLIKELY_OPENING_PUNCTUATION)
docs/2.guide/1.concepts/8.typescript.md
[uncategorized] ~56-~56: A comma might be missing here.
Context: ...ed within your buildDir (.nuxt) and therefore for full typings, you will need to run ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~80-~80: You might be missing the article “the” here.
Context: ...zed. :br :br In case you need to extend options provided by ./.nuxt/tsconfig.json fur...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...nd ./.nuxt/tsconfig.json accordingly. :: ## Strict Checks TypeScript comes wi...
(UNLIKELY_OPENING_PUNCTUATION)
docs/3.api/4.commands/add.md
[typographical] ~100-~100: Consider adding a comma after ‘alternatively’ for more clarity.
Context: ..., patch, post, put or trace) or alternatively you can directly use --get, --post,...
(RB_LY_COMMA)
docs/7.migration/2.configuration.md
[uncategorized] ~150-~150: Loose punctuation mark.
Context: ...ges/tsc) with nuxt typecheck command. :: ### Migration 1. Create a `tsconfig....
(UNLIKELY_OPENING_PUNCTUATION)
docs/1.getting-started/18.upgrade.md
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...ases), use the nuxt upgrade command. ::code-group{sync="pm"} ```bash [npm] np...
(UNLIKELY_OPENING_PUNCTUATION)
docs/2.guide/3.going-further/3.modules.md
[style] ~62-~62: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...ory (e.g. nuxt <COMMAND> playground). Feel free to declare additional dev:* scripts with...
(FEEL_FREE_TO_STYLE_ME)
[uncategorized] ~62-~62: Loose punctuation mark.
Context: ...json` referencing them for convenience. :: #### How to Test The module starter ...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 GitHub Actions: docs
docs/1.getting-started/11.state-management.md
[error] 1-1: Network error: error sending request for url (https://vuejs.org/api/reactivity-core.html#ref) Maybe a certificate error.
⏰ Context from checks skipped due to timeout of 90000ms (20)
- GitHub Check: test-fixtures (windows-latest, built, vite, default, manifest-on, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, webpack, default, manifest-on, json, 20)
- GitHub Check: test-fixtures (windows-latest, built, rspack, async, manifest-on, json, 20)
- GitHub Check: test-fixtures (windows-latest, built, vite, async, manifest-on, json, 20)
- GitHub Check: test-fixtures (windows-latest, dev, vite, async, manifest-on, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-on, js, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, rspack, default, manifest-on, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, rspack, async, manifest-on, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-on, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, dev, vite, default, manifest-off, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-off, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, vite, default, manifest-off, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, vite, default, manifest-on, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, dev, vite, default, manifest-on, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, webpack, async, manifest-on, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-off, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-on, js, 20)
- GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-on, json, 20)
- GitHub Check: test-benchmark
- GitHub Check: typecheck (windows-latest, bundler)
🔇 Additional comments (83)
.github/ISSUE_TEMPLATE/bug-report.yml (1)
18-18: LGTM! Command update improves consistency.The change from
npx nuxi infotonpx nuxt infoaligns perfectly with the PR objective of consistently recommending thenuxtcommand. This ensures users see consistent command syntax when reporting bugs.packages/nuxt/src/core/features.ts (1)
51-51: LGTM! Internal comment update maintains consistency.The TODO comment update from "Nuxi" to "@nuxt/cli" aligns with the project's naming convention changes and maintains consistency in internal documentation.
packages/nuxi/README.md (1)
1-1: LGTM! Title simplification improves clarity.Removing "(nuxi)" from the README title makes it cleaner and aligns with the consistent use of "nuxt" command throughout the project. The simplified "Nuxt CLI" title is more straightforward for users.
test/typed-router.test.ts (1)
11-11:Details
❓ Verification inconclusive
LGTM! Test command update maintains consistency.
The change from
nuxi preparetonuxt preparealigns with the PR objective of consistently using thenuxtcommand. This ensures tests demonstrate the recommended command usage.Please verify that the
nuxt preparecommand works correctly in the test environment:
🏁 Script executed:
#!/bin/bash # Description: Verify that the nuxt command is available and functional in the test environment # Expected: The nuxt command should be available and provide the same functionality as nuxi # Test: Check if nuxt command is available which nuxt # Test: Check nuxt command help to verify prepare subcommand exists nuxt --help | grep -A 5 -B 5 "prepare"Length of output: 242
Please verify that the
nuxtCLI is available where tests runBefore merging, ensure that switching from
nuxi preparetonuxt preparewon’t break test executions:• Confirm
nuxtis installed (or aliased) in your devDependencies and linked intonode_modules/.bin.
• Update CI-and-local setup to install thenuxtpackage so the binary is present.
• Run the full test suite locally and in CI to validatenuxt prepareexecutes as expected.docs/2.guide/2.directory-structure/1.server.md (1)
147-147: Consistent CLI command reference
The updated reference tonuxt typecheckaligns with the project-wide shift fromnuxitonuxt. This ensures users see the correct command for type checking.docs/3.api/1.components/10.nuxt-picture.md (1)
22-22: Corrected module installation command
Changing the CLI invocation tonpx nuxt module add imagekeeps it consistent with the newnuxt-first approach and matches other module installation instructions.docs/1.getting-started/11.state-management.md (1)
87-87: Unified CLI command usage
The installation snippet now usesnpx nuxt module add pinia, in line with the renaming of allnuxireferences tonuxt.🧰 Tools
🪛 LanguageTool
[uncategorized] ~87-~87: Loose punctuation mark.
Context: ....vuejs.org/ssr/nuxt.html#Installation). :: ::code-group ```ts [stores/website.ts...(UNLIKELY_OPENING_PUNCTUATION)
packages/nuxt/src/components/plugins/loader.ts (1)
57-57: Non-functional comment update
This change only revises an internal TODO comment to reference@nuxt/cliand has no impact on the plugin’s logic.docs/2.guide/3.going-further/9.debugging.md (1)
25-25: Updated debug command
Switching tonuxt dev --inspectensures the correct CLI is invoked for debugging, matching the broader documentation changes.docs/2.guide/2.directory-structure/1.content.md (1)
24-24: CLI command consistency
The installation command has been correctly updated fromnpx nuxi module add contenttonpx nuxt module add content, aligning with the standardised Nuxt CLI naming.docs/1.getting-started/03.configuration.md (1)
53-53: Use the Nuxt CLI for environment overrides
The example has been correctly updated to usenuxt build --envName staginginstead of the oldnuxicommand, ensuring consistency with the current CLI.docs/3.api/4.commands/build.md (2)
2-2: Update documentation title to Nuxt
Thetitlefield has been updated tonuxt build, reflecting the renamed CLI entry.
13-13: Revise build command invocation
The build command example now correctly usesnpx nuxt buildin place ofnpx nuxi build.docs/3.api/4.commands/prepare.md (2)
2-2: Align title with Nuxt CLI
The title has been updated tonuxt prepare, matching the renamed CLI tool.
13-13: Correct prepare command example
The command invocation has been updated tonpx nuxt prepare, ensuring consistency across the CLI docs.docs/5.community/4.contribution.md (1)
55-55: Adjust commit scope example for monorepo
The example commit scope has been updated tofeat(kit): add 'addMagicStuff' utility, removing the outdatednuxireference and reflecting current project structure.docs/2.guide/1.concepts/9.code-style.md (1)
17-17: LGTM! Consistent command naming update.The change from
nuxitonuxtfor the module installation command aligns perfectly with the PR objective to recommend thenuxtcommand consistently throughout the documentation.docs/3.api/4.commands/build-module.md (2)
2-2: LGTM! Title updated for consistency.The title change from
nuxi build-moduletonuxt build-moduleensures the documentation header aligns with the standardised command naming.
13-13: LGTM! Command example updated correctly.The command example has been properly updated from
npx nuxi build-moduletonpx nuxt build-module, maintaining the same functionality whilst using the recommended command name.docs/3.api/1.components/9.nuxt-img.md (1)
24-24: LGTM! Module installation command updated consistently.The change from
npx nuxi module add imagetonpx nuxt module add imagemaintains functionality whilst using the recommended command syntax, improving consistency for users installing the Nuxt Image module.test/prepare.ts (1)
22-22: LGTM! Test script updated to match documented commands.The change from
'nuxi', 'prepare'to'nuxt', 'prepare'ensures the test preparation script uses the same command syntax that's now recommended in the documentation, maintaining consistency between tooling and documentation.docs/3.api/4.commands/upgrade.md (2)
2-2: Standardised CLI command name in title
The title has been updated from "nuxi upgrade" to "nuxt upgrade", aligning with the project-wide CLI naming convention.
13-13: Updated CLI usage example
The command example now correctly usesnpx nuxt upgradeinstead ofnpx nuxi upgrade.scripts/bump-edge.ts (1)
9-10: Include@nuxt/cliin nightly packages mapping
ThenightlyPackagesobject now consistently quotes keys and adds the@nuxt/clientry, ensuring the new CLI package is handled in nightly bumps.docs/5.community/7.changelog.md (1)
26-26: Updated CLI release card reference
Changed the release card description to "Nuxt CLI (@nuxt/cli)" to reflect the new package naming.docs/3.api/4.commands/typecheck.md (2)
2-2: Standardised CLI command name in title
The documentation title now reads "nuxt typecheck" instead of "nuxi typecheck".
13-13: Updated CLI usage example
The example has been updated tonpx nuxt typecheck, aligning with the unified CLI naming.docs/2.guide/3.going-further/10.runtime-config.md (1)
47-47: Standardised term toNuxt CLIin note
The note now refers to "Nuxt CLI" instead of "Nuxi CLI", consistent with project-wide documentation updates.🧰 Tools
🪛 LanguageTool
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ... your.envfile will not be read. :read-more{to="/docs/guide/directory-stru...(UNLIKELY_OPENING_PUNCTUATION)
docs/3.api/4.commands/analyze.md (2)
2-2: Consistent CLI command naming in title. Title updated to usenuxt analyzeinstead ofnuxi analyze, ensuring consistency across documentation.
13-14: Update example usage to usenuxtCLI. The command example now correctly usesnpx nuxt analyze, replacingnuxi.docs/2.guide/1.concepts/5.modules.md (1)
10-10: Standardise CLI command references. Replaced references tonuxi devandnuxi buildwithnuxt devandnuxt build, aligning with the updated CLI naming convention.docs/3.api/4.commands/devtools.md (3)
2-2: Update title to usenuxtCLI. Title now reads "nuxt devtools", matching the new command naming scheme.
13-13: Align devtools example with new CLI name. Example command updated tonpx nuxt devtools <COMMAND>, replacingnuxi devtools.
17-17: Reflect CLI rename in descriptive text. Updated guidance to refer tonuxt devtoolscommands, ensuring consistency.docs/3.api/4.commands/preview.md (2)
2-2: Update preview command title. Changed title from "nuxi preview" to "nuxt preview".
13-13: UsenuxtCLI in example. Example command updated tonpx nuxt preview, replacingnuxi.packages/nuxt/src/core/nuxt.ts (1)
529-529: Align internal refactor comment with CLI rename. The TODO now correctly references@nuxt/cliinstead ofnuxi, matching project-wide CLI naming.docs/3.api/4.commands/info.md (2)
2-2: Consistent CLI naming in title
The frontmatter title has been correctly updated from “nuxi info” to “nuxt info”, aligning with the rest of the documentation.
13-13: Updated CLI invocation
The example usage now correctly showsnpx nuxt info, replacing the formernpx nuxi info. This aligns with the PR objective to standardise onnuxt.docs/3.api/4.commands/cleanup.md (2)
2-2: Consistent CLI naming in title
The title has been updated from “nuxi cleanup” to “nuxt cleanup”, matching the new CLI naming convention.
13-13: Updated CLI invocation
The usage example now readsnpx nuxt cleanup, correctly replacingnpx nuxi cleanupas intended.docs/1.getting-started/16.deployment.md (2)
73-73: Updated CLI command in SSG description
The static site generation section now referencesnuxt generateinstead ofnuxi generate, ensuring the documentation is consistent with the current CLI.
80-80: Updated CLI command in client-side rendering description
The client-side only rendering note now correctly points tonuxt generate, replacing the oldnuxi generate.docs/2.guide/4.recipes/4.sessions-and-authentication.md (2)
14-14: Updated module installation instruction
The prose has been updated to instruct users to use thenuxtCLI for adding thenuxt-auth-utilsmodule, replacing references tonuxi.
17-17: Updated CLI invocation for module add
The command example now correctly showsnpx nuxt module add auth-utilsinstead of the previousnpx nuxi@latest module add auth-utils.docs/3.api/2.composables/use-preview-mode.md (2)
106-107: Updated upstream CLI commands
Both lines in the example now invokenpx nuxt generateandnpx nuxt preview, replacing the priornpx nuxicommands. This aligns with the unified CLI branding.
117-117: Ensured correct CLI commands in note
The follow-up note has been updated to referencenuxt generateandnuxt previewinstead ofnuxt devwhere appropriate.🧰 Tools
🪛 LanguageTool
[uncategorized] ~117-~117: Loose punctuation mark.
Context: ...eview) is not related to preview mode.) ::(UNLIKELY_OPENING_PUNCTUATION)
docs/3.api/6.advanced/1.hooks.md (1)
71-71: Verified renaming consistency.
The hook description correctly replaces "Nuxi" with "@nuxt/cli", matching the updated CLI naming convention. No further changes needed.docs/3.api/4.commands/init.md (2)
2-2: Approve updated title.
The document title has been correctly updated from "nuxi init" to "create nuxt", aligning with the new command usage.
13-13: Approve command example update.
The code snippet now correctly usesnpm create nuxt@latest, replacing the oldnpx nuxi init. This aligns with the updated project scaffolding convention.test/bundle.test.ts (1)
14-16: Approve CLI command replacement in tests.
The build commands inbeforeAllhave been correctly updated frompnpm nuxi buildtopnpm nuxt build, matching the new CLI usage. All test logic remains unaffected.packages/nuxt/src/app/components/nuxt-stubs.ts (1)
7-7: Verified stub message update.
The error message now suggestsnpx nuxt module add @nuxt/imageinstead of usingnpx nuxi, aligning with the standardized CLI naming. Looks good.docs/1.getting-started/15.prerendering.md (1)
13-13: LGTM: Consistent CLI command updatesThe documentation has been systematically updated to use
nuxt generateinstead ofnuxi generateacross all package managers and references. The changes maintain functionality while aligning with the PR objective to recommend thenuxtcommand consistently.Also applies to: 20-20, 24-24, 28-28, 32-32, 48-50
docs/7.migration/2.configuration.md (1)
150-150: LGTM: Migration documentation updated correctlyThe TypeScript-related commands have been properly updated from
nuxitonuxt, maintaining the same functionality while following the consistent CLI naming convention.Also applies to: 163-163
🧰 Tools
🪛 LanguageTool
[uncategorized] ~150-~150: Loose punctuation mark.
Context: ...ges/tsc) withnuxt typecheckcommand. :: ### Migration 1. Create a `tsconfig....(UNLIKELY_OPENING_PUNCTUATION)
docs/3.api/4.commands/generate.md (1)
2-2: LGTM: API documentation updated consistentlyThe generate command documentation has been properly updated to use
nuxtinstead ofnuxiin the title, usage example, and description text. All changes maintain accuracy while following the consistent CLI naming convention.Also applies to: 13-13, 17-17
packages/nuxt/src/app/composables/script-stubs.ts (1)
5-5: LGTM: Error message updated with correct CLI commandThe installation command suggestion in the error message has been properly updated from
npx nuxi@latest module add @nuxt/scriptstonpx nuxt module add @nuxt/scripts, maintaining helpful user guidance while following the consistent CLI naming convention.packages/kit/src/template.ts (1)
387-387: LGTM: Removed outdated CLI branding from generated filesThe removal of the "Generated by nuxi" comment from the generated
tsconfig.jsonandnuxt.d.tsfiles is appropriate and aligns with the PR objective to standardise CLI references. The files are now generated cleanly without the outdated branding comment whilst maintaining the same functionality.Also applies to: 390-390
docs/3.api/4.commands/add.md (1)
2-2: LGTM! Consistent command naming throughout documentation.All instances of
nuxi addhave been correctly updated tonuxt addthroughout the documentation, maintaining consistency with the PR objective.Also applies to: 13-13, 42-42, 45-45, 51-51, 54-54, 58-58, 61-61, 65-65, 68-68, 74-74, 77-77, 81-81, 86-86, 89-89, 95-95, 98-98, 104-104, 107-107, 111-111
packages/schema/src/types/hooks.ts (1)
298-298: LGTM! Appropriate internal reference updates.The comments have been correctly updated from "Nuxi" to "@nuxt/cli", which is appropriate for internal code documentation. This maintains consistency with the package naming while distinguishing from user-facing command references.
Also applies to: 306-306
docs/2.guide/1.concepts/3.rendering.md (1)
99-99: LGTM! Command references updated consistently.The commands
nuxi generateandnuxi build --prerenderhave been correctly updated tonuxt generateandnuxt build --prerender, maintaining consistency with the PR objective.Also applies to: 102-102
docs/2.guide/3.going-further/1.internals.md (1)
10-10: LGTM! Development and build command references updated correctly.The commands
nuxi devandnuxi buildhave been properly updated tonuxt devandnuxt buildrespectively, aligning with the consistent CLI naming objective.Also applies to: 81-81
docs/3.api/4.commands/dev.md (2)
2-2: Consistent command title update
The title has been correctly updated tonuxt dev, aligning with the unified CLI naming convention throughout the documentation.
13-13: CLI invocation updated
The example now correctly usesnpx nuxt devwith both short (-p,-h) and long option flags included for clarity.docs/3.api/4.commands/module.md (5)
2-2: Command title updated
The title has been updated tonuxt module, reflecting the new CLI command name.
11-11: Introduction paragraph aligned
The opening line now consistently refers to Nuxt modules, removing any legacynuximentions.
17-17: Module add invocation updated
Example command correctly usesnpx nuxt module addinstead of the oldnuxiprefix.
53-53: Module search header updated
The section header now readsnuxt module search, matching the updated command.
57-57: Module search invocation updated
The search example now correctly usesnpx nuxt module search.docs/1.getting-started/01.introduction.md (1)
75-77: Updated core package list
The core packages section now lowercases "core engine", adds@nuxt/rspack-builderto the bundlers list, and updates the CLI package to@nuxt/cli.docs/2.guide/1.concepts/8.typescript.md (4)
8-8: Updated CLI reference in type-checking instructions
The example now correctly usesnuxt devinstead ofnuxi dev, aligning with the standardised CLI naming.
32-32: Type-check command updated
The command example has been updated tonpx nuxt typecheck, reflecting the CLI rename.
50-50: Generation instructions aligned
The description now correctly mentions runningnuxt devornuxt buildfor IDE type support generation.
80-80: Alias extension note updated
The guidance for extending options via thealiasproperty innuxt.confighas been updated to reference the new CLI context.🧰 Tools
🪛 LanguageTool
[uncategorized] ~80-~80: You might be missing the article “the” here.
Context: ...zed. :br :br In case you need to extend options provided by./.nuxt/tsconfig.jsonfur...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...nd./.nuxt/tsconfig.jsonaccordingly. :: ## Strict Checks TypeScript comes wi...(UNLIKELY_OPENING_PUNCTUATION)
docs/1.getting-started/18.upgrade.md (2)
11-11: CLI command updated for upgrade
The upgrade guide now instructs users to runnuxt upgradeinstead ofnuxi upgrade.
16-16: Upgrade command example updated
The code example usesnpx nuxt upgrade, ensuring consistency across package managers.docs/2.guide/3.going-further/11.nightly-release-channel.md (4)
26-33: Ensure nightly opt-in instructions reflect correct package syntax
The diff correctly shows replacing the stable Nuxt package with the nightly tag inpackage.json. This aligns with the goal to opt in to nightly releases.
41-48: Ensure nightly opt-out instructions revert to the stable package
The reverse diff for opting out correctly restores the stablenuxtversion. This matches the documented workflow.
52-52: Add “Using Nightly@nuxt/cli” section header
The new heading clearly introduces how to use the nightly CLI package. Naming is consistent with the updated branding.
57-57: Update example command to@nuxt/cli-nightly
The example now invokes the correct scoped package (@nuxt/cli-nightly). Confirm that this package name is published and boxed into CI tests.docs/2.guide/3.going-further/3.modules.md (1)
9-9: Switch CLI command references fromnuxitonuxt
The description now correctly usesnuxt devandnuxt build, aligning with the renamed CLI.docs/2.guide/2.directory-structure/2.env.md (3)
14-14: Update dotenv support commands to usenuxt
The description now correctly refers tonuxt buildandnuxt generate, matching the rebranded CLI.
28-28: Clarify custom dotenv file invocation via Nuxt CLI
The note now generically references “the Nuxt CLI”, which covers bothnpx nuxtand global installs.
31-31: Correct example for custom dotenv flag usage
Thenpx nuxt dev --dotenv .env.localcommand is correctly updated.
|
Exactly. So users will use We can start avoiding 'nuxi' which might be confusing, and instead talk about 'the Nuxt CLI' or even just 'nuxt'. (and yes, we should certainly have an explainer - what is |
CodSpeed Performance ReportMerging #32237 will not alter performanceComparing Summary
|
|
Will there be a migration script? |
|
|
@danielroe Is there any chance we can get a "nuxi vs nuxt" sequel? 😀 https://www.youtube.com/watch?v=R1YLXgCVSec I was searching for a quick explainer, but I think this recommendation is now out of date? |
🔗 Linked issue
📚 Description
this simplifies the usage of nuxi/nuxt throughout the project, which should hopefully make things more straightforward for new users