Update Staging for release

.gitignore

@@ -8,6 +8,9 @@ out/
 !locales/**/out/  
 package.nls.*.json
 
+# virtual environment
+venv/
+
 # testing
 .vscode-test 
 

.vscode/settings.json

@@ -8,4 +8,4 @@
     },
     // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
     "typescript.tsc.autoDetect": "off"
-}
+}

ThirdPartyNotices.txt

@@ -5829,6 +5829,26 @@ The above copyright notice and this permission notice shall be included in all c
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 
+uflash
+The MIT License (MIT)
+Copyright (c) 2015-2018 Nicholas H.Tollervey and others.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 -------------------------------------------------------------------
 
 -------------------------------------------------------------------

docs/how-to-use.md

@@ -9,14 +9,14 @@ Commands are accessible through :
 
 - **Open Simulator** : opens the webview of the simulator.
 
-- **New File** : opens an unsaved file with links to help you and a code snippet that you can save as `code.py` / `main.py`.  
+- **New File** : opens an unsaved file to help you and a code snippet that you can save and play around with.  
   _(**Note :** will open the simulator webview if it's not open yet)_.
 
 - **Run Simulator** : runs the code you have opened in the simulator (make sure you've clicked on a valid code file).  
   _(**Note :** will open the simulator webview if it's not open yet)_.
 
-- **Deploy to Device** : saves the code to a Circuit Playground Express.  
-  _(**Note :** the board needs to be correctly formatted to a `CIRCUITPY` drive first. If that's not the case check [Installing CircuitPython](https://learn.adafruit.com/welcome-to-circuitpython/installing-circuitpython) to correctly format it)_.
+- **Deploy to Device** : saves the code to the connected device.  
+  _(**Note :** For the Circuit Playground Express, the board needs to be correctly formatted to a `CIRCUITPY` drive first. If that's not the case check [Installing CircuitPython](https://learn.adafruit.com/welcome-to-circuitpython/installing-circuitpython) to correctly format it)_.
 
 * **Select Serial Port** : selects the serial port of the board you want the serial monitor to interact with. (2)
   _(**Note :** USB detection must be enabled in the extension settings.)_
@@ -82,7 +82,7 @@ Here are the settings you can change in the Device Simulator Express configurati
 - The first time you install the extension, you'll need to execute the `run` command at least once in order to access auto-completion.
 - While running a code file, if you get an error saying it can't find the file, make sure you've clicked on a valid Python code file before running it.
 - To open the output panel again after closing it go to VS Code menu : `View->Output`.
-- If you try to deploy to the device while it's plugged in but you still get an error saying it cannot find the board, make sure your Circuit Playground Express is formatted correctly and that its name matches `CIRCUITPY`.
+- For the Circuit Playground Express, if you try to deploy to the device while it's plugged in but you still get an error saying it cannot find the board, make sure your Circuit Playground Express is formatted correctly and that its name matches `CIRCUITPY`.
 - If you can't get the Simulator communication working while debugging, try to open you `Settings` and check the port used under `'Device Simulator Express: Debugger Server Port'`. You can either change it (usually ports above 5000 could work) or try to free it, then start debugging again.
 
 ### Notes

gulpfile.js

@@ -1,135 +1,141 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-const gulp = require("gulp");
-
-const ts = require("gulp-typescript");
-const sourcemaps = require("gulp-sourcemaps");
-const typescript = require("typescript");
-const del = require("del");
-const es = require("event-stream");
-const vsce = require("vsce");
-const nls = require("vscode-nls-dev");
-
-const tsProject = ts.createProject("./tsconfig.json", { typescript });
-
-const inlineMap = true;
-const inlineSource = false;
-const outDest = "out";
-
-// A list of all locales supported by VSCode can be found here: https://code.visualstudio.com/docs/getstarted/locales
-const languages = [{ folderName: "en", id: "en" }];
-
-gulp.task("clean", () => {
-  return del(
-    [
-      "out/*",
-      "package.nls.*.json",
-      "../../dist/*0.0.0-UNTRACKEDVERSION.vsix"
-    ],
-    { force: true }
-  );
-});
-
-const pythonToMove = [
-  "./src/adafruit_circuitplayground/*.*",
-  "./src/*.py",
-  "./src/requirements.txt",
-];
-
-gulp.task("python-compile", () => {
-  // the base option sets the relative root for the set of files,
-  // preserving the folder structure
-  return gulp.src(pythonToMove, { base: "./src/" }).pipe(gulp.dest("out"));
-});
-
-gulp.task("internal-compile", () => {
-  return compile(false);
-});
-
-gulp.task("internal-nls-compile", () => {
-  return compile(true);
-});
-
-gulp.task("add-locales", () => {
-  return gulp
-    .src(["package.nls.json"])
-    .pipe(nls.createAdditionalLanguageFiles(languages, "locales"))
-    .pipe(gulp.dest("."));
-});
-
-gulp.task("vsce:publish", () => {
-  return vsce.publish();
-});
-
-gulp.task("vsce:package", () => {
-  return vsce.createVSIX({
-    packagePath: "../../dist/deviceSimulatorExpress-0.0.0-UNTRACKEDVERSION.vsix"
-  });
-});
-
-gulp.task(
-  "compile",
-  gulp.series("clean", "internal-compile", "python-compile", callback => {
-    callback();
-  })
-);
-
-gulp.task(
-  "build",
-  gulp.series(
-    "clean",
-    "internal-nls-compile",
-    "python-compile",
-    "add-locales",
-    callback => {
-      callback();
-    }
-  )
-);
-
-gulp.task(
-  "publish",
-  gulp.series("compile", "vsce:publish", callback => {
-    callback();
-  })
-);
-
-gulp.task(
-  "package",
-  gulp.series("compile", "vsce:package", callback => {
-    callback();
-  })
-);
-
-//---- internal
-
-function compile(buildNls) {
-  var r = tsProject
-    .src()
-    .pipe(sourcemaps.init())
-    .pipe(tsProject())
-    .js.pipe(buildNls ? nls.rewriteLocalizeCalls() : es.through())
-    .pipe(
-      buildNls
-        ? nls.createAdditionalLanguageFiles(languages, "locales", "out")
-        : es.through()
-    );
-
-  if (inlineMap && inlineSource) {
-    r = r.pipe(sourcemaps.write());
-  } else {
-    r = r.pipe(
-      sourcemaps.write("../out", {
-        // no inlined source
-        includeContent: inlineSource,
-        // Return relative source map root directories per file.
-        sourceRoot: "../src"
-      })
-    );
-  }
-
-  return r.pipe(gulp.dest(outDest));
-}
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+const gulp = require("gulp");
+
+const ts = require("gulp-typescript");
+const sourcemaps = require("gulp-sourcemaps");
+const typescript = require("typescript");
+const del = require("del");
+const es = require("event-stream");
+const vsce = require("vsce");
+const nls = require("vscode-nls-dev");
+
+const tsProject = ts.createProject("./tsconfig.json", { typescript });
+
+const inlineMap = true;
+const inlineSource = false;
+const outDest = "out";
+
+// A list of all locales supported by VSCode can be found here: https://code.visualstudio.com/docs/getstarted/locales
+const languages = [{ folderName: "en", id: "en" }];
+
+gulp.task("clean", () => {
+  return del(
+    [
+      "out/*",
+      "package.nls.*.json",
+      "../../dist/*0.0.0-UNTRACKEDVERSION.vsix",
+    ],
+    { force: true }
+  );
+});
+
+const pythonToMove = [
+  "./src/adafruit_circuitplayground/*.*",
+  "./src/microbit/*.*",
+  "./src/microbit/!(test)/**/*",
+  "./src/*.py",
+  "./src/common/*.py",
+  "./src/dev-requirements.txt",
+  "./src/requirements.txt",
+  "./src/templates/*.*"
+];
+
+gulp.task("python-compile", () => {
+  // the base option sets the relative root for the set of files,
+  // preserving the folder structure
+  return gulp.src(pythonToMove, { base: "./src/" }).pipe(gulp.dest("out"));
+});
+
+gulp.task("internal-compile", () => {
+  return compile(false);
+});
+
+gulp.task("internal-nls-compile", () => {
+  return compile(true);
+});
+
+gulp.task("add-locales", () => {
+  return gulp
+    .src(["package.nls.json"])
+    .pipe(nls.createAdditionalLanguageFiles(languages, "locales"))
+    .pipe(gulp.dest("."));
+});
+
+gulp.task("vsce:publish", () => {
+  return vsce.publish();
+});
+
+gulp.task("vsce:package", () => {
+  return vsce.createVSIX({
+    packagePath:
+      "../../dist/deviceSimulatorExpress-0.0.0-UNTRACKEDVERSION.vsix",
+  });
+});
+
+gulp.task(
+  "compile",
+  gulp.series("clean", "internal-compile", "python-compile", callback => {
+    callback();
+  })
+);
+
+gulp.task(
+  "build",
+  gulp.series(
+    "clean",
+    "internal-nls-compile",
+    "python-compile",
+    "add-locales",
+    callback => {
+      callback();
+    }
+  )
+);
+
+gulp.task(
+  "publish",
+  gulp.series("compile", "vsce:publish", callback => {
+    callback();
+  })
+);
+
+gulp.task(
+  "package",
+  gulp.series("compile", "vsce:package", callback => {
+    callback();
+  })
+);
+
+//---- internal
+
+function compile(buildNls) {
+  var r = tsProject
+    .src()
+    .pipe(sourcemaps.init())
+    .pipe(tsProject())
+    .js.pipe(buildNls ? nls.rewriteLocalizeCalls() : es.through())
+    .pipe(
+      buildNls
+        ? nls.createAdditionalLanguageFiles(languages, "locales", "out")
+        : es.through()
+    );
+
+  if (inlineMap && inlineSource) {
+    r = r.pipe(sourcemaps.write());
+  } else {
+    r = r.pipe(
+      sourcemaps.write("../out", {
+        // no inlined source
+        includeContent: inlineSource,
+        // Return relative source map root directories per file.
+        sourceRoot: "../src",
+      })
+    );
+  }
+
+  return r.pipe(gulp.dest(outDest));
+}

locales/en/out/constants.i18n.json

@@ -12,10 +12,6 @@
   "dialogResponses.readInstall": "Read installation docs",
   "error.debuggerServerInitFailed": "Warning : The Debugger Server cannot be opened. Please try to free the port {0} if it's already in use or select another one in your Settings 'Device Simulator Express: Debugger Server Port' and start another debug session.\n You can still debug your code but you won't be able to use the Simulator.",
   "error.debuggingSessionInProgress": "[ERROR] A debugging session is currently in progress, please stop it before running your code. \n",
-  "error.incorrectFileNameForDevice": "[ERROR] Can\\'t deploy to your Circuit Playground Express device, please rename your file to \"code.py\" or \"main.py\". \n",
-  "error.incorrectFileNameForDevicePopup": "Seems like you have a different file name than what the CPX requires, please rename it to \"code.py\" or \"main.py\".",
-  "error.incorrectFileNameForSimulatorPopup": "We want your code to work on your actual board as well. Make sure you name your file \"code.py\" or \"main.py\" to be able to run your code on an actual physical device.",
-  "error.invalidFileNameDebug": "The file you tried to debug isn\\'t named \"code.py\" or \"main.py\\. Rename your file if you want your code to work on your actual device.",
   "error.noDevice": "No plugged in boards detected. Please double check if your board is connected and/or properly formatted",
   "error.noFileToRun": "\n[ERROR] We can't find the .py file to run on simulator. Open up a new .py file, or browse through some examples\n",
   "error.noFolderCreated": "In order to use the Serial Monitor, you need to open a folder and reload VS Code.",
@@ -27,7 +23,7 @@
   "info.deploySimulator": "\n[INFO] Deploying code to the simulator...\n",
   "info.deploySuccess": "\n[INFO] Code successfully deployed\n",
   "info.extensionActivated": "Congratulations, your extension Adafruit_Simulator is now active!",
-  "info.firstTimeWebview": "To reopen the simulator click on the \"Open Simulator\" button on the upper right corner of the text editor, or select the command \"Open Simulator\" from command palette.",
+  "info.firstTimeWebview": "To reopen the simulator select the command \"Open Simulator\" from command palette.",
   "info.installPythonDependencies": "Do you want us to try and install this extensions dependencies for you?",
   "error.invalidFileExtensionDebug": "The file you tried to run isn\\'t a Python file.",
   "info.newFile": "New to Python or the Circuit Playground Express? We are here to help!",
@@ -36,7 +32,7 @@
   "info.privacyStatement": "Privacy Statement",
   "info.successfulInstall": "Successfully installed Python dependencies.",
   "info.thirdPartyWebsite": "By clicking \"Agree and Proceed\" you will be redirected to adafruit.com, a third party website not managed by Microsoft. Please note that your activity on adafruit.com is subject to Adafruit's privacy policy",
-  "info.welcomeOutputTab": "Welcome to the Adafruit Simulator output tab!\n\n",
+  "info.welcomeOutputTab": "Welcome to the Device Simulator Express output tab!\n\n",
   "label.webviewPanel": "Device Simulator Express",
   "name": "Device Simulator Express",