Clean up npm scripts and start running tests

Since the repo started, we've had a single NPM script that ran on postinstall. All this did was run the VS Code install
script and then launch tsc. Now, postinstall just runs the VS Code install script. The idea here is that install should
really just lay down dependencies, not compile code. Compilation is split off into a separate script.

Here are the new npm scripts:

* `postinstall`: As described above, this now just runs the VS Code install script after `npm install`.
* `compile`: Runs the VS Code compile script to transpile TypeScript to JavaScript. Run this with `npm run compile`.
* `watch`: Runs the VS Code compile script with the '-watch' flag to transpile TypeScript to JavaScript, and then
watch for file changes and incrementally compile. Run this with `npm run watch`.
* `test`: Runs the tests with Mocha. Note: This will only run tests that are already transpiled to JavaScript. Run with
`npm test`.

* Unit tests can be written in the 'test' folder. See 'test/sanity.tests.ts' for an example.
* The launch.json has been updated to allow debugging of unit tests with the "Launch Tests" configuration.
* The "test" task is now configured so that you can use the "Tasks: Run Test Task" command in VS Code.

* Whitespace is a bit out of control. I've made an executable decision that the repo should have spaces with an indent
size of 4. This is now added to the settings.json.
* The 'out' folder is now excluded in settings.json so you won't see it show up in your directory tree.
* The 'node_modules' folder is now excluded from search. This has been bothering me for awhile.

Author: DustinCampbell

.travis.yml

@@ -10,6 +10,7 @@ os:
 
 install:
 - npm install
+- npm run compile
 - npm install -g vsce
 - vsce package
 

.vscode/launch.json

@@ -11,7 +11,17 @@
             ],
             "stopOnEntry": false,
             "sourceMaps": true,
-            "outDir": "${workspaceRoot}/out"
+            "outDir": "${workspaceRoot}/out/src"
+        },
+        {
+            "name": "Launch Tests",
+            "type": "extensionHost",
+            "request": "launch",
+            "runtimeExecutable": "${execPath}",
+            "args": ["--extensionDevelopmentPath=${workspaceRoot}", "--extensionTestsPath=${workspaceRoot}/out/test" ],
+            "stopOnEntry": false,
+            "sourceMaps": true,
+            "outDir": "${workspaceRoot}/out/test"
         }
     ]
 }

.vscode/settings.json

@@ -1,3 +1,16 @@
 {
+    "editor.tabSize": 4,
+    "editor.insertSpaces": true,
+
+    "files.exclude": {
+        "out": true,
+        "typings": false
+    },
+
+    "search.exclude": {
+        "**/node_modules": true,
+        "out/": true
+    },
+   
     "tslint.rulesDirectory": "node_modules/tslint-microsoft-contrib"
 }

.vscode/tasks.json

@@ -3,6 +3,11 @@
 	"command": "gulp",
 	"isShellCommand": true,
 	"tasks": [
+		{
+			"taskName": "test",
+			"showOutput": "always",
+			"isTestCommand": true
+		},
 		{
 			"taskName": "tslint",
 			"args": [],

.vscodeignore

@@ -1,10 +1,13 @@
-**/*.gitignore
-tsconfig.json
-
+.vscode/**
+typings/**
+out/test/**
+test/**
 src/**
 **/*.map
 
-.vscode/**
+.gitignore
+.travis.yml
+tsconfig.json
 
 **/.nyc_output/**
 **/coverage/**

gulpfile.js

@@ -10,15 +10,16 @@ const path = require('path');
 const del = require('del');
 const gulp = require('gulp');
 const gulpUtil = require('gulp-util');
+const mocha = require('gulp-mocha');
 const tslint = require('gulp-tslint');
 const vsce = require('vsce');
-const debugUtil = require('./out/coreclr-debug/util.js');
-const debugInstall = require('./out/coreclr-debug/install.js');
+const debugUtil = require('./out/src/coreclr-debug/util');
+const debugInstall = require('./out/src/coreclr-debug/install');
 const fs_extra = require('fs-extra-promise');
-const omnisharp = require('./out/omnisharp/omnisharp');
-const download = require('./out/omnisharp/download');
-const logger = require('./out/omnisharp/logger');
-const platform = require('./out/platform');
+const omnisharp = require('./out/src/omnisharp/omnisharp');
+const download = require('./out/src/omnisharp/download');
+const logger = require('./out/src/omnisharp/logger');
+const platform = require('./out/src/platform');
 const child_process = require('child_process');
 
 const Flavor = omnisharp.Flavor;
@@ -154,6 +155,18 @@ gulp.task('package:offline', ['clean'], () => {
     return promise;
 });
 
+/// Test Task
+gulp.task('test', () => {
+    gulp.src('out/test/*.tests.js')
+        .pipe(mocha({ui: "tdd"}))
+        .once('error', () => {
+            process.exit(1);
+        })
+        .once('end', () => {
+            process.exit();
+        });
+});
+
 /// Misc Tasks
 const allTypeScript = [
     'src/**/*.ts',

package.json

@@ -19,7 +19,10 @@
   ],
   "main": "./out/main",
   "scripts": {
-    "postinstall": "node ./node_modules/vscode/bin/install && tsc"
+    "compile": "node ./node_modules/vscode/bin/compile -p ./",
+    "watch": "node ./node_modules/vscode/bin/compile -watch -p ./",
+    "test": "mocha --timeout 15000 -u tdd ./out/test/*.tests.js",
+    "postinstall": "node ./node_modules/vscode/bin/install"
   },
   "dependencies": {
     "decompress": "^4.0.0",
@@ -35,6 +38,7 @@
   },
   "devDependencies": {
     "gulp": "^3.9.1",
+    "gulp-mocha": "^2.1.3",
     "gulp-tslint": "^4.3.0",
     "mocha": "^2.2.5",
     "tslint": "^3.3.0",

test/index.ts

@@ -1,3 +1,8 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
 //
 // PLEASE DO NOT MODIFY / DELETE UNLESS YOU KNOW WHAT YOU ARE DOING
 //

test/sanity.test.ts

@@ -0,0 +1,26 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+//
+// Note: This example test is leveraging the Mocha test framework.
+// Please refer to their documentation on https://mochajs.org/ for help.
+//
+
+// The module 'assert' provides assertion methods from node
+import * as assert from 'assert';
+
+// 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 '../src/main';
+
+suite("Sanity Tests", () => {
+    test("Boolean checks", () => {
+        assert.equal(true, true, "true is not true");
+        assert.notEqual(true, false, "true is false");
+        assert.equal(false, false, "false is not false");
+        assert.notEqual(false, true, "false is true");
+    });
+});