NEW: @W-17916450@ update v5 CLI to allow rules to be saved to JSON (Part 1)

Author: randi274

messages/action-summary-viewer.md

@@ -18,6 +18,10 @@ Configuration written to:
 
 Found 0 rules.
 
+# rules-action.outfile-location
+
+Rules written to:
+
 # rules-action.rules-total
 
 Found %d rule(s) from %d engine(s):

messages/rules-command.md

@@ -102,4 +102,14 @@ Format to display the rules in the terminal.
 
 # flags.view.description
 
-The format `table` is concise and shows minimal output, the format `detail` shows all available information.
+The format `table` is concise and shows minimal output, the format `detail` shows all available information. If you specify neither --view nor --output-file, then the default table view is shown. If you specify --output-file but not --view, only summary information is shown.
+
+# flags.output-file.summary
+
+Output file location to write the selected rules. The file is written in JSON format.
+
+# flags.output-file.description
+
+Use this flag to write the selected rules to a JSON file. For example: "--output-file ./out/rules.json” creates a JSON results file in the "./out" folder. If the file exists already, it will be overwritten.
+
+If you don't specify this flag, the command outputs the rules in the terminal. The view flag can be used in combination with this flag to save the file and output the results.

messages/rules-writer.md

@@ -0,0 +1,3 @@
+# error.unrecognized-file-format
+
+The output file %s has an unsupported extension. Valid extensions include: .json.

package.json

@@ -6,7 +6,7 @@
 	"bugs": "https://github.com/forcedotcom/sfdx-scanner/issues",
 	"dependencies": {
 		"@oclif/core": "3.27.0",
-		"@salesforce/code-analyzer-core": "0.23.0",
+		"@salesforce/code-analyzer-core": "0.24.0",
 		"@salesforce/code-analyzer-engine-api": "0.18.0",
 		"@salesforce/code-analyzer-eslint-engine": "0.20.0",
 		"@salesforce/code-analyzer-flowtest-engine": "0.18.0",

src/commands/code-analyzer/rules.ts

@@ -2,13 +2,14 @@ import {Flags, SfCommand} from '@salesforce/sf-plugins-core';
 import {View} from '../../Constants';
 import {CodeAnalyzerConfigFactoryImpl} from '../../lib/factories/CodeAnalyzerConfigFactory';
 import {EnginePluginsFactoryImpl} from '../../lib/factories/EnginePluginsFactory';
-import {RuleDetailDisplayer, RuleTableDisplayer} from '../../lib/viewers/RuleViewer';
+import {RuleDetailDisplayer, RulesNoOpDisplayer, RuleTableDisplayer} from '../../lib/viewers/RuleViewer';
 import {RulesActionSummaryViewer} from '../../lib/viewers/ActionSummaryViewer';
-import {RulesAction, RulesDependencies} from '../../lib/actions/RulesAction';
+import {RulesAction, RulesDependencies, RulesInput} from '../../lib/actions/RulesAction';
 import {BundleName, getMessage, getMessages} from '../../lib/messages';
 import {Displayable, UxDisplay} from '../../lib/Display';
 import {LogEventDisplayer} from '../../lib/listeners/LogEventListener';
 import {RuleSelectionProgressSpinner} from '../../lib/listeners/ProgressEventListener';
+import {CompositeRulesWriter} from '../../lib/writers/RulesWriter';
 
 export default class RulesCommand extends SfCommand<void> implements Displayable {
 	// We don't need the `--json` output for this command.
@@ -42,11 +43,15 @@ export default class RulesCommand extends SfCommand<void> implements Displayable
 			char: 'c',
 			exists: true
 		}),
+		'output-file': Flags.file({
+			summary: getMessage(BundleName.RulesCommand, 'flags.output-file.summary'),
+			description: getMessage(BundleName.RulesCommand, 'flags.output-file.description'),
+			char: 'f'
+		}),
 		view: Flags.string({
 			summary: getMessage(BundleName.RulesCommand, 'flags.view.summary'),
 			description: getMessage(BundleName.RulesCommand, 'flags.view.description'),
 			char: 'v',
-			default: View.TABLE,
 			options: Object.values(View)
 		})
 	};
