From 83b9892aecca1fd97a95dfcbc69738f22e5fade0 Mon Sep 17 00:00:00 2001 From: Camden Phalen Date: Thu, 22 Aug 2024 14:52:14 -0400 Subject: [PATCH] Update hs project add help command --- packages/cli/commands/project/add.js | 6 ++++++ packages/cli/lang/en.lyaml | 5 +++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/packages/cli/commands/project/add.js b/packages/cli/commands/project/add.js index 92554c140..0b4f7ff72 100644 --- a/packages/cli/commands/project/add.js +++ b/packages/cli/commands/project/add.js @@ -75,6 +75,12 @@ exports.builder = yargs => { }); yargs.example([['$0 project add', i18n(`${i18nKey}.examples.default`)]]); + yargs.example([ + [ + '$0 project add --name="my-component" --type="components/example-app"', + i18n(`${i18nKey}.examples.withFlags`), + ], + ]); return yargs; }; diff --git a/packages/cli/lang/en.lyaml b/packages/cli/lang/en.lyaml index 5614fc1f9..a005ffd0b 100644 --- a/packages/cli/lang/en.lyaml +++ b/packages/cli/lang/en.lyaml @@ -554,9 +554,9 @@ en: describe: "Create a new component within a project" options: name: - describe: "Component name" + describe: "The name for your newly created component" type: - describe: "The type of component" + describe: "The path to the component type's location within the hubspot-project-components Github repo: https://github.com/HubSpot/hubspot-project-components" creatingComponent: message: "Adding a new component to your project" success: @@ -565,6 +565,7 @@ en: locationInProject: "The component location must be within a project folder" examples: default: "Create a component within your project" + withFlags: "Use --name and --type flags to bypass the prompt." deploy: describe: "Deploy a project build" debug: