diff --git a/messages/add.md b/messages/add.md index a11b10e1c..56c783904 100644 --- a/messages/add.md +++ b/messages/add.md @@ -20,7 +20,7 @@ one or more paths (such as a directory or JAR file) to custom rule definitions # flags.pathDescription -One or more paths (such as a directory or JAR file) to custom rule definitions. Specify multiple values as a comma-separated list. +One or more paths (such as a directory or JAR file) to custom rule definitions. Specify multiple values as a comma-separated list. # validations.languageCannotBeEmpty diff --git a/messages/common.md b/messages/common.md index 1e028d00a..b2fde775e 100644 --- a/messages/common.md +++ b/messages/common.md @@ -2,6 +2,10 @@ emit additional command output to stdout +# flags.verboseDescription + +Emit additional command output to stdout. + # surveyRequestMessage We're continually improving Salesforce Code Analyzer. Tell us what you think! Give feedback at https://research.net/r/SalesforceCA \ No newline at end of file diff --git a/messages/list.md b/messages/list.md index 723146886..6efab1a29 100644 --- a/messages/list.md +++ b/messages/list.md @@ -24,11 +24,11 @@ Selects rules by category. Enter multiple values as a comma-separated list. # flags.rulesetSummary -[deprecated] select rules by ruleset +[Deprecated] select rules by ruleset # flags.rulesetDescription -[deprecated] Selects rules by ruleset. Enter multiple values as a comma-separated list. +Deprecated. Use category instead. Selects rules by ruleset. Enter multiple values as a comma-separated list. # flags.engineSummary diff --git a/messages/run-common.md b/messages/run-common.md index 74ba6bc44..a915f5e89 100644 --- a/messages/run-common.md +++ b/messages/run-common.md @@ -12,7 +12,7 @@ specify results output format # flags.formatDescription -Specifies results output format written directly to the console. +Specifies the output format for results written directly to the console. # flags.normalizesevSummary diff --git a/messages/run-dfa.md b/messages/run-dfa.md index 1912e57c6..dcc581b1d 100644 --- a/messages/run-dfa.md +++ b/messages/run-dfa.md @@ -13,7 +13,7 @@ specify a path expansion upper boundary to limit the complexity of code that Gr # flags.pathexplimitDescription -Specifies a path expansion upper boundary to limit the complexity of code Graph Engine analyzes before failing fast. Set the value to -1 to remove any upper boundary. --pathexplimit inherits value from SFGE_PATH_EXPANSION_LIMIT env-var, if set. Its default value is derived from JVM heap space allocation. +Specifies a path expansion upper boundary to limit the complexity of code Graph Engine analyzes before failing fast. Set the value to -1 to remove any upper boundary. --pathexplimit inherits value from SFGE_PATH_EXPANSION_LIMIT env-var, if set. Its default value is derived from JVM heap space allocation. # flags.ruledisablewarningviolationSummary @@ -29,7 +29,7 @@ specify number of threads that evaluate DFA rules. Alternatively, set value usin # flags.rulethreadcountDescription -Specifies number of rule evaluation threads, or how many entrypoints can be evaluated concurrently. Inherits value from SFGE_RULE_THREAD_COUNT env-var, if set. Default is 4. +Specifies the number of rule-evaluation threads or how many entry points can be evaluated concurrently. Inherits its value from the SFGE_RULE_THREAD_COUNT environment variable, if set. The default is 4. # flags.rulethreadtimeoutSummary @@ -37,7 +37,7 @@ specify timeout for individual rule threads in milliseconds. Alternatively, set # flags.rulethreadtimeoutDescription -Specifies time limit for evaluating a single entrypoint in milliseconds. Inherits value from SFGE_RULE_THREAD_TIMEOUT env-var if set. Default is 900,000 ms, or 15 minutes. +Specifies the time limit for evaluating a single entry point in milliseconds. Inherits its value from the SFGE_RULE_THREAD_TIMEOUT environment variable, if set. The default is 900,000 ms or 15 minutes. # flags.sfgejvmargsSummary diff --git a/messages/run-pathless.md b/messages/run-pathless.md index 7d001585c..ce2da5bfc 100644 --- a/messages/run-pathless.md +++ b/messages/run-pathless.md @@ -8,11 +8,11 @@ Scans a codebase with a selection of rules. You can scan the codebase with all t # flags.rulesetSummary -[deprecated] rulesets to run +[Deprecated] rulesets to run # flags.rulesetDescription -[deprecated] One or more rulesets to run. Specify multiple values as a comma-separated list. +Deprecated. Use category instead. One or more rulesets to run. Specify multiple values as a comma-separated list. # flags.targetSummary @@ -20,15 +20,15 @@ source code location # flags.targetDescription -Specifies the source code location. May use glob patterns. Specify multiple values as a comma-separated list. Default is ".". +Specifies the source code location. Can use glob patterns. Specify multiple values as a comma-separated list. Default is ".". # flags.envSummary -[deprecated] override ESLint's default environment variables, in JSON-formatted string +[Deprecated] override ESLint's default environment variables, in JSON-formatted string # flags.envDescription -[deprecated] Overrides ESLint's default environmental variables, in JSON-formatted string. +Deprecated. Overrides ESLint's default environmental variables, in JSON-formatted string. # flags.envParamDeprecationWarning @@ -40,7 +40,7 @@ location of tsconfig.json file # flags.tsconfigDescription -Location of tsconfig.json file used by eslint-typescript engine. +The location of the tsconfig.json file used by the eslint-typescript engine. The --tsconfig flag can’t be used with --eslintconfig flag. # flags.engineSummary @@ -56,7 +56,7 @@ specify the location of eslintrc config to customize eslint engine # flags.eslintConfigDescription -Specifies the location of eslintrc config to customize eslint engine. +Specifies the location of eslintrc config to customize ESLint engine. The --tsconfig flag can’t be used with --eslintconfig flag. # flags.pmdConfigSummary @@ -64,7 +64,7 @@ specify location of PMD rule reference XML file to customize rule selection # flags.pmdConfigDescription -Specifies the location of PMD rule reference XML file to customize rule selection. +Specifies the location of the PMD rule reference XML file to customize rule selection. # flags.previewPmd7Summary @@ -80,7 +80,7 @@ return retire-js violation message details # flags.verboseViolationsDescription -Returns retire-js violation messages details about each vulnerability, including summary, Common Vulnerabilities and Exposures (CVE), and URLs. +Returns retire-js violation-message details about each vulnerability, including summary, common vulnerabilities and exposures (CVE), and URLs. # validations.methodLevelTargetingDisallowed diff --git a/src/commands/scanner/rule/describe.ts b/src/commands/scanner/rule/describe.ts index e04553576..199753242 100644 --- a/src/commands/scanner/rule/describe.ts +++ b/src/commands/scanner/rule/describe.ts @@ -28,7 +28,8 @@ export default class Describe extends ScannerCommand { required: true }), verbose: Flags.boolean({ - summary: getMessage(BundleName.Common, 'flags.verboseSummary') + summary: getMessage(BundleName.Common, 'flags.verboseSummary'), + description: getMessage(BundleName.Common, 'flags.verboseDescription') }), "preview-pmd7": Flags.boolean({ summary: getMessage(BundleName.Describe, 'flags.previewPmd7Summary', [PMD7_VERSION]), diff --git a/src/commands/scanner/rule/list.ts b/src/commands/scanner/rule/list.ts index c94908458..1537f6eff 100644 --- a/src/commands/scanner/rule/list.ts +++ b/src/commands/scanner/rule/list.ts @@ -23,7 +23,8 @@ export default class List extends ScannerCommand { // and summary and description is what's printed when the -h/--help flag is supplied. public static readonly flags = { verbose: Flags.boolean({ - summary: getMessage(BundleName.Common, 'flags.verboseSummary') + summary: getMessage(BundleName.Common, 'flags.verboseSummary'), + description: getMessage(BundleName.Common, 'flags.verboseDescription') }), category: Flags.custom({ char: 'c', diff --git a/src/commands/scanner/rule/remove.ts b/src/commands/scanner/rule/remove.ts index 2e2f3b59b..429181aec 100644 --- a/src/commands/scanner/rule/remove.ts +++ b/src/commands/scanner/rule/remove.ts @@ -22,7 +22,8 @@ export default class Remove extends ScannerCommand { // and summary and description is what's printed when the -h/--help flag is supplied. public static readonly flags = { verbose: Flags.boolean({ - summary: getMessage(BundleName.Common, 'flags.verboseSummary') + summary: getMessage(BundleName.Common, 'flags.verboseSummary'), + description: getMessage(BundleName.Common, 'flags.verboseDescription') }), force: Flags.boolean({ char: 'f', diff --git a/src/lib/ScannerRunCommand.ts b/src/lib/ScannerRunCommand.ts index ae304a181..e2d1deeb8 100644 --- a/src/lib/ScannerRunCommand.ts +++ b/src/lib/ScannerRunCommand.ts @@ -10,7 +10,8 @@ export abstract class ScannerRunCommand extends ScannerCommand { */ public static readonly flags = { verbose: Flags.boolean({ - summary: getMessage(BundleName.Common, 'flags.verboseSummary') + summary: getMessage(BundleName.Common, 'flags.verboseSummary'), + description: getMessage(BundleName.Common, 'flags.verboseDescription') }), // BEGIN: Filter-related flags. category: Flags.custom({