Merge dev state to main (#1)

Author: Tobias

.gitignore

@@ -105,3 +105,8 @@ dist
 
 # TernJS port file
 .tern-port
+
+# Misc
+.vscode-test/
+package-lock.json
+.eslintrc.json

.vscode/launch.json

@@ -22,6 +22,7 @@
 			"type": "extensionHost",
 			"request": "launch",
 			"args": [
+				"${workspaceFolder}/src/test/suite/test.cpp",
 				"--extensionDevelopmentPath=${workspaceFolder}",
 				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
 			],
@@ -31,4 +32,4 @@
 			"preLaunchTask": "${defaultBuildTask}"
 		}
 	]
-}
+}

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-All notable changes to the "cppinsights-vscode" extension will be documented in this file.
+All notable changes to the "vscode-cppinsights" extension will be documented in this file.
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 

README.md

@@ -16,16 +16,20 @@ This extension requires C++ Insights of @andreasfertig.
 C++ Insights can be found here:
 https://github.com/andreasfertig/cppinsights
 Build or download the latest release.
-Specify the directory to cppinsights binary in (link to settings) `cppinsights-vscode.path`.
+Specify the directory to cppinsights binary in (link to settings) `vscode-cppinsights.path`.
+
+## Commands
+* `vscode-cppinsights.insights`: Show C++ insights
+* `vscode-cppinsights.insightsDiff`: Show C++ insights diff with original
 
 ## Extension Settings
 
 This extension contributes the following settings:
 
-* `cppinsights-vscode.path`
-* `cppinsights-vscode.buildDirector`
-* `cppinsights-vscode.diff`
-* `cppinsights-vscode.args`
+* `vscode-cppinsights.path`
+* `vscode-cppinsights.buildDirector`
+* `vscode-cppinsights.diff`
+* `vscode-cppinsights.args`
 
 
 <!-- -----------------------------------------------------------------------------------------------------------

package.json

