Merge pull request #1 from Microsoft/yaohai_dev

Initialize VSCode extension for Arduino.

Author: yaohaizh

.editorconfig

@@ -0,0 +1,14 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Tab indentation
+[*]
+indent_style = space
+indent_size = 4
+
+# The indent size used in the `package.json` file cannot be changed
+# https://github.com/npm/npm/pull/3180#issuecomment-16336516
+[{.travis.yml,npm-shrinkwrap.json,package.json}]
+indent_size = 2

.gitignore

@@ -0,0 +1,3 @@
+out
+node_modules
+.vscode-test

.vscode/launch.json

@@ -0,0 +1,28 @@
+// A launch configuration that compiles the extension and then opens it inside a new window
+{
+    "version": "0.1.0",
+    "configurations": [
+        {
+            "name": "Launch Extension",
+            "type": "extensionHost",
+            "request": "launch",
+            "runtimeExecutable": "${execPath}",
+            "args": ["--extensionDevelopmentPath=${workspaceRoot}" ],
+            "stopOnEntry": false,
+            "sourceMaps": true,
+            "outFiles": [ "${workspaceRoot}/out/src/**/*.js" ],
+            "preLaunchTask": "npm"
+        },
+        {
+            "name": "Launch Tests",
+            "type": "extensionHost",
+            "request": "launch",
+            "runtimeExecutable": "${execPath}",
+            "args": ["--extensionDevelopmentPath=${workspaceRoot}", "--extensionTestsPath=${workspaceRoot}/out/test" ],
+            "stopOnEntry": false,
+            "sourceMaps": true,
+            "outFiles": [ "${workspaceRoot}/out/test/**/*.js" ],
+            "preLaunchTask": "npm"
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,10 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+    "files.exclude": {
+        "out": false // set this to true to hide the "out" folder with the compiled JS files
+    },
+    "search.exclude": {
+        "out": true // set this to false to include "out" folder in search results
+    },
+    "typescript.tsdk": "./node_modules/typescript/lib" // we want to use the TS server from our node_modules folder to control its version
+}

.vscode/tasks.json

@@ -0,0 +1,30 @@
+// Available variables which can be used inside of strings.
+// ${workspaceRoot}: the root folder of the team
+// ${file}: the current opened file
+// ${fileBasename}: the current opened file's basename
+// ${fileDirname}: the current opened file's dirname
+// ${fileExtname}: the current opened file's extension
+// ${cwd}: the current working directory of the spawned process
+
+// A task runner that calls a custom npm script that compiles the extension.
+{
+    "version": "0.1.0",
+
+    // we want to run npm
+    "command": "npm",
+
+    // the command is a shell script
+    "isShellCommand": true,
+
+    // show the output window only if unrecognized errors occur.
+    "showOutput": "silent",
+
+    // we run the custom script "compile" as defined in package.json
+    "args": ["run", "compile", "--loglevel", "silent"],
+
+    // The tsc compiler is started in watching mode
+    "isWatching": true,
+
+    // use the standard tsc in watch mode problem matcher to find compile problems in the output.
+    "problemMatcher": "$tsc-watch"
+}

.vscodeignore

@@ -0,0 +1,8 @@
+.vscode/**
+.vscode-test/**
+out/test/**
+test/**
+src/**
+**/*.map
+.gitignore
+tsconfig.json

CHANGELOG.md

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

README.md

@@ -0,0 +1 @@
+# Visual Studio Code Extension for Arduino

gulpfile.js

@@ -0,0 +1,8 @@
+const gulp = require('gulp');
+const tslint = require('gulp-tslint');
+//...
+gulp.task('tslint', () => {
+    return gulp.src(['**/*.ts', '!**/*.d.ts', '!node_modules/**'])
+        .pipe(tslint())
+        .pipe(tslint.report());
+});

package.json

@@ -0,0 +1,58 @@
+{
+  "name": "vscode-arduino",
+  "displayName": "vscode-arduino",
+  "description": "Visual Studio Code Extension for Arduino",
+  "version": "0.0.1",
+  "publisher": "Microsoft",
+  "engines": {
+    "vscode": "^1.5.0"
+  },
+  "categories": [
+    "Languages",
+    "Snippets"
+  ],
+  "activationEvents": [
+    "onCommand:extension.verifyArduino",
+    "onCommand:extension.uploadArduino"
+  ],
+  "main": "./out/src/extension",
+  "contributes": {
+    "commands": [
+      {
+        "command": "extension.verifyArduino",
+        "title": "Arduino: verfiy"
+      },
+      {
+        "command": "extension.uploadArduino",
+        "title": "Arduino: upload"
+      }
+    ],
+    "configuration": {
+      "type": "object",
+      "title": "Arduino configuration",
+      "properties": {
+        "arduino.path": {
+          "type": "string",
+          "default": "arduino",
+          "description": "Path to Arduino, you can use a custom version of Arduino by modifying this setting to include the full path."
+        }
+      }
+    }
+  },
+  "scripts": {
+    "vscode:prepublish": "tsc -p ./",
+    "compile": "tsc -watch -p ./",
+    "postinstall": "node ./node_modules/vscode/bin/install",
+    "test": "node ./node_modules/vscode/bin/test"
+  },
+  "devDependencies": {
+    "@types/mocha": "^2.2.32",
+    "@types/node": "^6.0.40",
+    "gulp": "^3.9.1",
+    "gulp-tslint": "^7.0.1",
+    "mocha": "^2.3.3",
+    "tslint": "^4.2.0",
+    "typescript": "^2.0.3",
+    "vscode": "^1.0.0"
+  }
+}

src/arduino/arduino.ts

@@ -0,0 +1,14 @@
+'use strict';
+
+import vscode = require('vscode');
+import settings = require('./settings');
+
+export function verify(arduinoConfig: settings.IArduinoSettings) {
+    vscode.window.showInformationMessage(arduinoConfig.arduinoPath);
+    return 'verify';
+}
+
+export function upload(arduinoConfig: settings.IArduinoSettings) {
+    vscode.window.showInformationMessage(arduinoConfig.arduinoPath);
+    return 'upload';
+}

src/arduino/settings.ts

@@ -0,0 +1,62 @@
+'use strict';
+
+import * as vscode from 'vscode';
+import * as path from 'path';
+import * as fsHelper from '../helper/fsHelper';
+
+export const IS_WINDOWS = /^win/.test(process.platform);
+
+export interface IArduinoSettings {
+    arduinoPath: string;
+}
+
+export class ArduinoSettings implements IArduinoSettings {
+    private static arduinoSettings: ArduinoSettings = new ArduinoSettings();
+    constructor() {
+        this.initializeSettings();
+    }
+
+    public static getIntance(): ArduinoSettings {
+        return ArduinoSettings.arduinoSettings;
+    }
+
+    private initializeSettings() {
+        let arduinoConfig = vscode.workspace.getConfiguration('arduino');
+        this.arduinoPath = arduinoConfig.get<string>('arduinoPath');
+    }
+
+    private _arduinoPath: string;
+
+    public get arduinoPath(): string {
+        return this._arduinoPath;
+    }
+
+    public set arduinoPath(value: string) {
+        if (this._arduinoPath === value) {
+            return;
+        }
+        try {
+            this._arduinoPath = getArduinoExecutable(value);
+        }
+        catch (ex) {
+            this._arduinoPath = value;
+        }
+    }
+}
+
+function getArduinoExecutable(arduinoPath: string): string {
+    if (arduinoPath === 'arduino' || fsHelper.fileExists(arduinoPath)) {
+        return arduinoPath;
+    }
+
+    if (IS_WINDOWS) {
+        if (fsHelper.fileExists(path.join(arduinoPath, 'arduino.exe'))) {
+            return path.join(arduinoPath, 'arduino.exe');
+        }
+    } else {
+        if (fsHelper.fileExists(path.join(arduinoPath, 'arduino'))) {
+            return path.join(arduinoPath, 'arduino');
+        }
+    }
+    return arduinoPath;
+}

src/extension.ts

@@ -0,0 +1,24 @@
+'use strict';
+
+import vscode = require('vscode');
+import * as settings from './arduino/settings';
+import { verify, upload } from './arduino/arduino'; 
+
+// this method is called when your extension is activated
+// your extension is activated the very first time the command is executed
+export function activate(context: vscode.ExtensionContext) {
+
+    let arduinoSettings = settings.ArduinoSettings.getIntance();
+
+    vscode.commands.registerCommand('extension.verifyArduino', () => {
+        return verify(arduinoSettings);
+    });
+
+    vscode.commands.registerCommand('extension.uploadArduino', () => {
+        return upload(arduinoSettings);
+    });
+}
+
+// this method is called when your extension is deactivated
+export function deactivate() {
+}

src/helper/fsHelper.ts

@@ -0,0 +1,11 @@
+'use strict';
+
+import fs = require('fs');
+
+export function fileExists(filePath: string): boolean {
+	try {
+		return fs.statSync(filePath).isFile();
+	} catch (e) {
+		return false;
+	}
+}

test/extension.test.ts

@@ -0,0 +1,22 @@
+//
+// Note: This example test is leveraging the Mocha test framework.
+// Please refer to their documentation on https://mochajs.org/ for help.
+//
+import * as assert from 'assert';
+import * as vscode from 'vscode';
+
+// Defines a Mocha test suite to group tests of similar kind together
+suite("Arduino Extension Tests", () => {
+
+    test('Verify command', (done) => {
+        vscode.commands.executeCommand('extension.verifyArduino')
+            .then(result => assert(result === 'verify', 'Failed to verify Arduino app'))
+            .then(done, done);
+    });
+
+    test('Upload Arduino command', (done) => {
+        vscode.commands.executeCommand('extension.uploadArduino')
+            .then(result => assert(result === 'upload', 'Failed to upload arduino app'))
+            .then(done, done);
+    });
+});

test/index.ts

@@ -0,0 +1,22 @@
+//
+// PLEASE DO NOT MODIFY / DELETE UNLESS YOU KNOW WHAT YOU ARE DOING
+//
+// This file is providing the test runner to use when running extension tests.
+// By default the test runner in use is Mocha based.
+//
+// You can provide your own test runner if you want to override it by exporting
+// a function run(testRoot: string, clb: (error:Error) => void) that the extension
+// host can call to run the tests. The test runner is expected to use console.log
+// to report the results back to the caller. When the tests are finished, return
+// a possible error to the callback or null if none.
+
+var testRunner = require('vscode/lib/testrunner');
+
+// You can directly control Mocha options by uncommenting the following lines
+// See https://github.com/mochajs/mocha/wiki/Using-mocha-programmatically#set-options for more info
+testRunner.configure({
+    ui: 'tdd', 		// the TDD UI is being used in extension.test.ts (suite, test, etc.)
+    useColors: true // colored output from test results
+});
+
+module.exports = testRunner;

tsconfig.json

@@ -0,0 +1,16 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "target": "es6",
+        "outDir": "out",
+        "lib": [
+            "es6"
+        ],
+        "sourceMap": true,
+        "rootDir": "."
+    },
+    "exclude": [
+        "node_modules",
+        ".vscode-test"
+    ]
+}

tslint.json

@@ -0,0 +1,12 @@
+{
+    "rules": {
+        "no-unused-expression": true,
+        "no-duplicate-variable": true,
+        "curly": true,
+        "class-name": true,
+        "semicolon": [
+            "always"
+        ],
+        "triple-equals": true
+    }
+}