Add validation command

Author: iSorp

CHANGELOG.md

@@ -1,6 +1,6 @@
 ## 0.4.3  (-, 2022)
 - Definition file dependency validation
-- Validation commands
+- Validation command
 
 ## 0.4.2  (July 6, 2022)
 - Fix a bug if an undefined symbol crashes the validator

README.md

@@ -247,9 +247,9 @@ This extension contributes the following settings:
 * `macro.lint`: Lint settings and rule configuration
 * `macro.sequence.base`: Sequences start number for refactoring
 * `macro.sequence.increment`: Sequences increment for refactoring
-* `macro.codelens.enable`: Enables or disables the CodeLens function. **Deprecated**: Please use `editor.codeLens` instead.
 * `macro.validate.enable`: Enables or disables the validation
 * `macro.validate.workspace`: Enables or disables the workspace validation
+* `macro.validate.onBuild`: Enables or disables the workspace validation when building the project
 
 Build settings:
 * `macro.build.compiler`: Selection of the macro compiler

client/src/common/commands.ts

@@ -6,7 +6,7 @@
 import * as vscode from 'vscode';
 import * as path from 'path';
 import CompositeDisposable from './compositeDisposable';
-import { WorkspaceFolder } from 'vscode-languageclient';
+import { pickFolder } from '../extension';
 
 const COMPILER = ['MCOMPI', 'MCOMP0', 'MCOMP30I', 'MCOMP15', 'MCOMP15I'];
 
@@ -119,23 +119,6 @@ function setExportPath () {
 	});
 }
 
