@W-15093436@ trigger scan on save when a file is saved (#48)

* @W-15093436@ trigger scan on save when a file is saved

* review comments

* change flag description based on UI review + turning the flag off by default

Author: jag-j

package.json

@@ -68,6 +68,9 @@
         "lint": "eslint src --ext ts",
         "test": "node ./out/test/runTest.js"
     },
+    "activationEvents": [
+        "workspaceContains:sfdx-project.json"
+        ],
     "main": "./out/extension.js",
     "contributes": {
         "commands": [
@@ -111,10 +114,10 @@
                     "type": "string",
                     "description": "The Java Virtual Machine (JVM) arguments used to optimize Salesforce Graph Engine execution for your system."
                 },
-                "codeAnalyzer.analyze-on-save.enabled": {
+                "codeAnalyzer.analyzeOnSave.enabled": {
                     "type": "boolean",
-                    "default": true,
-                    "description": "Automatically scans the current file on save."
+                    "default": false,
+                    "description": "Scan the current file on save automatically."
                 }
             }
         },

src/extension.ts

@@ -9,6 +9,7 @@
 import * as vscode from 'vscode';
 import * as targeting from './lib/targeting';
 import {ScanRunner} from './lib/scanner';
+import {SettingsManager} from './lib/settings';
 import {SfCli} from './lib/sf-cli';
 
 import {RuleResult} from './types';
@@ -31,7 +32,8 @@ type RunInfo = {
 let diagnosticCollection: vscode.DiagnosticCollection = null;
 
 /**
- * This method is invoked when the extension is first activated (i.e., the very first time the command is executed).
+ * This method is invoked when the extension is first activated (this is currently configured to be when a sfdx project is loaded).
+ * The activation trigger can be changed by changing activationEvents in package.json
  * Registers the necessary diagnostic collections and commands.
  */
 export async function activate(context: vscode.ExtensionContext): Promise<vscode.ExtensionContext> {
@@ -40,8 +42,6 @@ export async function activate(context: vscode.ExtensionContext): Promise<vscode
 	// We need to do this first in case any other services need access to those provided by the core extension.
 	await CoreExtensionService.loadDependencies(context);
 
-	console.log(`Extension sfdx-code-analyzer-vscode activated.`);
-
 	// Define a diagnostic collection in the `activate()` scope so it can be used repeatedly.
 	diagnosticCollection = vscode.languages.createDiagnosticCollection('sfca');
 	context.subscriptions.push(diagnosticCollection);
@@ -74,6 +74,9 @@ export async function activate(context: vscode.ExtensionContext): Promise<vscode
 			outputChannel
 		});
 	});
+	outputChannel.appendLine(`Registered command as part of sfdx-code-analyzer-vscode activation.`);
+	registerScanOnSave(outputChannel);
+	outputChannel.appendLine('Registered scanOnSave as part of sfdx-code-analyzer-vscode activation.');
 	const graphEngineStatus: vscode.StatusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 100);
 	graphEngineStatus.name = messages.graphEngine.statusBarName;
 	context.subscriptions.push(graphEngineStatus);
@@ -85,6 +88,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<vscode
 	});
 	context.subscriptions.push(runOnActiveFile, runOnSelected, runDfaOnSelectedMethod);
 	TelemetryService.sendExtensionActivationEvent(extensionHrStart);
+	outputChannel.appendLine(`Extension sfdx-code-analyzer-vscode activated.`);
 	return Promise.resolve(context);
 }
 
@@ -99,6 +103,23 @@ async function verifyPluginInstallation(): Promise<void> {
 	}
 }
 
+export function registerScanOnSave(outputChannel: vscode.LogOutputChannel) {
+	vscode.workspace.onDidSaveTextDocument(
+		async (textDocument: vscode.TextDocument) => {
+			const documentUri = textDocument.uri;
+			if (
+				SettingsManager.getAnalyzeOnSave()
+			) {
+				await _runAndDisplayPathless([documentUri], {
+					commandName: Constants.COMMAND_RUN_ON_ACTIVE_FILE,
+					diagnosticCollection,
+					outputChannel
+				});
+			}
+		}
+	);
+}
+
 /**
  * Runs non-Path-based rules against the selected files/directories, or the active file if nothing was selected.
  * @param selections The files/directories manually selected by the user.

src/lib/settings.ts

@@ -29,4 +29,8 @@ export class SettingsManager {
     public static getGraphEngineJvmArgs(): string {
         return vscode.workspace.getConfiguration('codeAnalyzer.graphEngine').get('jvmArgs');
     }
+
+    public static getAnalyzeOnSave(): boolean {
+        return vscode.workspace.getConfiguration('codeAnalyzer.analyzeOnSave').get('enabled');
+    }
 }