style: flag naming convention

Author: mshanemc

messages/clone.md

@@ -14,27 +14,27 @@ Set the --targetusername (-u) parameter to a production org with sandbox license
 
 - $ <%= config.bin %> <%= command.id %> -t sandbox SandboxName=NewClonedSandbox SourceSandboxName=ExistingSandbox -u prodOrg -a MyDevSandbox
 
-# flags.type
+# flags.type.summary
 
 Type of org to create.
 
-# flags.wait
+# flags.wait.summary
 
 Number of minutes to wait while polling for status.
 
-# flags.setdefaultusername
+# flags.setdefaultusername.summary
 
 Set the cloned org as your default.
 
-# flags.setalias
+# flags.setalias.summary
 
 Alias for the cloned org.
 
-# flags.definitionfile
+# flags.definitionfile.summary
 
 Path to the sandbox definition file.
 
-# flagsLong.wait
+# flags.wait.description
 
 Sets the streaming client socket timeout, in minutes. If the streaming client socket has no contact from the server for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
 

messages/create.md

@@ -20,43 +20,43 @@ Creates a scratch org or a sandbox org using the values specified in a configura
 
 - $ <%= config.bin %> <%= command.id %> -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg
 
-# flags.clientId
+# flags.clientid.summary
 
 Connected app consumer key; not supported for sandbox org creation.
 
-# flags.setDefaultUsername
+# flags.setdefaultusername.summary
 
 Set the created org as the default username.
 
-# flags.setAlias
+# flags.setalias.summary
 
 Alias for the created org.
 
-# flags.definitionFile
+# flags.definitionfile.summary
 
 Path to an org definition file.
 
-# flags.noNamespace
+# flags.nonamespace.summary
 
 Create the scratch org with no namespace.
 
-# flags.noAncestors
+# flags.noancestors.summary
 
 Do not include second-generation package ancestors in the scratch org.
 
-# flags.type
+# flags.type.summary
 
 Type of org to create.
 
-# flags.durationDays
+# flags.durationdays.summary
 
 Duration of the scratch org (in days) (default:7, min:1, max:30).
 
-# flags.retry
+# flags.retry.summary
 
 Number of scratch org auth retries after scratch org is successfully signed up.
 
-# flags.wait
+# flags.wait.summary
 
 Streaming client socket timeout (in minutes).
 

messages/delete.md

@@ -18,7 +18,7 @@ To mark the org for deletion without being prompted to confirm, specify --noprom
 
 - $ <%= config.bin %> <%= command.id %> -u MyOrgAlias -p
 
-# flags.noprompt
+# flags.noprompt.summary
 
 No prompt to confirm deletion.
 
@@ -30,7 +30,7 @@ Unable to determine the username of the org to delete. Specify the username with
 
 Username or alias of the target org.
 
-# flags.targetdevhubusername
+# flags.targetdevhubusername.summary
 
 The targetdevhubusername flag exists only for backwards compatibility. It is not necessary and has no effect.
 

messages/status.md

@@ -16,18 +16,18 @@ Use the --wait (-w) parameter to specify the number of minutes that the command
 
 Set the --target-org (-o) parameter to the username or alias of the production org that contains the sandbox license.
 
-# flags.sandboxname
+# flags.sandboxname.summary
 
 Name of the sandbox org to check status for.
 
-# flags.wait
+# flags.wait.summary
 
 Number of minutes to wait while polling for status.
 
-# flags.setdefaultusername
+# flags.setdefaultusername.summary
 
 Set the created or cloned org as your default.
 
-# flags.setalias
+# flags.setalias.summary
 
 Alias for the created or cloned org.

src/commands/force/org/clone.ts

