fix(core): remove old example and help text from show remnants (#18228)

This commit is contained in:
Craigory Coppola 2023-07-20 18:15:52 -04:00 committed by GitHub
parent 0f1c9d9e98
commit c2c06c12c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 8 deletions

View File

@ -159,7 +159,7 @@ Show only projects that have a specific target
### project ### project
Show a list of targets in the workspace. Shows resolved project configuration for a given project.
```shell ```shell
nx show project <projectName> nx show project <projectName>
@ -177,7 +177,7 @@ Show help
Type: `string` Type: `string`
Show targets for the given project Which project should be viewed?
##### version ##### version

View File

@ -159,7 +159,7 @@ Show only projects that have a specific target
### project ### project
Show a list of targets in the workspace. Shows resolved project configuration for a given project.
```shell ```shell
nx show project <projectName> nx show project <projectName>
@ -177,7 +177,7 @@ Show help
Type: `string` Type: `string`
Show targets for the given project Which project should be viewed?
##### version ##### version

View File

@ -41,8 +41,12 @@ export const yargsShowCommand: CommandModule<
'Show a list of all projects in the workspace' 'Show a list of all projects in the workspace'
) )
.example( .example(
'$0 show targets', '$0 show projects --with-target serve',
'Show a list of all targets in the workspace' 'Show a list of all projects in the workspace that have a "serve" target'
)
.example(
'$0 show project [projectName]',
'Shows the resolved configuration for [projectName]'
), ),
handler: async (args) => { handler: async (args) => {
showHelp(); showHelp();
@ -96,13 +100,13 @@ const showProjectsCommand: CommandModule<NxShowArgs, ShowProjectsOptions> = {
const showProjectCommand: CommandModule<NxShowArgs, ShowProjectOptions> = { const showProjectCommand: CommandModule<NxShowArgs, ShowProjectOptions> = {
command: 'project <projectName>', command: 'project <projectName>',
describe: 'Show a list of targets in the workspace.', describe: 'Shows resolved project configuration for a given project.',
builder: (yargs) => builder: (yargs) =>
yargs yargs
.positional('projectName', { .positional('projectName', {
type: 'string', type: 'string',
alias: 'p', alias: 'p',
description: 'Show targets for the given project', description: 'Which project should be viewed?',
}) })
.default('json', true) .default('json', true)
.example( .example(