Merge pull request #750 from salesforcecli/sm/flag-message-naming-conventions

style: flag naming convention

Author: iowillhoit

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/create_scratch.md

@@ -34,11 +34,11 @@ You must specify a Dev Hub to create a scratch org, either with the --target-dev
 
   <%= config.bin %> <%= command.id %> --edition enterprise --alias my-scratch-org --target-dev-hub MyHub --release preview
 
-# flags.target-hub.summary
+# flags.target-dev-hub.summary
 
 Username or alias of the Dev Hub org.
 
-# flags.target-hub.description
+# flags.target-dev-hub.description
 
 Overrides the value of the target-dev-hub configuration variable, if set.
 
@@ -86,11 +86,11 @@ The scratch org definition file is a blueprint for the scratch org. It mimics th
 
 Consumer key of the Dev Hub connected app.
 
-# flags.adminEmail.summary
+# flags.admin-email.summary
 
 Email address that will be applied to the org's admin user. Overrides the value of the "adminEmail" option in the definition file, if set.
 
-# flags.sourceOrg.summary
+# flags.source-org.summary
 
 15-character ID of the org whose shape the new scratch org will be based on. Overrides the value of the "sourceOrg" option in the definition file, if set.
 

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.no-prompt.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/list.md

@@ -28,11 +28,11 @@ Include expired, deleted, and unknown-status scratch orgs.
 
 Remove all local org authorizations for non-active scratch orgs. Use "org logout" to remove non-scratch orgs.
 
-# flags.noPrompt.summary
+# flags.no-prompt.summary
 
 Don't prompt for confirmation.
 
-# flags.skipConnectionStatus.summary
+# flags.skip-connection-status.summary
 
 Skip retrieving the connection status of non-scratch orgs.
 

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.

package.json

@@ -36,7 +36,7 @@
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-jsdoc": "^43.0.5",
-    "eslint-plugin-sf-plugin": "^1.15.13",
+    "eslint-plugin-sf-plugin": "^1.16.0",
     "husky": "^7.0.4",
     "mocha": "^10.2.0",
     "moment": "^2.29.1",

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.no-prompt.summary'),
       deprecateAliases: true,
       aliases: ['noprompt'],
     }),