@@ -51,27 +51,27 @@ export class OrgCloneCommand extends SfCommand<SandboxProcessObject> {
       options: ['sandbox'],
     })({
       char: 't',
-      summary: messages.getMessage('flags.type'),
+      summary: messages.getMessage('flags.type.summary'),
       required: true,
     }),
     definitionfile: Flags.file({
       char: 'f',
       exists: true,
-      summary: messages.getMessage('flags.definitionfile'),
+      summary: messages.getMessage('flags.definitionfile.summary'),
     }),
     setdefaultusername: Flags.boolean({
       char: 's',
-      summary: messages.getMessage('flags.setdefaultusername'),
+      summary: messages.getMessage('flags.setdefaultusername.summary'),
     }),
     setalias: Flags.string({
       char: 'a',
-      summary: messages.getMessage('flags.setalias'),
+      summary: messages.getMessage('flags.setalias.summary'),
     }),
     wait: Flags.duration({
       unit: 'minutes',
       char: 'w',
-      summary: messages.getMessage('flags.wait'),
-      description: messages.getMessage('flagsLong.wait'),
+      summary: messages.getMessage('flags.wait.summary'),
+      description: messages.getMessage('flags.wait.description'),
       min: 2,
       defaultValue: 6,
     }),

src/commands/force/org/create.ts

@@ -74,44 +74,44 @@ export class Create extends SfCommand<CreateResult> {
       options: [OrgTypes.Scratch, OrgTypes.Sandbox],
     })({
       char: 't',
-      summary: messages.getMessage('flags.type'),
+      summary: messages.getMessage('flags.type.summary'),
       default: OrgTypes.Scratch,
     }),
     definitionfile: Flags.file({
       exists: true,
       char: 'f',
-      summary: messages.getMessage('flags.definitionFile'),
+      summary: messages.getMessage('flags.definitionfile.summary'),
     }),
     nonamespace: Flags.boolean({
       char: 'n',
-      summary: messages.getMessage('flags.noNamespace'),
+      summary: messages.getMessage('flags.nonamespace.summary'),
     }),
     noancestors: Flags.boolean({
       char: 'c',
-      summary: messages.getMessage('flags.noAncestors'),
+      summary: messages.getMessage('flags.noancestors.summary'),
     }),
     clientid: Flags.string({
       char: 'i',
-      summary: messages.getMessage('flags.clientId'),
+      summary: messages.getMessage('flags.clientid.summary'),
     }),
     setdefaultusername: Flags.boolean({
       char: 's',
-      summary: messages.getMessage('flags.setDefaultUsername'),
+      summary: messages.getMessage('flags.setdefaultusername.summary'),
     }),
     setalias: Flags.string({
       char: 'a',
-      summary: messages.getMessage('flags.setAlias'),
+      summary: messages.getMessage('flags.setalias.summary'),
     }),
     wait: Flags.duration({
       unit: 'minutes',
       char: 'w',
-      summary: messages.getMessage('flags.wait'),
+      summary: messages.getMessage('flags.wait.summary'),
       min: 6,
       defaultValue: 6,
     }),
     durationdays: Flags.integer({
       char: 'd',
-      summary: messages.getMessage('flags.durationDays'),
+      summary: messages.getMessage('flags.durationdays.summary'),
       min: 1,
       max: 30,
       default: 7,
@@ -120,7 +120,7 @@ export class Create extends SfCommand<CreateResult> {
       hidden: true,
       default: 0,
       max: 10,
-      summary: messages.getMessage('flags.retry'),
+      summary: messages.getMessage('flags.retry.summary'),
     }),
   };
   private sandboxAuth?: SandboxUserAuthResponse;

src/commands/force/org/delete.ts

@@ -30,18 +30,18 @@ export class Delete extends SfCommand<DeleteResult> {
       summary: messages.getMessage('flags.target-org.summary'),
     }),
     targetdevhubusername: Flags.string({
-      summary: messages.getMessage('flags.targetdevhubusername'),
+      summary: messages.getMessage('flags.targetdevhubusername.summary'),
       char: 'v',
       hidden: true,
       deprecated: {
         version: '58.0',
-        message: messages.getMessage('flags.targetdevhubusername'),
+        message: messages.getMessage('flags.targetdevhubusername.summary'),
       },
     }),
     'api-version': orgApiVersionFlagWithDeprecations,
     'no-prompt': Flags.boolean({
       char: 'p',
-      summary: messages.getMessage('flags.noprompt'),
+      summary: messages.getMessage('flags.noprompt.summary'),
       deprecateAliases: true,
       aliases: ['noprompt'],
     }),

src/commands/force/org/status.ts