-function pickFolder(cb:(workspace:vscode.WorkspaceFolder) => void) {
-	const folders = vscode.workspace.workspaceFolders;
-	if (folders.length === 1) {
-		cb(folders[0]);
-		return;
-	}
-	vscode.window.showWorkspaceFolderPick({placeHolder:'', ignoreFocusOut:true}).then(selected => {
-		if (selected) {
-			cb(selected);
-		}
-	});
-	if (folders.length === 1) {
-		cb(folders[0]);
-		return;
-	}
-}
-
 class ProjectService {
 
 	private getRelativePath(p:string, workspacePath:string, includeWsFolder:boolean = false) : string {
@@ -169,9 +152,15 @@ class ProjectService {
 	}
 
 	public async build() {
+	
 		pickFolder(async workspace => {
+			
 			const config = vscode.workspace.getConfiguration('macro', workspace);
 
+			if (config.validate.onBuild) {
+				vscode.commands.executeCommand('macro.action.validate', workspace.uri.toString());	
+			}
+			
 			const makeFile 	= config.build.makeFile;
 			const exportPath= config.project.exportPath;
 			const compiler 	= config.build.compiler;

client/src/extension.ts

@@ -1,22 +1,13 @@
 import * as path from 'path';
-import { workspace as Workspace, ExtensionContext, workspace, commands, window as Window, 
-	Location, 
-} from 'vscode';
-
-import { 
-	LanguageClient, LanguageClientOptions, 
-	ServerOptions, TransportKind, RevealOutputChannelOn,
-	ExecuteCommandSignature, WorkspaceFolder
-} from 'vscode-languageclient/node';
-
-
+import * as vscode from 'vscode';
+import * as lc from 'vscode-languageclient/node';
 import * as ls from 'vscode-languageserver-protocol';
 
 import registerCommands from './common/commands';
 
 import CompositeDisposable from './common/compositeDisposable';
 
-let client: LanguageClient;
+let client: lc.LanguageClient;
 let disposables = new CompositeDisposable();
 
 interface ConfigurationSettings {
@@ -33,7 +24,7 @@ interface ConfigurationSettings {
 	}
 	lint?: Object;
 	keywords: Object[],
-	workspaceFolder?: WorkspaceFolder | undefined;
+	workspaceFolder?: lc.WorkspaceFolder | undefined;
 	callFunctions?: string[];
 }
 
@@ -42,79 +33,90 @@ interface CodeLensReferenceArgument {
 	locations: ls.Location[]
 }
 
-export function activate(context: ExtensionContext) {
+export function activate(context: vscode.ExtensionContext) {
 
 	// The server is implemented in node
 	let serverModule = context.asAbsolutePath(
 		path.join('server', 'out', 'server.js')
 	);
 
 	let debugOptions = { execArgv: ['--nolazy', '--inspect=6011'], cwd: process.cwd() };
-	let serverOptions: ServerOptions = {
-		run: { module: serverModule, transport: TransportKind.ipc, options: { cwd: process.cwd() } },
+	let serverOptions: lc.ServerOptions = {
+		run: { module: serverModule, transport: lc.TransportKind.ipc, options: { cwd: process.cwd() } },
 		debug: {
 			module: serverModule,
-			transport: TransportKind.ipc,
+			transport: lc.TransportKind.ipc,
 			options: debugOptions
 		}
 	};
 
-	let clientOptions: LanguageClientOptions = {
+	let clientOptions: lc.LanguageClientOptions = {
 		documentSelector: [{ language: 'macro', scheme: 'file' }],
-		initializationOptions: workspace.getConfiguration('macro'),
+		initializationOptions: vscode.workspace.getConfiguration('macro'),
 		synchronize: {
-			fileEvents: workspace.createFileSystemWatcher('**/*.{[sS][rR][cC],[dD][eE][fF],[lL][nN][kK]}')
+			fileEvents: vscode.workspace.createFileSystemWatcher('**/*.{[sS][rR][cC],[dD][eE][fF],[lL][nN][kK]}')
 		},		
 		diagnosticCollectionName: 'macro',
 		progressOnInitialization: true,
-		revealOutputChannelOn: RevealOutputChannelOn.Never,	
+		revealOutputChannelOn: lc.RevealOutputChannelOn.Never,	
 		middleware: {
-
-			executeCommand: async (command:string, args:any[], next:ExecuteCommandSignature) => {
+			
+			executeCommand: async (command:string, args:any[], next:lc.ExecuteCommandSignature) => {
 				if (command === 'macro.codelens.references') {
 					const arg:CodeLensReferenceArgument = args[0];
 
 
 					const position = client.protocol2CodeConverter.asPosition(arg.position);
-					const locations:Location[] = [];
+					const locations:vscode.Location[] = [];
 					for (const location of arg.locations){
 						locations.push(client.protocol2CodeConverter.asLocation(location));
 					}
 
-					if (Window.activeTextEditor) {
-						commands.executeCommand('editor.action.showReferences', Window.activeTextEditor.document.uri, position, locations);
+					if (vscode.window.activeTextEditor) {
+						vscode.commands.executeCommand('editor.action.showReferences', vscode.window.activeTextEditor.document.uri, position, locations);
 					}
 				}
 				else if (command === 'macro.action.refactorsequeces' || command === 'macro.action.addsequeces') {
 					function validate(input:string): string | null {
 						return Number.isInteger(Number(input)) ? null : 'Integer expected';
 					}
 
-					const config = workspace.getConfiguration('macro');
+					const config = vscode.workspace.getConfiguration('macro');
 					let start = undefined;
 					if (command === 'macro.action.refactorsequeces') {
-						start = await Window.showInputBox({
+						start = await vscode.window.showInputBox({
 							prompt: 'Start sequence number',
 							value: config.sequence.base,
 							validateInput: validate
 						});
 					}
 
-					const increment = await Window.showInputBox({
+					const increment = await vscode.window.showInputBox({
 						prompt: 'Sequence number increment',
 						value: config.sequence.increment,
 						validateInput: validate
 					});
 
-					if (Window.activeTextEditor) {
+					if (vscode.window.activeTextEditor) {
 						if (command === 'macro.action.addsequeces' && increment) {
-							return next(command, [Window.activeTextEditor.document.uri.toString(), Window.activeTextEditor.selection.start, increment]);
+							return next(command, [vscode.window.activeTextEditor.document.uri.toString(), vscode.window.activeTextEditor.selection.start, increment]);
 						} 
 						else if (command === 'macro.action.refactorsequeces' && start && increment) {
-							return next(command, [Window.activeTextEditor.document.uri.toString(), Window.activeTextEditor.selection.start, start, increment]);
+							return next(command, [vscode.window.activeTextEditor.document.uri.toString(), vscode.window.activeTextEditor.selection.start, start, increment]);
 						}
 					}
 				}
+				else if (command === 'macro.action.validate') {
+					const workspaceUri = args[0];
+					if (workspaceUri) {
+						return next(command, [workspaceUri]);	
+					}
+					else {
+						pickFolder(workspace => {
+							return next(command, [workspace.uri.toString()]);	
+						});	
+					}
+				}
 			},
 			workspace : {
 				configuration: async (params, _token, _next): Promise<any[]> => {
@@ -128,8 +130,8 @@ export function activate(context: ExtensionContext) {
 							continue;
 						}
 						const resource = client.protocol2CodeConverter.asUri(item.scopeUri);
-						const workspaceFolder = Workspace.getWorkspaceFolder(resource);
-						const config = workspace.getConfiguration('macro', workspaceFolder);
+						const workspaceFolder = vscode.workspace.getWorkspaceFolder(resource);
+						const config = vscode.workspace.getConfiguration('macro', workspaceFolder);
 						const settings: ConfigurationSettings = {
 							codelens: config.get('codelens'),
 							lint:config.get('lint', {}),
@@ -153,9 +155,8 @@ export function activate(context: ExtensionContext) {
 		} as any
 	};
 
-
 	// Create the language client and start the client.
-	client = new LanguageClient(
+	client = new lc.LanguageClient(
 		'macroLanguageServer',
 		'Macro Language Server',
 		serverOptions,
@@ -173,3 +174,24 @@ export function deactivate(): Thenable<void> | undefined {
 	}
 	return client.stop();
 }
+
+export function pickFolder(cb:(workspace: vscode.WorkspaceFolder) => void) {
+	const folders = vscode.workspace.workspaceFolders;
+	if (!folders) {
+		return;
+	}
+	
+	if (folders.length === 1) {
+		cb(folders[0]);
+		return;
+	}
+	vscode.window.showWorkspaceFolderPick({placeHolder:'', ignoreFocusOut:true}).then(selected => {
+		if (selected) {
+			cb(selected);
+		}
+	});
+	if (folders.length === 1) {
+		cb(folders[0]);
+		return;
+	}
+}

i18n/chs/package.i18n.json

@@ -7,13 +7,14 @@
 	"macro.setControlType": "选择NC系统类型",
 	"macro.action.addsequeces": "添加缺失的顺序号",
 	"macro.action.refactorsequeces": "重排顺序号",
+	"macro.action.validate" : "Validate Workspace",
     "macro.callFunctions.description": "子程序调用",
 	"macro.lint.description": "Lint设置",
     "macro.sequence.base.description": "顺序起始号",
     "macro.sequence.increment.description": "顺序号增量",
-    "macro.codelens.enable.description": "CodeLens使能",
     "macro.validate.enable.description": "代码校验",
     "macro.validate.workspace.description": "环境校验",
+	"macro.validate.onBuild.description": "Enables or disables the workspace validation when building the project",
     "macro.build.compiler.description": "选择宏编译器",
     "macro.build.controlType.description": "选择NC系统类型",
 	"macro.build.compilerParams.description": "附加其他编译参数 -NR -L1 -L2 -L3 -PR",

i18n/deu/package.i18n.json

@@ -7,13 +7,14 @@
 	"macro.setControlType": "Steuerungstyp auswählen",
 	"macro.action.addsequeces": "Fehlende Sequenznummern hinzufügen",
 	"macro.action.refactorsequeces": "Sequenznummern neu ordnen",
+	"macro.action.validate" : "Überprüfung des gesamten Arbeitsbereichs",
 	"macro.callFunctions.description": "Benutzerdefinierte Funktionen zum Aufrufen von Unterprogrammen",
 	"macro.lint.description": "Lint Einstellungen",
 	"macro.sequence.base.description": "Startnummer der Sequenzen für das Refactoring",
 	"macro.sequence.increment.description": "Inkrement der Sequenzen für Refactoring",
-	"macro.codelens.enable.description": " Aktiviert oder deaktiviert die CodeLens Funktion",
 	"macro.validate.enable.description": "Aktiviert oder deaktiviert alle Überprüfungen",
 	"macro.validate.workspace.description": "Aktiviert oder deaktiviert die Überprüfung des gesamten Arbeitsbereichs",
+	"macro.validate.onBuild.description": "Aktiviert oder deaktiviert die Überprüfung des gesamten Arbeitsbereichs beim Erstellen des Projekts",
 	"macro.build.compiler.description": "Auswahl des Macro-Compilers",
 	"macro.build.controlType.description": "Auswahl des Steuerungstyps",
 	"macro.build.compilerParams.description": "Zusätzliche Compilerparameter: -NR, -L1, -L2, -L3, -PR",
@@ -23,4 +24,4 @@
 	"macro.project.sourcePath.description": "Der Pfad zu dem Verzeichnis wo die Source-Dateien (.src) liegen",
 	"macro.project.buildPath.description": "Der Pfad zu dem Verzeichnis wo der Compiler die erstellten Dateien ablegt",
 	"macro.project.linkPath.description": "Der Pfad zu dem Verzeichnis wo die Link-Dateien (.lnk) liegen. Im gleichen Verzeichnis befindet sich auch die Bibliothek .mex"
-}
+}

package.json

@@ -105,8 +105,8 @@
 				"category": "Macro"
 			},
 			{
-				"command": "macro.validate.workspace",
-				"title": "%macro.validate.workspace%",
+				"command": "macro.action.validate",
+				"title": "%macro.action.validate%",
 				"category": "Macro"
 			}
 		],
@@ -419,14 +419,6 @@
 					"default": 10,
 					"description": "%macro.sequence.increment.description%"
 				},
-				"macro.codelens.enable": {
-					"scope": "resource",
-					"type": "boolean",
-					"default": true,
-					"description": "%macro.codelens.enable.description%",
-					"markdownDeprecationMessage": "**Deprecated**: Please use `#editor.codeLens#` instead.",
-					"deprecationMessage": "Deprecated: Please use editor.codeLens instead."
-				},
 				"macro.validate.enable": {
 					"scope": "resource",
 					"type": "boolean",
@@ -439,6 +431,12 @@
 					"default": true,
 					"description": "%macro.validate.workspace.description%"
 				},
+				"macro.validate.onBuild": {
+					"scope": "resource",
+					"type": "boolean",
+					"default": false,
+					"description": "%macro.validate.onBuild.description%"
+				},
 				"macro.build.compiler": {
 					"type": "string",
 					"scope": "resource",

package.nls.json

@@ -7,14 +7,14 @@
 	"macro.setControlType": "Select Control Type",
 	"macro.action.addsequeces": "Add missing sequence numbers",
 	"macro.action.refactorsequeces": "Reorganize sequence numbers",
-
+	"macro.action.validate" : "Validate Workspace",
 	"macro.callFunctions.description": "Custom call functions",
 	"macro.lint.description": "Lint settings",
 	"macro.sequence.base.description": "Sequences start number for refactoring",
 	"macro.sequence.increment.description": "Sequences increment for refactoring",
-	"macro.codelens.enable.description": "Enables or disables the CodeLens function",
 	"macro.validate.enable.description": "Enables or disables the validation",
 	"macro.validate.workspace.description": "Enables or disables the workspace validation",
+	"macro.validate.onBuild.description": "Enables or disables the workspace validation when building the project",
 	"macro.build.compiler.description": "Selection of the macro compiler",
 	"macro.build.controlType.description": "Selection of the control type",
 	"macro.build.compilerParams.description": "Additional compiler parameters: -NR, -L1, -L2, -L3, -PR",