Merge pull request #1 from Microsoft/master

merge latest code

Author: v-czg

.editorconfig

@@ -1,14 +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
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Tab indentation
+[*]
+indent_style = space
+indent_size = 2
+
+# 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

@@ -3,4 +3,4 @@ out
 node_modules
 .vscode-test
 .idea
-html/app/sprites-generated
+src/views/app/sprites-generated

CHANGELOG.md

@@ -1,6 +1,45 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## Version 0.1.3
+- Release date: May 12, 2017
+
+### Added
+- Support auto-discovery of AZ3166 board
+
+### Changed
+- Make activation condition to activate always for keeping USB auto-detection work background
+- Auto-resolve arduino path from Registry on windows
+- Well handle the case when vscode has no workspace
+
+### Fixed
+- Fix the issue of HTML view showing weird background color in vscode 1.12.1
+- Fix arduino board installation failure on Mac after usb detection
+
+
+## Version 0.1.2
+- Release date: April 28, 2017
+
+### Added
+- Support manually imported library in libraries manager
+- Support 3rd-party boards
+- Add more devices (Arduino M0 Pro/Arduino Yún/Arduino Due) for auto discovery
+- Add native binaries version for electron 1.6.6 to unblock VSCode's future upgrade
+- Scaffold an empty sketch under current workspace folder
+
+### Changed
+- Make the arduino.json configurable through UI
+- Refine extension activation events
+- Restore previous active serial monitor after upload is completed
+- Auto-resolve the sketch file path when the file is not existing for verify/upload
+- Search custom libraries and examples in the path of sketchbook.path preference rather than default windows Document path
+
+### Fixed
+- Fix preferences.txt not found issue
+- Fix verify command NPE issue when no serial port is selected
+- Fix the error handling issue when opening serial monitor failed
+- Avoid verify/upload reentry issue
+
 ## Version 0.1.1
 - HotFix: Update display tag. 
 

README.md