@@ -44,21 +44,21 @@ export class OrgStatusCommand extends SfCommand<SandboxProcessObject> {
     'api-version': orgApiVersionFlagWithDeprecations,
     sandboxname: Flags.string({
       char: 'n',
-      summary: messages.getMessage('flags.sandboxname'),
+      summary: messages.getMessage('flags.sandboxname.summary'),
       required: true,
     }),
     setdefaultusername: Flags.boolean({
       char: 's',
-      summary: messages.getMessage('flags.setdefaultusername'),
+      summary: messages.getMessage('flags.setdefaultusername.summary'),
     }),
     setalias: Flags.string({
       char: 'a',
-      summary: messages.getMessage('flags.setalias'),
+      summary: messages.getMessage('flags.setalias.summary'),
     }),
     wait: Flags.duration({
       unit: 'minutes',
       char: 'w',
-      summary: messages.getMessage('flags.wait'),
+      summary: messages.getMessage('flags.wait.summary'),
       min: 2,
       defaultValue: 6,
     }),

yarn.lock

@@ -911,7 +911,7 @@
     strip-ansi "6.0.1"
     ts-retry-promise "^0.7.0"
 
-"@salesforce/core@^4.0.1", "@salesforce/core@^4.1.0", "@salesforce/core@^4.3.1", "@salesforce/core@^4.3.2", "@salesforce/core@^4.3.5", "@salesforce/core@^4.3.7", "@salesforce/core@^4.3.8":
+"@salesforce/core@^4.0.1", "@salesforce/core@^4.3.1", "@salesforce/core@^4.3.2", "@salesforce/core@^4.3.5", "@salesforce/core@^4.3.7", "@salesforce/core@^4.3.8":
   version "4.3.10"
   resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-4.3.10.tgz#d3ada1411c41fbd182fbfbe6a7ab4cf5bc6afb9f"
   integrity sha512-xWwn9cSMXVSGobcROajVWNcEZ4QY3KbaSyZe7swXJtulJ26CB1Fv3QJB8RxStrj0XaXwt8m1nuiBwh03DTvCKg==
@@ -1476,7 +1476,7 @@
     semver "^7.3.7"
     tsutils "^3.21.0"
 
-"@typescript-eslint/[email protected]", "@typescript-eslint/utils@^5.59.8":
+"@typescript-eslint/[email protected]", "@typescript-eslint/utils@^5.59.11":
   version "5.62.0"
   resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-5.62.0.tgz#141e809c71636e4a75daa39faed2fb5f4b10df86"
   integrity sha512-n8oxjeb5aIbPFEtmQxQYOLI0i9n5ySBEY/ZEHHZqKQSFnxio1rv6dthascc9dLuwrL0RC5mPCxB7vnAVGAYWAQ==
@@ -3075,13 +3075,11 @@ eslint-plugin-prefer-arrow@^1.2.1:
   resolved "https://registry.yarnpkg.com/eslint-plugin-prefer-arrow/-/eslint-plugin-prefer-arrow-1.2.3.tgz#e7fbb3fa4cd84ff1015b9c51ad86550e55041041"
   integrity sha512-J9I5PKCOJretVuiZRGvPQxCbllxGAV/viI20JO3LYblAodofBxyMnZAJ+WGeClHgANnSJberTNoFWWjrWKBuXQ==
 
-eslint-plugin-sf-plugin@^1.15.6:
-  version "1.15.8"
-  resolved "https://registry.yarnpkg.com/eslint-plugin-sf-plugin/-/eslint-plugin-sf-plugin-1.15.8.tgz#6926244f8f8ea7015b8109283abf44736e59aa76"
-  integrity sha512-78toJayNZinG0NFKPBVeRzGoYwUViQcrvCMQq/h/7D3f0XKZ6NRHEt1V+Dt3j0GOZ+A/UqWbrLuvMPl4sPMo2Q==
+"eslint-plugin-sf-plugin@file:/Users/shane.mclaughlin/eng/eslint-plugin-sf-plugin":
+  version "1.15.13"
   dependencies:
-    "@salesforce/core" "^4.1.0"
-    "@typescript-eslint/utils" "^5.59.8"
+    "@salesforce/core" "^4.3.7"
+    "@typescript-eslint/utils" "^5.59.11"
 
 eslint-scope@^5.1.1:
   version "5.1.1"