From c2c06c12c30e69f74e8e8fd9b9f8b80ab906558f Mon Sep 17 00:00:00 2001 From: Craigory Coppola Date: Thu, 20 Jul 2023 18:15:52 -0400 Subject: [PATCH] fix(core): remove old example and help text from show remnants (#18228) --- docs/generated/cli/show.md | 4 ++-- docs/generated/packages/nx/documents/show.md | 4 ++-- packages/nx/src/command-line/show/command-object.ts | 12 ++++++++---- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/generated/cli/show.md b/docs/generated/cli/show.md index 7e293151ed8f5..0c22a989345c8 100644 --- 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 @@ -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 index 7e293151ed8f5..0c22a989345c8 100644 --- 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 @@ -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 index 4a2a394c6f99b..48a8e53fb9252 100644 --- 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 = { const showProjectCommand: CommandModule = { command: 'project ', - 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(