@@ -56,21 +61,53 @@ export default class RulesCommand extends SfCommand<void> implements Displayable
 		this.warn(getMessage(BundleName.Shared, "warning.command-state", [getMessage(BundleName.Shared, 'label.command-state')]));
 
 		const parsedFlags = (await this.parse(RulesCommand)).flags;
-		const dependencies: RulesDependencies = this.createDependencies(parsedFlags.view as View);
+		const outputFiles = parsedFlags['output-file'] ? [parsedFlags['output-file']] : [];
+		const view = parsedFlags.view as View | undefined;
+
+		const dependencies: RulesDependencies = this.createDependencies(view, outputFiles);
 		const action: RulesAction = RulesAction.createAction(dependencies);
-		await action.execute(parsedFlags);
+
+		const rulesInput: RulesInput = {
+			'config-file': parsedFlags['config-file'],
+			'output-file': outputFiles,
+			'rule-selector': parsedFlags['rule-selector'],
+			'workspace': parsedFlags['workspace'],
+		};
+
+		await action.execute(rulesInput);
 	}
 
-	protected createDependencies(view: View): RulesDependencies {
+	protected createDependencies(view: View | undefined, outputFiles: string[]): RulesDependencies {
 		const uxDisplay: UxDisplay = new UxDisplay(this, this.spinner);
-		return {
+		const dependencies: RulesDependencies = {
 			configFactory: new CodeAnalyzerConfigFactoryImpl(),
 			pluginsFactory: new EnginePluginsFactoryImpl(),
 			logEventListeners: [new LogEventDisplayer(uxDisplay)],
 			progressListeners: [new RuleSelectionProgressSpinner(uxDisplay)],
 			actionSummaryViewer: new RulesActionSummaryViewer(uxDisplay),
-			viewer: view === View.TABLE ? new RuleTableDisplayer(uxDisplay) : new RuleDetailDisplayer(uxDisplay)
+			viewer: this.createRulesViewer(view, outputFiles, uxDisplay),
+			writer: CompositeRulesWriter.fromFiles(outputFiles)
 		};
+		
+		return dependencies;
+	}
+
+	/**
+	 * Creates the {@link RuleViewer} that will be called from {@link RulesAction.execute} to display rules.
+	 * If a view option is set, rules will be displayed in the specified format.
+	 * If an output file is set, rules will not display.
+	 * By default, the details display will be used.
+	 */
+	private createRulesViewer(view: View | undefined, outputFiles: string[] = [], uxDisplay: UxDisplay) {
+		if (view === View.DETAIL) {
+			return new RuleDetailDisplayer(uxDisplay);
+		} else if (view === View.TABLE) {
+			return new RuleTableDisplayer(uxDisplay);
+		} else if (outputFiles.length > 0) {
+			return new RulesNoOpDisplayer();
+		}
+
+		return new RuleTableDisplayer(uxDisplay);
 	}
 }
 

src/lib/actions/RulesAction.ts

@@ -1,12 +1,13 @@
-import {CodeAnalyzer, CodeAnalyzerConfig, Rule, RuleSelection} from '@salesforce/code-analyzer-core';
-import {CodeAnalyzerConfigFactory} from '../factories/CodeAnalyzerConfigFactory';
-import {EnginePluginsFactory} from '../factories/EnginePluginsFactory';
-import {createWorkspace} from '../utils/WorkspaceUtil';
-import {ProgressEventListener} from '../listeners/ProgressEventListener';
-import {LogFileWriter} from '../writers/LogWriter';
-import {LogEventListener, LogEventLogger} from '../listeners/LogEventListener';
-import {RuleViewer} from '../viewers/RuleViewer';
-import {RulesActionSummaryViewer} from '../viewers/ActionSummaryViewer';
+import { CodeAnalyzer, CodeAnalyzerConfig, Rule, RuleSelection } from '@salesforce/code-analyzer-core';
+import { CodeAnalyzerConfigFactory } from '../factories/CodeAnalyzerConfigFactory';
+import { EnginePluginsFactory } from '../factories/EnginePluginsFactory';
+import { LogEventListener, LogEventLogger } from '../listeners/LogEventListener';
+import { ProgressEventListener } from '../listeners/ProgressEventListener';
+import { createWorkspace } from '../utils/WorkspaceUtil';
+import { RulesActionSummaryViewer } from '../viewers/ActionSummaryViewer';
+import { RuleViewer } from '../viewers/RuleViewer';
+import { LogFileWriter } from '../writers/LogWriter';
+import { RulesWriter } from '../writers/RulesWriter';
 
 export type RulesDependencies = {
 	configFactory: CodeAnalyzerConfigFactory;
@@ -15,12 +16,15 @@ export type RulesDependencies = {
 	progressListeners: ProgressEventListener[];
 	actionSummaryViewer: RulesActionSummaryViewer,
 	viewer: RuleViewer;
+	writer: RulesWriter;
 }
 
 export type RulesInput = {
 	'config-file'?: string;
 	'rule-selector': string[];
+	'output-file'?: string[];
 	workspace?: string[];
+	view?: string;
 }
 
 export class RulesAction {
@@ -60,8 +64,14 @@ export class RulesAction {
 		this.dependencies.logEventListeners.forEach(listener => listener.stopListening());
 		const rules: Rule[] = core.getEngineNames().flatMap(name => ruleSelection.getRulesFor(name));
 
+		this.dependencies.writer.write(ruleSelection)
 		this.dependencies.viewer.view(rules);
-		this.dependencies.actionSummaryViewer.viewPostExecutionSummary(ruleSelection, logWriter.getLogDestination());
+		
+		this.dependencies.actionSummaryViewer.viewPostExecutionSummary(
+			ruleSelection,
+			logWriter.getLogDestination(),
+			input['output-file'] ?? []
+		);
 	}
 
 	public static createAction(dependencies: RulesDependencies): RulesAction {

src/lib/messages.ts

@@ -14,6 +14,7 @@ export enum BundleName {
 	ResultsViewer = 'results-viewer',
 	RuleViewer = 'rule-viewer',
 	RulesCommand = 'rules-command',
+	RulesWriter = 'rules-writer',
 	ResultsWriter = 'results-writer',
 	RunAction = 'run-action',
 	RunCommand = 'run-command',

src/lib/viewers/ActionSummaryViewer.ts

@@ -31,6 +31,13 @@ abstract class AbstractActionSummaryViewer {
 		this.display.displayLog(getMessage(BundleName.ActionSummaryViewer, 'common.logfile-location'));
 		this.display.displayLog(indent(logFile));
 	}
+
+	protected displayOutfiles(outfiles: string[], msgKey: string): void {
+		this.display.displayLog(getMessage(BundleName.ActionSummaryViewer, msgKey));
+		for (const outfile of outfiles) {
+			this.display.displayLog(indent(outfile));
+		}
+	}
 }
 
 export class ConfigActionSummaryViewer extends AbstractActionSummaryViewer {
@@ -45,37 +52,39 @@ export class ConfigActionSummaryViewer extends AbstractActionSummaryViewer {
 		this.displayLineSeparator();
 
 		if (outfile) {
-			this.displayOutfile(outfile);
+			this.displayOutfiles([outfile], 'config-action.outfile-location');
 			this.displayLineSeparator();
 		}
 
 		this.displayLogFileInfo(logFile);
 	}
-
-	private displayOutfile(outfile: string): void {
-		this.display.displayLog(getMessage(BundleName.ActionSummaryViewer, 'config-action.outfile-location'));
-		this.display.displayLog(indent(outfile));
-	}
 }
 
 export class RulesActionSummaryViewer extends AbstractActionSummaryViewer {
 	public constructor(display: Display) {
 		super(display);
 	}
 
-	public viewPostExecutionSummary(ruleSelection: RuleSelection, logFile: string): void {
+	public viewPostExecutionSummary(ruleSelection: RuleSelection, logFile: string, outfiles: string[]): void {
 		// Start with separator to cleanly break from anything that's already been logged.
 		this.displayLineSeparator();
 		this.displaySummaryHeader();
 		this.displayLineSeparator();
 
-		if (ruleSelection.getCount() === 0) {
+		const noRulesFound = ruleSelection.getCount() === 0;
+
+		if (noRulesFound) {
 			this.display.displayLog(getMessage(BundleName.ActionSummaryViewer, 'rules-action.found-no-rules'));
 		} else {
 			this.displayRuleSelection(ruleSelection);
 		}
 		this.displayLineSeparator();
 
+		if (outfiles.length > 0) {
+			this.displayOutfiles(outfiles, 'rules-action.outfile-location');
+			this.displayLineSeparator();
+		}
+
 		this.displayLogFileInfo(logFile);
 	}
 
@@ -107,7 +116,7 @@ export class RunActionSummaryViewer extends AbstractActionSummaryViewer {
 		this.displayLineSeparator();
 
 		if (outfiles.length > 0) {
-			this.displayOutfiles(outfiles);
+			this.displayOutfiles(outfiles, 'run-action.outfiles-total');
 			this.displayLineSeparator();
 		}
 
@@ -139,11 +148,4 @@ export class RunActionSummaryViewer extends AbstractActionSummaryViewer {
 		});
 		return fileSet.size;
 	}
-
-	private displayOutfiles(outfiles: string[]): void {
-		this.display.displayLog(getMessage(BundleName.ActionSummaryViewer, 'run-action.outfiles-total'));
-		for (const outfile of outfiles) {
-			this.display.displayLog(indent(outfile));
-		}
-	}
 }

src/lib/viewers/RuleViewer.ts

@@ -8,7 +8,6 @@ export interface RuleViewer {
 	view(rules: Rule[]): void;
 }
 
-
 abstract class AbstractRuleDisplayer implements RuleViewer {
 	protected display: Display;
 
@@ -111,3 +110,8 @@ export class RuleTableDisplayer extends AbstractRuleDisplayer {
 	}
 }
 
+export class RulesNoOpDisplayer implements RuleViewer {
+	public view(_rules: Rule[]): void {
+		return;
+	}
+}

src/lib/writers/RulesWriter.ts

@@ -0,0 +1,46 @@
+import * as fs from 'node:fs';
+import { OutputFormat, RuleSelection } from "@salesforce/code-analyzer-core";
+import path from "path";
+import { BundleName, getMessage } from "../messages";
+
+export interface RulesWriter {
+    write(rules: RuleSelection): void;
+}
+
+
+export class CompositeRulesWriter implements RulesWriter {
+    private readonly writers: RulesWriter[] = [];
+
+    private constructor(writers: RulesWriter[]) {
+        this.writers = writers;
+    }
+
+    public write(rules: RuleSelection): void {
+        this.writers.forEach(w => w.write(rules));
+    }
+
+    public static fromFiles(files: string[]): CompositeRulesWriter {
+        return new CompositeRulesWriter(files.map(f => new RulesFileWriter(f)));
+    }
+}
+
+export class RulesFileWriter implements RulesWriter {
+    private readonly file: string;
+    private readonly format: OutputFormat;
+
+    public constructor(file: string) {
+        this.file = file;
+        const ext = path.extname(file).toLowerCase();
+
+        if (ext === '.json') {
+            this.format = OutputFormat.JSON;
+        } else {
+            throw new Error(getMessage(BundleName.RulesWriter, 'error.unrecognized-file-format', [file]));
+        }
+    }
+    
+    public write(ruleSelection: RuleSelection): void {
+        const contents = ruleSelection.toFormattedOutput(this.format);
+        fs.writeFileSync(this.file, contents);
+    }
+}