Skip to content

CHANGE (CodeAnalyzer):@W-15142453@: Update help text to match latest command reference changes #1374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 5, 2024
Merged

CHANGE (CodeAnalyzer):@W-15142453@: Update help text to match latest command reference changes #1374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8039a4a
@W-15142453@: Update help text to match latest command reference changes
stephen-carter-at-sf Mar 1, 2024
7b20154
Merge branch 'dev' into d/W-15142453
stephen-carter-at-sf Mar 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion messages/add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 4 additions & 0 deletions messages/common.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions messages/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion messages/run-common.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions messages/run-dfa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -29,15 +29,15 @@ 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

specify timeout for individual rule threads in milliseconds. Alternatively, set the timeout value using environment variable `SFGE_RULE_THREAD_TIMEOUT`. Default: 900000 ms

# 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

Expand Down
18 changes: 9 additions & 9 deletions messages/run-pathless.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,27 @@ 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

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

Expand All @@ -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

Expand All @@ -56,15 +56,15 @@ 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

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

Expand All @@ -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

Expand Down
3 changes: 2 additions & 1 deletion src/commands/scanner/rule/describe.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]),
Expand Down
3 changes: 2 additions & 1 deletion src/commands/scanner/rule/list.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<string[]>({
char: 'c',
Expand Down
3 changes: 2 additions & 1 deletion src/commands/scanner/rule/remove.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
3 changes: 2 additions & 1 deletion src/lib/ScannerRunCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<string[]>({
Expand Down