RELEASE: @W-15214308@: Merging dev to release for v3.22.0 (#1388)

Co-authored-by: Stephen Carter <[email protected]>
Co-authored-by: Stephen Carter <[email protected]>
Co-authored-by: Mike Donnalley <[email protected]>

Author: 3 people

.gitignore

@@ -157,3 +157,5 @@ oclif.lock
 pmd-cataloger/bin
 
 sfge*.log.gz
+
+npm-shrinkwrap.json

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
 
@@ -30,6 +30,14 @@ Specify a language
 
 Specify a path
 
+# output.successfullyAddedRules
+
+Successfully added rules for %s.
+
+# output.resultSummary
+
+%s Path(s) added: %s
+
 # examples
 
 Bundle custom PMD rules in JAR files. Follow PMD conventions, such as defining the custom rules in XML files under a `/category/` directory.

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

messages/describe.md

@@ -14,6 +14,14 @@ the name of the rule
 
 The name of the rule.
 
+# flags.previewPmd7Summary
+
+use PMD version %s to describe PMD and CPD rules
+
+# flags.previewPmd7Description
+
+Uses PMD version %s instead of %s to describe PMD and CPD rules.
+
 # output.noMatchingRules
 
 No rules were found with the name '%s'.

messages/jreSetupManager.md

@@ -18,4 +18,8 @@ If the problem persists, please manually add a 'javaHome' property to your Confi
 
 # InvalidVersion
 
-Java version %s isn't supported. Install Java 1.8 or later.
+Java version %s isn't supported. Install Java 1.8 or later.
+
+# warning.JavaV8Deprecated
+
+Code Analyzer requires Java v11 or later. Update to Java v11 and update the `javaHome` property in your `%s` file.

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
 
@@ -38,6 +38,14 @@ select rules by engine
 
 Selects rules by engine. Enter multiple engines as a comma-separated list.
 
+# flags.previewPmd7Summary
+
+use PMD version %s to list PMD and CPD rules
+
+# flags.previewPmd7Description
+
+Uses PMD version %s instead of %s to list PMD and CPD rules.
+
 # rulesetDeprecation
 
 The 'ruleset' command parameter is deprecated. Use 'category' instead

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
 

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,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
 

messages/run-pathless.md

@@ -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
 
@@ -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,23 +56,31 @@ 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
+
+use PMD version %s when running PMD and CPD
+
+# flags.previewPmd7Description
+
+Uses PMD version %s instead of %s when running PMD and CPD engines.
 
 # flags.verboseViolationsSummary
 
 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
 

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@salesforce/sfdx-scanner",
 	"description": "Static code scanner that applies quality and security rules to Apex code, and provides feedback.",
-	"version": "3.21.0",
+	"version": "3.22.0",
 	"author": "ISV SWAT",
 	"bugs": "https://github.com/forcedotcom/sfdx-scanner/issues",
 	"dependencies": {
@@ -14,6 +14,7 @@
 		"@salesforce/eslint-config-lwc": "^3.2.1",
 		"@salesforce/eslint-plugin-lightning": "^1.0.0",
 		"@salesforce/sf-plugins-core": "^5.0.4",
+		"@types/wordwrap": "^1.0.3",
 		"@typescript-eslint/eslint-plugin": "^5.62.0",
 		"@typescript-eslint/parser": "^5.62.0",
 		"cross-spawn": "^7.0.3",
@@ -40,7 +41,6 @@
 		"typescript": "~5.1.0",
 		"untildify": "^4.0.0",
 		"uuid": "^9.0.0",
-		"word-wrap": "^1.2.3",
 		"xml-js": "^1.6.11"
 	},
 	"resolutions": {
@@ -69,6 +69,7 @@
 		"@types/picomatch": "^2.3.0",
 		"@types/sarif": "^2.1.4",
 		"@types/semver": "^7.3.9",
+		"@types/sinon": "^17.0.3",
 		"@types/tmp": "^0.2.3",
 		"@types/uuid": "^8.3.4",
 		"chai": "^4",
@@ -78,7 +79,7 @@
 		"mocha-junit-reporter": "^2.0.0",
 		"nyc": "^15.0.0",
 		"oclif": "^4.0.3",
-		"sinon": "^13",
+		"sinon": "^17",
 		"tildify": "^2.0.0",
 		"ts-mockito": "^2.6.1"
 	},
@@ -128,16 +129,16 @@
 		"flexibleTaxonomy": true
 	},
 	"nyc": {
-		"branches": "60",
-		"lines": "75",
-		"functions": "75",
-		"statements": "75"
+		"branches": "75",
+		"lines": "85",
+		"functions": "85",
+		"statements": "85"
 	},
 	"repository": "forcedotcom/sfdx-scanner",
 	"scripts": {
 		"build": "./gradlew build -x test",
-		"prepack": "rm -rf lib && tsc -b && oclif manifest && oclif readme && oclif lock",
-		"postpack": "rm -f oclif.manifest.json",
+		"prepack": "rm -rf lib && tsc -b && oclif manifest && oclif readme && oclif lock && npm shrinkwrap",
+		"postpack": "rm -f oclif.manifest.json oclif.lock npm-shrinkwrap.json",
 		"lint-typescript": "eslint ./src --ext .ts --max-warnings 0",
 		"test": "./gradlew test jacocoTestCoverageVerification && nyc mocha --timeout 10000 --retries 5 \"./test/**/*.test.ts\"",
 		"test-quiet": "cross-env SFGE_LOGGING=false ./gradlew test jacocoTestCoverageVerification && nyc mocha --timeout 10000 --retries 5 \"./test/**/*.test.ts\"",