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

nrwl · Jul 20, 2023 · c2c06c1 · c2c06c1 · vercel · Jul 20, 2023
1 parent 0f1c9d9
commit c2c06c1
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 8 deletions.
diff --git a/docs/generated/cli/show.md b/docs/generated/cli/show.md
@@ -159,7 +159,7 @@ Show only projects that have a specific target
 
 ### project
 
-Show a list of targets in the workspace.
+Shows resolved project configuration for a given project.
 
 ```shell
 nx show project <projectName>
@@ -177,7 +177,7 @@ Show help
 
 Type: `string`
 
-Show targets for the given project
+Which project should be viewed?
 
 ##### version
 

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

diff --git a/packages/nx/src/command-line/show/command-object.ts b/packages/nx/src/command-line/show/command-object.ts
@@ -41,8 +41,12 @@ export const yargsShowCommand: CommandModule<
         'Show a list of all projects in the workspace'
       )
       .example(
-        '$0 show targets',
-        'Show a list of all targets in the workspace'
+        '$0 show projects --with-target serve',
+        '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) => {
     showHelp();
@@ -96,13 +100,13 @@ const showProjectsCommand: CommandModule<NxShowArgs, ShowProjectsOptions> = {
 
 const showProjectCommand: CommandModule<NxShowArgs, ShowProjectOptions> = {
   command: 'project <projectName>',
-  describe: 'Show a list of targets in the workspace.',
+  describe: 'Shows resolved project configuration for a given project.',
   builder: (yargs) =>
     yargs
       .positional('projectName', {
         type: 'string',
         alias: 'p',
-        description: 'Show targets for the given project',
+        description: 'Which project should be viewed?',
       })
       .default('json', true)
       .example(