diff --git a/docs/add.md b/docs/add.md index a000f3280..2f242c1e8 100644 --- a/docs/add.md +++ b/docs/add.md @@ -10,7 +10,7 @@ links: ```bash [Terminal] -npx nuxt add [--cwd=] [--logLevel=] [--skipInstall] [--skipConfig] [--dev] [--packageManager=] +npx nuxt add [--cwd=] [--logLevel=] [--skipInstall] [--skipConfig] [--dev] [--packageManager=] ``` @@ -27,14 +27,14 @@ The `add` command installs [Nuxt modules](/modules) and [layers](/docs/getting-s ## Options -| Option | Default | Description | -|------------------------------------------------------------|---------|-------------------------------------------------| -| `--cwd=` | `.` | Specify the root directory of your Nuxt project | -| `--logLevel=` | | Specify build-time log level | -| `--skipInstall` | | Skip npm install | -| `--skipConfig` | | Skip nuxt.config.ts update | -| `--dev` | | Install modules as dev dependencies | -| `--packageManager=` | | Package manager to install with | +| Option | Default | Description | +|-----------------------------------------------------------------|---------|-------------------------------------------------| +| `--cwd=` | `.` | Specify the root directory of your Nuxt project | +| `--logLevel=` | | Specify build-time log level | +| `--skipInstall` | | Skip npm install | +| `--skipConfig` | | Skip nuxt.config.ts update | +| `--dev` | | Install modules as dev dependencies | +| `--packageManager=` | | Package manager to install with | When running the command, it will: diff --git a/docs/init.md b/docs/init.md index c138851eb..719a83b0b 100644 --- a/docs/init.md +++ b/docs/init.md @@ -10,7 +10,7 @@ links: ```bash [Terminal] -npm create nuxt@latest [DIR] -- [--cwd=] [--logLevel=] [-t, --template=] [-f, --force] [--offline] [--preferOffline] [--install] [--gitInit] [--shell] [--packageManager=] [-M, --modules=] [--nightly=] +npm create nuxt@latest [DIR] -- [--cwd=] [--logLevel=] [-t, --template=] [-f, --force] [--offline] [--preferOffline] [--install] [--gitInit] [--shell] [--packageManager=] [-M, --modules=] [--nightly=] ``` @@ -33,23 +33,23 @@ The `create-nuxt` command initializes a fresh Nuxt project using [unjs/giget](ht ## Options -| Option | Default | Description | -|------------------------------------------------------------|---------|--------------------------------------------------------------------------------------| -| `--cwd=` | `.` | Specify the directory to create the project in | -| `--logLevel=` | | Specify build-time log level | -| `-t, --template=` | | Template name | -| `-f, --force` | | Override existing directory | -| `--offline` | | Force offline mode | -| `--preferOffline` | | Prefer offline mode | -| `--install` | `true` | Install dependencies once the project has been scaffolded | -| `--no-install` | | Skip installing dependencies | -| `--gitInit` | | Initialize git repository | -| `--no-gitInit` | | Skip git repository initialization | -| `--shell` | | Start shell after installation in project directory | -| `--packageManager=` | | Package manager choice | -| `-M, --modules=` | | Nuxt modules to install (comma separated without spaces) | -| `--no-modules` | | Skip module installation prompt | -| `--nightly=` | | Use Nuxt nightly release channel (a `nuxt-nightly` dist tag, defaulting to `latest`) | +| Option | Default | Description | +|-----------------------------------------------------------------|---------|--------------------------------------------------------------------------------------| +| `--cwd=` | `.` | Specify the directory to create the project in | +| `--logLevel=` | | Specify build-time log level | +| `-t, --template=` | | Template name | +| `-f, --force` | | Override existing directory | +| `--offline` | | Force offline mode | +| `--preferOffline` | | Prefer offline mode | +| `--install` | `true` | Install dependencies once the project has been scaffolded | +| `--no-install` | | Skip installing dependencies | +| `--gitInit` | | Initialize git repository | +| `--no-gitInit` | | Skip git repository initialization | +| `--shell` | | Start shell after installation in project directory | +| `--packageManager=` | | Package manager choice | +| `-M, --modules=` | | Nuxt modules to install (comma separated without spaces) | +| `--no-modules` | | Skip module installation prompt | +| `--nightly=` | | Use Nuxt nightly release channel (a `nuxt-nightly` dist tag, defaulting to `latest`) | ## Non-interactive use diff --git a/docs/module.md b/docs/module.md index 62f29d9db..e343f1cb4 100644 --- a/docs/module.md +++ b/docs/module.md @@ -14,7 +14,7 @@ Nuxt provides a few utilities to work with [Nuxt modules](/modules) seamlessly. ```bash [Terminal] -npx nuxt module add [--cwd=] [--logLevel=] [--skipInstall] [--skipConfig] [--dev] [--packageManager=] +npx nuxt module add [--cwd=] [--logLevel=] [--skipInstall] [--skipConfig] [--dev] [--packageManager=] ``` @@ -29,14 +29,14 @@ npx nuxt module add [--cwd=] [--logLevel= -| Option | Default | Description | -|------------------------------------------------------------|---------|-------------------------------------------------| -| `--cwd=` | `.` | Specify the root directory of your Nuxt project | -| `--logLevel=` | | Specify build-time log level | -| `--skipInstall` | | Skip npm install | -| `--skipConfig` | | Skip nuxt.config.ts update | -| `--dev` | | Install modules as dev dependencies | -| `--packageManager=` | | Package manager to install with | +| Option | Default | Description | +|-----------------------------------------------------------------|---------|-------------------------------------------------| +| `--cwd=` | `.` | Specify the root directory of your Nuxt project | +| `--logLevel=` | | Specify build-time log level | +| `--skipInstall` | | Skip npm install | +| `--skipConfig` | | Skip nuxt.config.ts update | +| `--dev` | | Install modules as dev dependencies | +| `--packageManager=` | | Package manager to install with | The command lets you install [Nuxt modules](/modules) in your application with no manual work. diff --git a/packages/nuxt-cli/test/unit/help.spec.ts b/packages/nuxt-cli/test/unit/help.spec.ts index fe1f1c651..5180522c8 100644 --- a/packages/nuxt-cli/test/unit/help.spec.ts +++ b/packages/nuxt-cli/test/unit/help.spec.ts @@ -76,12 +76,12 @@ describe('help', () => { OPTIONS - --cwd= Specify the root directory of your Nuxt project (Default: .) - --logLevel= Specify build-time log level - --skipInstall Skip npm install - --skipConfig Skip nuxt.config.ts update - --dev Install modules as dev dependencies - --packageManager= Package manager to install with + --cwd= Specify the root directory of your Nuxt project (Default: .) + --logLevel= Specify build-time log level + --skipInstall Skip npm install + --skipConfig Skip nuxt.config.ts update + --dev Install modules as dev dependencies + --packageManager= Package manager to install with " `) }) @@ -488,12 +488,12 @@ describe('help', () => { OPTIONS - --cwd= Specify the root directory of your Nuxt project (Default: .) - --logLevel= Specify build-time log level - --skipInstall Skip npm install - --skipConfig Skip nuxt.config.ts update - --dev Install modules as dev dependencies - --packageManager= Package manager to install with + --cwd= Specify the root directory of your Nuxt project (Default: .) + --logLevel= Specify build-time log level + --skipInstall Skip npm install + --skipConfig Skip nuxt.config.ts update + --dev Install modules as dev dependencies + --packageManager= Package manager to install with " `) }) diff --git a/packages/nuxt-cli/test/unit/utils/install.spec.ts b/packages/nuxt-cli/test/unit/utils/install.spec.ts index c6297efe1..cb432c882 100644 --- a/packages/nuxt-cli/test/unit/utils/install.spec.ts +++ b/packages/nuxt-cli/test/unit/utils/install.spec.ts @@ -134,7 +134,6 @@ describe.skipIf(process.platform === 'win32')('runInstall arguments', () => { const result = await runInstall({ cwd: dir, packageManager: { name: 'pnpm', agent: 'pnpm' }, dependencies: ['a'] }) expect(result.command).toBe('pnpm add --ignore-workspace-root-check a --config.confirm-modules-purge=false --config.strict-dep-builds=false') }) - }) describe('runDedupe', () => {