From 358a9092145f48456278105bdf35da91f5e8f49d Mon Sep 17 00:00:00 2001 From: Scott Lowe Date: Fri, 21 Aug 2020 12:43:12 +0200 Subject: [PATCH] Shorten `env add` command summary to prevent wrapping Change-type: patch Signed-off-by: Scott Lowe --- doc/cli.markdown | 18 +++++++++--------- lib/actions-oclif/env/add.ts | 20 ++++++++++---------- tests/commands/help.spec.ts | 2 +- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/cli.markdown b/doc/cli.markdown index a2baebbc..201953e8 100644 --- a/doc/cli.markdown +++ b/doc/cli.markdown @@ -970,15 +970,15 @@ do not prompt for confirmation before deleting the variable ## env add NAME [VALUE] -Add an environment or config variable to one or more applications, devices -or services, as selected by the respective command-line options. Either the ---application or the --device option must be provided, and either may be be -used alongside the --service option to define a service-specific variable. -(A service is an application container in a "microservices" application.) -When the --service option is used in conjunction with the --device option, -the service variable applies to the selected device only. Otherwise, it -applies to all devices of the selected application (i.e., the application's -fleet). If the --service option is omitted, the variable applies to all +Add an environment or config variable to one or more applications, devices +or services, as selected by the respective command-line options. Either the +--application or the --device option must be provided, and either may be be +used alongside the --service option to define a service-specific variable. +(A service is an application container in a "microservices" application.) +When the --service option is used in conjunction with the --device option, +the service variable applies to the selected device only. Otherwise, it +applies to all devices of the selected application (i.e., the application's +fleet). If the --service option is omitted, the variable applies to all services. If VALUE is omitted, the CLI will attempt to use the value of the environment diff --git a/lib/actions-oclif/env/add.ts b/lib/actions-oclif/env/add.ts index 76a73644..97a25e96 100644 --- a/lib/actions-oclif/env/add.ts +++ b/lib/actions-oclif/env/add.ts @@ -39,17 +39,17 @@ interface ArgsDef { export default class EnvAddCmd extends Command { public static description = stripIndent` - Add an environment or config variable to one or more applications, devices or services. + Add env or config variable to application(s), device(s) or service(s). - Add an environment or config variable to one or more applications, devices - or services, as selected by the respective command-line options. Either the - --application or the --device option must be provided, and either may be be - used alongside the --service option to define a service-specific variable. - (A service is an application container in a "microservices" application.) - When the --service option is used in conjunction with the --device option, - the service variable applies to the selected device only. Otherwise, it - applies to all devices of the selected application (i.e., the application's - fleet). If the --service option is omitted, the variable applies to all + Add an environment or config variable to one or more applications, devices + or services, as selected by the respective command-line options. Either the + --application or the --device option must be provided, and either may be be + used alongside the --service option to define a service-specific variable. + (A service is an application container in a "microservices" application.) + When the --service option is used in conjunction with the --device option, + the service variable applies to the selected device only. Otherwise, it + applies to all devices of the selected application (i.e., the application's + fleet). If the --service option is omitted, the variable applies to all services. If VALUE is omitted, the CLI will attempt to use the value of the environment diff --git a/tests/commands/help.spec.ts b/tests/commands/help.spec.ts index 910bfcbd..1c336b44 100644 --- a/tests/commands/help.spec.ts +++ b/tests/commands/help.spec.ts @@ -67,7 +67,7 @@ Additional commands: device rm remove one or more devices device shutdown shutdown a device devices supported list the supported device types (like 'raspberrypi3' or 'intel-nuc') - env add [value] add an environment or config variable to one or more applications, devices or services + env add [value] add env or config variable to application(s), device(s) or service(s) env rename change the value of a config or env var for an app, device or service env rm remove a config or env var from an application, device or service envs list the environment or config variables of an application, device or service