FIX: @W-16371174@: Fix bug with config commands case insensitivity

Author: stephen-carter-at-sf

package.json

@@ -6,7 +6,7 @@
 	"bugs": "https://github.com/forcedotcom/sfdx-scanner/issues",
 	"dependencies": {
 		"@oclif/core": "^3.3.2",
-		"@salesforce/code-analyzer-core": "0.20.1",
+		"@salesforce/code-analyzer-core": "0.20.2",
 		"@salesforce/code-analyzer-engine-api": "0.16.1",
 		"@salesforce/code-analyzer-eslint-engine": "0.17.0",
 		"@salesforce/code-analyzer-flowtest-engine": "0.16.2",

src/lib/actions/ConfigAction.ts

@@ -108,7 +108,7 @@ export class ConfigAction {
 		// We need the Set of all Engines that returned rules for the user's selection on both the Default and User Cores.
 		const relevantEngines: Set<string> = new Set([...userRules.getEngineNames(), ...selectedDefaultRules.getEngineNames()]);
 
-		const configModel: ConfigModel = new AnnotatedConfigModel(userConfig, userCore, userRules, allDefaultRules, relevantEngines);
+		const configModel: ConfigModel = new AnnotatedConfigModel(userCore, userRules, allDefaultRules, relevantEngines);
 
 		const fileWritten: boolean = this.dependencies.writer
 			? await this.dependencies.writer.write(configModel)

src/lib/models/ConfigModel.ts

@@ -23,7 +23,6 @@ export interface ConfigModel {
 }
 
 export class AnnotatedConfigModel implements ConfigModel {
-	private readonly config: CodeAnalyzerConfig; // TODO: It would be nice if we updated the CodeAnalyzer (in our core module) to just return its CodeAnalyzerConfig with a getter so we didn't need to pass it around
 	private readonly codeAnalyzer: CodeAnalyzer;
 	private readonly userRules: RuleSelection;
 	private readonly allDefaultRules: RuleSelection;
@@ -34,8 +33,7 @@ export class AnnotatedConfigModel implements ConfigModel {
 	// configs not associated with the user's rule selection, thus we can't use the engines from allDefaultRules.
 	private readonly  relevantEngines: Set<string>;
 
-	constructor(config: CodeAnalyzerConfig, codeAnalyzer: CodeAnalyzer, userRules: RuleSelection, allDefaultRules: RuleSelection, relevantEngines: Set<string>) {
-		this.config = config;
+	constructor(codeAnalyzer: CodeAnalyzer, userRules: RuleSelection, allDefaultRules: RuleSelection, relevantEngines: Set<string>) {
 		this.codeAnalyzer = codeAnalyzer;
 		this.userRules = userRules;
 		this.allDefaultRules = allDefaultRules;
@@ -45,9 +43,9 @@ export class AnnotatedConfigModel implements ConfigModel {
 	toFormattedOutput(format: OutputFormat): string {
 		// istanbul ignore else: Should be impossible
 		if (format === OutputFormat.STYLED_YAML) {
-			return new StyledYamlFormatter(this.config, this.codeAnalyzer, this.userRules, this.allDefaultRules, this.relevantEngines).toYaml();
+			return new StyledYamlFormatter(this.codeAnalyzer, this.userRules, this.allDefaultRules, this.relevantEngines).toYaml();
 		} else if (format === OutputFormat.RAW_YAML) {
-			return new PlainYamlFormatter(this.config, this.codeAnalyzer, this.userRules, this.allDefaultRules, this.relevantEngines).toYaml();
+			return new PlainYamlFormatter(this.codeAnalyzer, this.userRules, this.allDefaultRules, this.relevantEngines).toYaml();
 		} else {
 			throw new Error(`Unsupported`)
 		}
@@ -61,8 +59,8 @@ abstract class YamlFormatter {
 	private readonly allDefaultRules: RuleSelection;
 	private readonly relevantEngines: Set<string>;
 
-	protected constructor(config: CodeAnalyzerConfig, codeAnalyzer: CodeAnalyzer, userRules: RuleSelection, allDefaultRules: RuleSelection, relevantEngines: Set<string>) {
-		this.config = config;
+	protected constructor(codeAnalyzer: CodeAnalyzer, userRules: RuleSelection, allDefaultRules: RuleSelection, relevantEngines: Set<string>) {
+		this.config = codeAnalyzer.getConfig();
 		this.codeAnalyzer = codeAnalyzer;
 		this.userRules = userRules;
 		this.allDefaultRules = allDefaultRules;
@@ -214,8 +212,8 @@ abstract class YamlFormatter {
 }
 
 class PlainYamlFormatter extends YamlFormatter {
-	constructor(config: CodeAnalyzerConfig, codeAnalyzer: CodeAnalyzer, userRules: RuleSelection, allDefaultRules: RuleSelection, relevantEngines: Set<string>) {
-		super(config, codeAnalyzer, userRules, allDefaultRules, relevantEngines);
+	constructor(codeAnalyzer: CodeAnalyzer, userRules: RuleSelection, allDefaultRules: RuleSelection, relevantEngines: Set<string>) {
+		super(codeAnalyzer, userRules, allDefaultRules, relevantEngines);
 	}
 
 	protected toYamlComment(commentText: string): string {
@@ -224,8 +222,8 @@ class PlainYamlFormatter extends YamlFormatter {
 }
 
 class StyledYamlFormatter extends YamlFormatter {
-	constructor(config: CodeAnalyzerConfig, codeAnalyzer: CodeAnalyzer, userRules: RuleSelection, allDefaultRules: RuleSelection, relevantEngines: Set<string>) {
-		super(config, codeAnalyzer, userRules, allDefaultRules, relevantEngines);
+	constructor(codeAnalyzer: CodeAnalyzer, userRules: RuleSelection, allDefaultRules: RuleSelection, relevantEngines: Set<string>) {
+		super(codeAnalyzer, userRules, allDefaultRules, relevantEngines);
 	}
 
 	protected toYamlComment(commentText: string): string {

src/lib/viewers/ResultsViewer.ts

@@ -141,11 +141,11 @@ export class ResultsTableDisplayer extends AbstractResultsDisplayer {
 	protected _view(results: RunResults) {
 		const violations: Violation[] = sortViolations(results.getViolations());
 		const parentFolder: string = findLongestCommonParentFolderOf(violations.map(v =>
-			getPrimaryLocation(v).getFile()).filter(f => f !== undefined));
+			v.getPrimaryLocation().getFile()).filter(f => f !== undefined));
 
 		const resultRows: ResultRow[] = violations.map((v, idx) => {
 				const severity = v.getRule().getSeverityLevel();
-				const primaryLocation = getPrimaryLocation(v);
+				const primaryLocation: CodeLocation = v.getPrimaryLocation();
 				const relativeFile: string | null = primaryLocation.getFile() ?
 					path.relative(parentFolder, primaryLocation.getFile()!) : null;
 				return {
@@ -193,11 +193,6 @@ function sortViolations(violations: Violation[]): Violation[] {
 	});
 }
 
-// TODO: We should update core module to have this function directly on the Violation object and then remove this helper
-function getPrimaryLocation(violation: Violation): CodeLocation {
-	return violation.getCodeLocations()[violation.getPrimaryLocationIndex()];
-}
-
 /**
  * Returns the longest comment parent folder of the file paths provided
  * Note that this function assumes that all the paths are indeed files and not folders

yarn.lock

@@ -1699,10 +1699,10 @@
     strip-ansi "6.0.1"
     ts-retry-promise "^0.8.1"
 
-"@salesforce/[email protected].1":
-  version "0.20.1"
-  resolved "https://registry.yarnpkg.com/@salesforce/code-analyzer-core/-/code-analyzer-core-0.20.1.tgz#319fa83aa645cec6d14d8b0ad97cbfef505b1cee"
-  integrity sha512-c/xqGoB2Naea5+xbE/N8dcIC5gt1Fety1QRs2CKrXgv23y2YzYi7W6u7hmGZ9SlqtT0RvT3OngdvY7qgiaLV0Q==
+"@salesforce/[email protected].2":
+  version "0.20.2"
+  resolved "https://registry.yarnpkg.com/@salesforce/code-analyzer-core/-/code-analyzer-core-0.20.2.tgz#bc33c27809929070473e9dd94ef0fcf77f4a23c6"
+  integrity sha512-b1PqZD2lAW7XUcDjYAS+V40CpHQsLysdfq7Elo9ap6eCasjQ15CTOsctJWjyv2ZpUTyphAYo9iSDjkLZCJD2eg==
   dependencies:
     "@salesforce/code-analyzer-engine-api" "0.16.1"
     "@types/js-yaml" "^4.0.9"