diff --git a/docs/generated/cli/init.md b/docs/generated/cli/init.md index cccde6f4946e6..9019bfebb0476 100644 --- a/docs/generated/cli/init.md +++ b/docs/generated/cli/init.md @@ -17,14 +17,60 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx` ## Options +### addE2e + +Type: `boolean` + +Default: `false` + +Set up Cypress E2E tests in integrated workspaces. Only for CRA projects. + +### force + +Type: `boolean` + +Default: `false` + +Force the migration to continue and ignore custom webpack setup or uncommitted changes. Only for CRA projects. + ### help Type: `boolean` Show help +### integrated + +Type: `boolean` + +Default: `false` + +Migrate to an Nx integrated layout workspace. Only for Angular CLI workspaces and CRA projects. + +### interactive + +Type: `boolean` + +Default: `true` + +When false disables interactive input prompts for options. + +### nxCloud + +Type: `boolean` + +Set up distributed caching with Nx Cloud. + ### version Type: `boolean` Show version number + +### vite + +Type: `boolean` + +Default: `true` + +Use Vite as the bundler. Only for CRA projects. diff --git a/docs/generated/packages/nx/documents/init.md b/docs/generated/packages/nx/documents/init.md index cccde6f4946e6..9019bfebb0476 100644 --- a/docs/generated/packages/nx/documents/init.md +++ b/docs/generated/packages/nx/documents/init.md @@ -17,14 +17,60 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx` ## Options +### addE2e + +Type: `boolean` + +Default: `false` + +Set up Cypress E2E tests in integrated workspaces. Only for CRA projects. + +### force + +Type: `boolean` + +Default: `false` + +Force the migration to continue and ignore custom webpack setup or uncommitted changes. Only for CRA projects. + ### help Type: `boolean` Show help +### integrated + +Type: `boolean` + +Default: `false` + +Migrate to an Nx integrated layout workspace. Only for Angular CLI workspaces and CRA projects. + +### interactive + +Type: `boolean` + +Default: `true` + +When false disables interactive input prompts for options. + +### nxCloud + +Type: `boolean` + +Set up distributed caching with Nx Cloud. + ### version Type: `boolean` Show version number + +### vite + +Type: `boolean` + +Default: `true` + +Use Vite as the bundler. Only for CRA projects. diff --git a/packages/nx/src/command-line/nx-commands.ts b/packages/nx/src/command-line/nx-commands.ts index 508524b1ad551..61bfcd3cf4329 100644 --- a/packages/nx/src/command-line/nx-commands.ts +++ b/packages/nx/src/command-line/nx-commands.ts @@ -953,45 +953,38 @@ function withListOptions(yargs) { } function withInitOptions(yargs: yargs.Argv) { - // TODO(leo): make them visible in docs/help once the feature is released in Nx 16 return yargs .options('nxCloud', { type: 'boolean', description: 'Set up distributed caching with Nx Cloud.', - hidden: true, }) .option('interactive', { describe: 'When false disables interactive input prompts for options.', type: 'boolean', default: true, - hidden: true, }) .option('integrated', { type: 'boolean', description: 'Migrate to an Nx integrated layout workspace. Only for Angular CLI workspaces and CRA projects.', default: false, - hidden: true, }) .option('addE2e', { describe: 'Set up Cypress E2E tests in integrated workspaces. Only for CRA projects.', type: 'boolean', default: false, - hidden: true, }) .option('force', { describe: 'Force the migration to continue and ignore custom webpack setup or uncommitted changes. Only for CRA projects.', type: 'boolean', default: false, - hidden: true, }) .options('vite', { type: 'boolean', description: 'Use Vite as the bundler. Only for CRA projects.', default: true, - hidden: true, }) .options('cacheable', { type: 'string',