Skip to content

Commit

Permalink
Merge pull request #468 from salesforcecli/jshackell-edit-messages
Browse files Browse the repository at this point in the history
fix: edit new flag-value messages
  • Loading branch information
jshackell-sfdc authored Jan 24, 2024
2 parents 605168c + fa8fc94 commit 73cb1b3
Show file tree
Hide file tree
Showing 3 changed files with 818 additions and 813 deletions.
34 changes: 17 additions & 17 deletions messages/dev.generate.flag.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,60 +158,60 @@ Do you want to use the standard definition (character, summary, description, def

# flagDescriptions.duration

a unit and quantity of time (example: X minutes, 4 days). You can specify min/max/default.
A unit and quantity of time, such as "10 minutes" or "4 days". You can optionally specify the minimum, maximum, or default values to take advantage of the built-in CLI validation rules.

# flagDescriptions.option

a choice from a defined list of string options. You can set the allowed values.
Value is a choice out of a pre-defined list of string values. You will then be asked for the list of allowed values.

# flagDescriptions.integer
# flagDescriptions.integer

an integer with built-in validation of optional min/max/default values.
An integer. You can optionally specify the minimum, maximum, or default values to take advantage of the built-in CLI validation rules.

# flagDescriptions.custom

a flag with a custom typescript type. You'll need to add some code after the scaffolding is complete.
Flag with a custom typescript type. You must add some code after the scaffolding is complete.

# flagDescriptions.salesforceId
# flagDescriptions.salesforceId

a valid salesforce record ID. You can specify the 3-character prefix and/or the length of the ID.
A valid Salesforce record ID. You can specify the 3-character prefix and the length of the ID.

# flagDescriptions.file

a local file path. You can specify whether the file must exist.
A local file. You can specify whether the file must already exist.

# flagDescriptions.directory

a local directory path. You can specify whether the file must exist.
A local directory path. You can specify whether the directory must already exist.

# flagDescriptions.orgApiVersion

a valid salesforce API version number. The code checks for minimal non-retired values.
A valid Salesforce API version number. The code checks for minimal non-retired values. You can optionally mimic the standard CLI API version flag ("--api-version").

# flagDescriptions.requiredOrg

a Salesforce org, entered by username/alias and aware of default org.
A required Salesforce org, which a user specifies with either a Salesforce username or an alias. You can optionally mimic the standard CLI target org flag ("--target-org"). Flag respects the user's default org if it's set.

# flagDescriptions.optionalOrg

a Salesforce org, entered by username/alias and aware of default org.
An optional Salesforce org, which a user specifies with either a Salesforce username or an alias. You can optionally mimic the standard CLI target org flag ("--target-org"). Flag respects the user's default org if it's set.

# flagDescriptions.requiredHub

a Salesforce org, entered by username/alias and aware of default dev hub. Must be a dev hub.
A required Salesforce Dev Hub org, which a user specifies with either a Salesforce username or an alias. You can optionally mimic the standard CLI target Dev Hub flag ("--target-dev-hub"). Flag respects the user's default Dev Hub org if it's set.

# flagDescriptions.optionalHub

a Salesforce org, entered by username/alias and aware of default dev hub. Must be a dev hub.
An optional Salesforce Dev Hub org, which a user specifies with either a Salesforce username or an alias. You can optionally mimic the standard CLI target Dev Hub flag ("--target-dev-hub"). Flag respects the user's default Dev Hub org if it's set.

# flagDescriptions.url

Validates that input matches URL spec. Returns the NodeJS Url class for simplified parsing.
A valid URL. The code checks that the input matches the official W3C URL specification. Returns the NodeJS Url class for simplified parsing.

# flagDescriptions.string

Any valid string
Any valid string.

# flagDescriptions.boolean

Take no value, has value of `true` if provided and `false` otherwise
Value is either `true` (if the user specifies it when executing the command) or `false` (user doesn't specify it.)
12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
"@inquirer/select": "^1.3.1",
"@oclif/core": "^3.18.1",
"@octokit/rest": "^19.0.13",
"@salesforce/core": "^6.4.4",
"@salesforce/core": "^6.5.0",
"@salesforce/kit": "^3.0.15",
"@salesforce/sf-plugins-core": "^7.0.0",
"@salesforce/sf-plugins-core": "^7.1.4",
"@salesforce/ts-types": "^2.0.9",
"change-case": "^5.4.1",
"fast-glob": "^3.3.2",
Expand All @@ -26,16 +26,16 @@
"yeoman-generator": "^5.10.0"
},
"devDependencies": {
"@oclif/plugin-command-snapshot": "^5.0.5",
"@salesforce/cli-plugins-testkit": "^5.1.5",
"@oclif/plugin-command-snapshot": "^5.0.6",
"@salesforce/cli-plugins-testkit": "^5.1.7",
"@salesforce/dev-scripts": "^8.3.0",
"@salesforce/plugin-command-reference": "^3.0.59",
"@salesforce/plugin-command-reference": "^3.0.63",
"@types/js-yaml": "^4.0.5",
"@types/lodash.defaultsdeep": "^4.6.9",
"@types/shelljs": "^0.8.14",
"@types/yeoman-generator": "^5.2.14",
"eslint-plugin-sf-plugin": "^1.17.0",
"oclif": "^4.3.2",
"oclif": "^4.3.9",
"shx": "^0.3.3",
"ts-node": "^10.9.2",
"typescript": "^5.3.3"
Expand Down
Loading

0 comments on commit 73cb1b3

Please sign in to comment.