@@ -15,6 +15,8 @@ Welcome to **Arduino** <sup>preview</sup> for Visual Studio Code! The Arduino ex
 
 ## Prerequisites
 Arduino IDE is required. Please install it from [here](https://www.arduino.cc/en/main/software#download).
+- The supported Arduino IDE versions are 1.6.x and later.
+- The Windows Store's version of Arduino IDE is not supported because of the sandbox environment of Windows app.
 
 ## Installation
 Open VS Code and press `F1` or `Ctrl + Shift + P` to open command palette, select **Install Extension** and type `vscode-arduino`.
@@ -35,7 +37,7 @@ This extension provides several commands in the Command Palette (**F1** or **Ctr
 - **Arduino: Initialize**：Scaffold a VS Code project with an Arduino sketch.
 - **Arduino: Libraries Manager**: Explore and manage libraries.
 - **Arduino: Open Serial Monitor**: Open serial monitor in the intergrated output window.
-- **Arduino: Select Serial Port**: Change the current serial port. 
+- **Arduino: Select Serial Port**: Change the current serial port.
 - **Arduino: Send Text to Serial Port**: Send a line of text via the current serial port.
 - **Arduino: Upload**: Build sketch and upload to Arduino board.
 - **Arduino: Verify**: Build sketch.
@@ -62,6 +64,7 @@ Currently this extension supports the following operatings systems:
 - Windows 7 and later (32-bit and 64-bit)
 - macOS 10.10 and later
 - Ubuntu 16.04
+  - The extension might work on other Linux distro as some user reported but without gurantee.
 
 ## Contact Us
 If you'd like to help us build the best Arduino experience with VS Code, you can talk directly to the product team in our [gitter chat room](https://gitter.im/Microsoft/vscode-arduino).

gulpfile.js

@@ -1,4 +1,5 @@
 const gulp = require("gulp");
+const eslint = require('gulp-eslint');
 const tslint = require("gulp-tslint");
 const gutil = require("gulp-util");
 const ts = require("gulp-typescript");
@@ -13,14 +14,21 @@ const childProcess = require("child_process");
 
 //...
 gulp.task("tslint", () => {
-    return gulp.src(["**/*.ts", "**/*.tsx", "!**/*.d.ts", "!node_modules/**", "!./html/node_modules/**"])
+    return gulp.src(["**/*.ts", "**/*.tsx", "!**/*.d.ts", "!node_modules/**", "!./src/views/node_modules/**"])
         .pipe(tslint())
         .pipe(tslint.report());
 });
 
+gulp.task("eslint", () => {
+    return gulp.src(["./vendor/**/*.js", "!**/node_modules/**"])
+        .pipe(eslint())
+        .pipe(eslint.format())
+        .pipe(eslint.failAfterError());
+});
+
 gulp.task("html-webpack", (done) => {
-    const config = require("./html/webpack.config.js");
-    config.context = `${__dirname}/html`;
+    const config = require("./src/views/webpack.config.js");
+    config.context = `${__dirname}/src/views`;
     return webpack(config, (err, stats) => {
         const statsJson = stats.toJson();
         if (err || (statsJson.errors && statsJson.errors.length)) {
@@ -83,7 +91,7 @@ gulp.task("test", (done) => {
     }
 
     // When using cli command "npm test" to exec test, the depended extensions (cpptools) are not available so that
-    // the extension cannot be activated. As a workaround, remove extensionDependencies from package.json before running test 
+    // the extension cannot be activated. As a workaround, remove extensionDependencies from package.json before running test
     // and restore extensionDependencies after test exited.
     removeExtensionDependencies();
 
@@ -119,6 +127,6 @@ gulp.task("build", (done) => {
 });
 
 gulp.task("watch", () => {
-    gulp.watch(["./src/**/*", "./test/**/*"], ["ts-compile"]);
-    gulp.watch(["./html/**/*", "!./html/node_modules/**"], ["html-webpack"]);
+    gulp.watch(["./src/**/*", "./test/**/*", "!./src/views/**/*"], ["ts-compile"]);
+    gulp.watch(["./src/views/**/*", "!./src/views/node_modules/**"], ["html-webpack"]);
 });

misc/usbmapping.json

@@ -63,4 +63,14 @@
         "architecture": "samd",
         "id": "adafruit_feather_m0"
     }]
+}, {
+    "index_file": "https://raw.githubusercontent.com/VSChina/azureiotdevkit_tools/master/package_azureboard_index.json",
+    "boards": [{
+        "vid": "0483",
+        "pid": "374b",
+        "name": "MXCHIP AZ3166",
+        "package": "AZ3166",
+        "architecture": "stm32f4",
+        "id": "MXCHIP_AZ3166"
+    }]
 }]

package.json

@@ -2,7 +2,7 @@
   "name": "vscode-arduino",
   "displayName": "Arduino",
   "description": "Arduino for Visual Studio Code",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "publisher": "vsciot-vscode",
   "aiKey": "83dd2c27-6594-41d3-85a9-bdb22070eb42",
   "preview": true,
@@ -23,17 +23,7 @@
     "C++"
   ],
   "activationEvents": [
-    "onLanguage:c",
-    "onLanguage:cpp",
-    "workspaceContains:.vscode/arduino.json",
-    "onCommand:arduino.initialize",
-    "onCommand:arduino.verify",
-    "onCommand:arduino.upload",
-    "onCommand:arduino.selectSerialPort",
-    "onCommand:arduino.changeBoardType",
-    "onCommand:arduino.showBoardManager",
-    "onCommand:arduino.showLibraryManager",
-    "onCommand:arduino.showExamples"
+    "*"
   ],
   "main": "./out/src/extension",
   "contributes": {
@@ -177,7 +167,7 @@
   },
   "scripts": {
     "vscode:prepublish": "gulp build",
-    "postinstall": "node ./node_modules/vscode/bin/install && cd ./html && npm install",
+    "postinstall": "node ./node_modules/vscode/bin/install && cd ./src/views && npm install",
     "test": "gulp test"
   },
   "extensionDependencies": [
@@ -188,7 +178,15 @@
     "@types/node": "^6.0.40",
     "@types/winreg": "^1.2.30",
     "del": "^2.2.2",
+    "eslint": "^3.19.0",
+    "eslint-config-standard": "^10.2.1",
+    "eslint-plugin-import": "^2.2.0",
+    "eslint-plugin-node": "^4.2.2",
+    "eslint-plugin-promise": "^3.5.0",
+    "eslint-plugin-require-path-exists": "^1.1.7",
+    "eslint-plugin-standard": "^3.0.1",
     "gulp": "^3.9.1",
+    "gulp-eslint": "^3.0.1",
     "gulp-sourcemaps": "^2.4.1",
     "gulp-tslint": "^7.0.1",
     "gulp-typescript": "^3.1.5",

src/arduino/arduino.ts

@@ -12,12 +12,13 @@ import * as vscode from "vscode";
 import * as constants from "../common/constants";
 import * as util from "../common/util";
 import * as Logger from "../logger/logger";
-import * as settings from "./settings";
 
 import { DeviceContext, IDeviceContext } from "../deviceContext";
+import { IArduinoSettings } from "./arduinoSettings";
 import { BoardManager } from "./boardManager";
 import { ExampleManager } from "./exampleManager";
 import { LibraryManager } from "./libraryManager";
+import { VscodeSettings } from "./vscodeSettings";
 
 import { arduinoChannel } from "../common/outputChannel";
 import { SerialMonitor } from "../serialmonitor/serialMonitor";
@@ -27,8 +28,6 @@ import { SerialMonitor } from "../serialmonitor/serialMonitor";
  */
 export class ArduinoApp {
 
-    private _preferences: Map<string, string>;
-
     private _boardManager: BoardManager;
 
     private _libraryManager: LibraryManager;
@@ -38,18 +37,19 @@ export class ArduinoApp {
     /**
      * @param {IArduinoSettings} ArduinoSetting object.
      */
-    constructor(private _settings: settings.IArduinoSettings) {
+    constructor(private _settings: IArduinoSettings) {
     }
 
     /**
      * Need refresh Arduino IDE's setting when starting up.
      * @param {boolean} force - Whether force initialzie the arduino
      */
     public async initialize(force: boolean = false) {
-        if (!util.fileExistsSync(path.join(this._settings.packagePath, "preferences.txt"))) {
+        if (!util.fileExistsSync(this._settings.preferencePath)) {
             try {
                 // Use empty pref value to initialize preference.txt file
                 await this.setPref("boardsmanager.additional.urls", "");
+                this._settings.loadPreferences(); // reload preferences.
             } catch (ex) {
             }
         }
@@ -96,6 +96,12 @@ export class ArduinoApp {
         if (!boardDescriptor) {
             return;
         }
+
+        if (!vscode.workspace.rootPath) {
+            vscode.window.showWarningMessage("Cannot find the sketch file.");
+            return;
+        }
+
         if (!dc.sketch || !util.fileExistsSync(path.join(vscode.workspace.rootPath, dc.sketch))) {
             await this.getMainSketch(dc);
         }
@@ -114,7 +120,7 @@ export class ArduinoApp {
 
         const appPath = path.join(vscode.workspace.rootPath, dc.sketch);
         const args = ["--upload", "--board", boardDescriptor, "--port", dc.port, appPath];
-        if (this._settings.logLevel === "verbose") {
+        if (VscodeSettings.getIntance().logLevel === "verbose") {
             args.push("--verbose");
         }
         await util.spawn(this._settings.commandPath, arduinoChannel.channel, args).then(async (result) => {
@@ -134,6 +140,11 @@ export class ArduinoApp {
             return;
         }
 
+        if (!vscode.workspace.rootPath) {
+            vscode.window.showWarningMessage("Cannot find the sketch file.");
+            return;
+        }
+
         if (!dc.sketch || !util.fileExistsSync(path.join(vscode.workspace.rootPath, dc.sketch))) {
             await this.getMainSketch(dc);
         }
@@ -143,7 +154,7 @@ export class ArduinoApp {
         arduinoChannel.start(`Verify sketch - ${dc.sketch}`);
         const appPath = path.join(vscode.workspace.rootPath, dc.sketch);
         const args = ["--verify", "--board", boardDescriptor, appPath];
-        if (this._settings.logLevel === "verbose") {
+        if (VscodeSettings.getIntance().logLevel === "verbose") {
             args.push("--verbose");
         }
         arduinoChannel.show();
@@ -162,7 +173,9 @@ export class ArduinoApp {
         } else {
             libPaths = this.getDefaultPackageLibPaths();
         }
-
+        if (!vscode.workspace.rootPath) {
+            return;
+        }
         const configFilePath = path.join(vscode.workspace.rootPath, constants.CPP_CONFIG_FILE);
         let deviceContext = null;
         if (!util.fileExistsSync(configFilePath)) {
@@ -213,6 +226,9 @@ export class ArduinoApp {
 
     // Include the *.h header files from selected library to the arduino sketch.
     public async includeLibrary(libraryPath: string) {
+        if (!vscode.workspace.rootPath) {
+            return;
+        }
         const dc = DeviceContext.getIntance();
         const appPath = path.join(vscode.workspace.rootPath, dc.sketch);
         if (util.fileExistsSync(appPath)) {
@@ -350,7 +366,7 @@ export class ArduinoApp {
         }
 
         // Step 1: Copy the example project to a temporary directory.
-        const sketchPath = this.preferences.get("sketchbook.path") || path.dirname(this._settings.libPath);
+        const sketchPath = path.join(this._settings.sketchbookPath, "generated_examples");
         if (!util.directoryExistsSync(sketchPath)) {
             util.mkdirRecursivelySync(sketchPath);
         }
@@ -404,13 +420,6 @@ export class ArduinoApp {
         return destExample;
     }
 
-    public get preferences() {
-        if (!this._preferences) {
-            this.loadPreferences();
-        }
-        return this._preferences;
-    }
-
     public get settings() {
         return this._settings;
     }
@@ -439,22 +448,6 @@ export class ArduinoApp {
         this._exampleManager = value;
     }
 
-    private loadPreferences() {
-        this._preferences = new Map<string, string>();
-        const lineRegex = /(\S+)=(\S+)/;
-
-        const rawText = fs.readFileSync(path.join(this._settings.packagePath, "preferences.txt"), "utf8");
-        const lines = rawText.split("\n");
-        lines.forEach((line) => {
-            if (line) {
-                const match = lineRegex.exec(line);
-                if (match && match.length > 2) {
-                    this._preferences.set(match[1], match[2]);
-                }
-            }
-        });
-    }
-
     private getBoardBuildString(deviceContext: IDeviceContext): string {
         const selectedBoard = this.boardManager.currentBoard;
         if (!selectedBoard) {