@@ -1,5 +1,5 @@
 {
-	"name": "cppinsights-vscode",
+	"name": "vscode-cppinsights",
 	"displayName": "C++ Insights",
 	"description": "vscode extension for C++ Insights",
 	"version": "0.0.1",
@@ -14,46 +14,46 @@
 		"Other"
 	],
 	"activationEvents": [
-		"onCommand:cppinsights-vscode.insights",
-		"onCommand:cppinsights-vscode.insightsDiff"
+		"onCommand:vscode-cppinsights.insights",
+		"onCommand:vscode-cppinsights.insightsDiff"
 	],
 	"main": "./out/extension.js",
 	"contributes": {
 		"commands": [
 			{
-				"command": "cppinsights-vscode.insights",
+				"command": "vscode-cppinsights.insights",
 				"title": "Show C++ insights"
 			},
 			{
-				"command": "cppinsights-vscode.insightsDiff",
+				"command": "vscode-cppinsights.insightsDiff",
 				"title": "Show C++ insights diff with original"
 			}
 		],
 		"configuration": [
 			{
 				"title": "C++ insights",
 				"properties": {
-					"cppinsights-vscode.buildDirectory": {
+					"vscode-cppinsights.buildDirectory": {
 						"type": "string",
 						"default": [],
-						"description": "Build directory of the compilation database",
+						"description": "Build directory of the compilation database.",
 						"scope": "resource"
 					},
-					"cppinsights-vscode.path": {
+					"vscode-cppinsights.path": {
 						"type": "string",
 						"default": "insights",
-						"description": "Path to the cppinsights executable (insights)",
+						"description": "Path to the cppinsights executable (insights).",
 						"scope": "resource"
 					},
-					"cppinsights-vscode.diff": {
+					"vscode-cppinsights.diff": {
 						"type": "boolean",
-						"description": "Show diff instead of insights output",
+						"description": "Show diff instead of insights output.",
 						"scope": "resource"
 					},
-					"cppinsights-vscode.args": {
+					"vscode-cppinsights.args": {
 						"type": "array",
 						"default": [],
-						"description": "Additional arguments",
+						"description": "Additional arguments. The final call to insights will look like this: <path> <file> -p <buildDirectory> -- <args>",
 						"scope": "resource"
 					}
 				}

src/extension.ts

@@ -6,7 +6,7 @@ import path = require('path');
 
 export function activate(context: vscode.ExtensionContext) {
 
-	console.log('Activating "cppinsights-vscode"');
+	console.log('Activating "vscode-cppinsights"');
 
 
 	registerCommands(context);
@@ -16,35 +16,33 @@ export function activate(context: vscode.ExtensionContext) {
  * Register all commands
  */
 function registerCommands(context: vscode.ExtensionContext) {
-	vscode.commands.registerTextEditorCommand('cppinsights-vscode.insights', () => {
+	vscode.commands.registerTextEditorCommand('vscode-cppinsights.insights', () => {
 		executeInsights();
 	});
 
-	vscode.commands.registerTextEditorCommand('cppinsights-vscode.insightsDiff', () => {
+	vscode.commands.registerTextEditorCommand('vscode-cppinsights.insightsDiff', () => {
 		executeInsights(true);
 	});
 	// TODO format, diff as parameter to command instead of extra commands, no-build-dir
-
-	// TODO check register result
 }
 
 /**
  * Create the skeleton insights command from the configuration
  */
-function createExecutableBase(config: vscode.WorkspaceConfiguration, cmake_build_dir: string | undefined): { path: string, args: (string)[] } {
-
+export function createCall(config: vscode.WorkspaceConfiguration, cmake_build_dir: string | undefined, filePath: string): { path: string, args: (string)[] } {
 	let build_dir = cmake_build_dir || config.get('buildDirectory');
 
 	if (!config.get('path')) {
-		vscode.window.showErrorMessage('Missing value for cppinsights-vscode.path');
+		vscode.window.showErrorMessage('Missing value for vscode-cppinsights.path');
 		throw vscode.CancellationError;
 	}
 
-	let args: string[] = [];
-	if (build_dir)
+	let args: string[] = [filePath];
+	if (build_dir && build_dir.length > 0)
 		args.push("-p=\"" + build_dir + "\"");
 
 	if (config.get<string[]>('args')) {
+		args.push("--");
 		args = [...args, ...config.get<string[]>('args')!];
 	}
 
@@ -53,12 +51,18 @@ function createExecutableBase(config: vscode.WorkspaceConfiguration, cmake_build
 	};
 }
 
+export function callToString(insights_call: { path: string, args: (string)[] }): string {
+	return insights_call.path + ' ' + insights_call.args.join(' ');
+}
+
 /**
  * Execute insights command
  */
 function executeInsights(show_diff: boolean = false) {
-	let configuration = vscode.workspace.getConfiguration('cppinsights-vscode');
+	let configuration = vscode.workspace.getConfiguration('vscode-cppinsights');
 
+	// TODO on save
+	// TODO formatter use configured settings
 
 	// TODO Impl as TextDocumentProvider
 	// TODO QuickDiffProvider?
@@ -71,17 +75,16 @@ function executeInsights(show_diff: boolean = false) {
 		let input_document = input_editor!.document;
 
 		// TODO improve condition for cmake usage... getWorkspaceFolder b/c default is ${workspaceFolder}/build
-		let insights_command = createExecutableBase(configuration, vscode.workspace.getWorkspaceFolder(input_document.uri) ? vscode.workspace.getConfiguration('cmake').get('buildDirectory') : undefined);
-		insights_command.args.push(input_document.fileName!);
+		let insights_command = createCall(configuration, vscode.workspace.getWorkspaceFolder(input_document.uri) ? vscode.workspace.getConfiguration('cmake').get('buildDirectory') : undefined, input_document.fileName!);
 
 		console.log("Executing " + JSON.stringify(insights_command));
 
 		// TODO code variables are probably not resloved, use vscode Task interface
 		// TODO use execFile or sth else which allows for passing args as string[]
-		const exec_command = insights_command.path + ' ' + insights_command.args.join(' ');
+		const exec_command = callToString(insights_command);
 		child.exec(exec_command, (error: child.ExecException | null, stdout: string, stderr: string) => {
 			if (error) {
-				vscode.window.showErrorMessage('insights failed:\n' + exec_command + '\n' + stderr);
+				vscode.window.showErrorMessage('insights failed:\n' + exec_command + '\n' + stderr + '\n' + stdout);
 				console.error(error);
 				console.error(stderr);
 				return;
@@ -107,7 +110,7 @@ function executeInsights(show_diff: boolean = false) {
 						});
 					}
 					else {
-						diff(input_document.uri, output_document.uri)
+						diff(input_document.uri, output_document.uri);
 					}
 				});
 			});
@@ -120,7 +123,7 @@ function executeInsights(show_diff: boolean = false) {
 }
 
 function format(uri: vscode.Uri) {
-	console.log("Formatting document")
+	console.log("Formatting document");
 
 	// TODO read format options form settings
 	vscode.commands.executeCommand('vscode.executeFormatDocumentProvider', uri, { tabSize: 4, insertSpaces: false }).then((textEdits) => {

src/test/suite/extension.test.ts

@@ -1,15 +1,47 @@
 import * as assert from 'assert';
+import * as child from 'child_process';
 
 // You can import and use all API from the 'vscode' module
 // as well as import your extension to test it
 import * as vscode from 'vscode';
-// import * as myExtension from '../../extension';
+import * as ins from '../../extension';
+
+export async function getExtension() {
+	const ext = vscode.extensions.getExtension('vscode-cppinsights');
+	if (!ext) {
+		throw new Error('Extension doesn\'t exist');
+	}
+	return ext.isActive ? Promise.resolve(ext.exports) : ext.activate();
+}
 
 suite('Extension Test Suite', () => {
 	vscode.window.showInformationMessage('Start all tests.');
 
-	test('Sample test', () => {
-		assert.strictEqual(-1, [1, 2, 3].indexOf(5));
-		assert.strictEqual(-1, [1, 2, 3].indexOf(0));
+	// test('Load extension', () => {
+	// 	getExtension();
+	// });
+
+	test('Execute command', () => {
+		return vscode.commands.executeCommand('vscode-cppinsights.insights').then(() => {
+			console.log("Command success");
+		}, (rejection_reason) => {
+			assert.fail("Unable to run command");
+		});
+	});
+
+	test('Run executable', () => {
+		let configuration = vscode.workspace.getConfiguration('vscode-cppinsights');
+
+		let uri = vscode.window.visibleTextEditors[0].document.uri;
+
+		let insights_command = ins.createCall(configuration, undefined, uri.path);
+
+		const exec_command = ins.callToString(insights_command);
+		return child.exec(exec_command, (error: child.ExecException | null, stdout: string, stderr: string) => {
+			if (error) {
+				assert.fail("Unable to run insights");
+			}
+		});
 	});
+
 });

src/test/suite/test.cpp

@@ -0,0 +1,15 @@
+#include <array>
+#include <iostream>
+
+int main()
+{
+    std::cout << "showcase of cpp-insights vscode extension";
+
+    std::array<char, 10> arr = {2, 4, 6, 8, '\0', '\0', '\0', '\0', '\0', '\0'};
+
+    for(const char& c : arr) {
+        printf("c=%c\n", c);
+    }
+
+    return 0;
+}