Merge branch 'main' of https://github.com/microsoft/vscode-arduino into dev/gcampbell/UpdateSerialMonitor2.0

Author: gcampbell-msft

.github/workflows/build.yml

@@ -72,12 +72,12 @@ jobs:
       - name: Check for linting errors
         run: gulp tslint
       - name: Build and pack extension
-        run: vsce package --out vscode-arduino.vsix
+        run: node build/package.js
       - name: Publish extension VSIX as artifact
         uses: actions/upload-artifact@v2
         with:
-          name: VS Code extension VSIX (${{ matrix.os }})
-          path: vscode-arduino.vsix
+          name: VS Code extension VSIXes (${{ matrix.os }})
+          path: out/vsix
 
       - name: Run tests
         uses: GabrielBB/xvfb-action@v1

.gitignore

@@ -6,3 +6,4 @@ node_modules
 src/views/app/sprites-generated
 test/**/c_cpp_properties.json
 *.vsix
+assets/platform/*/arduino-cli

.vscodeignore

@@ -17,4 +17,8 @@ webpack.config.js
 node_modules/**
 vendor/**
 azure-pipelines.yml
-build/**
+build/**
+assets/platform/**
+
+# A platform-specific directory in assets/platform/ will be added to the end of
+# this file by the packaging script.

NOTICE_arduino-cli.txt

@@ -0,0 +1,16 @@
+NOTICES AND INFORMATION
+Do Not Translate or Localize
+
+Microsoft makes the arduino-cli open source code available at
+https://3rdpartysource.microsoft.com, or you may send a check or money order for
+US $5.00, including the product name, the open source component name, platform,
+and version number, to:
+
+Source Code Compliance Team
+Microsoft Corporation
+One Microsoft Way
+Redmond, WA 98052
+USA
+
+Notwithstanding any other terms, you may reverse engineer this software to the extent
+required to debug changes to any libraries licensed under the GNU Lesser General Public License.

README.md

@@ -15,19 +15,31 @@ Welcome to the Visual Studio Code extension for **Arduino** <sup>preview</sup> !
 * Integrated Arduino Debugging <sup>New</sup>
 
 ## Prerequisites
-Either the Arduino IDE or Arduino CLI are required.
+Either the legacy Arduino IDE or Arduino CLI are required. The recommended
+approach is to use the version of Arduino CLI that comes bundled with the
+extension, which works out of the box. Support for the legacy Arduino IDE will
+be removed in a future version of the extension.
 
-### Arduino IDE
-The Arduino IDE can be installed the Arduino [download page](https://www.arduino.cc/en/main/software#download).
-- The supported Arduino IDE versions are `1.6.x` and up to, but not including, 2.0.0.
+### Arduino CLI
+To use the bundled version of Arduino CLI, `arduino.useArduinoCli` should be `true`,
+and `arduino.path` and `arduino.commandPath` should be empty or unset.
+`arduino.useArduinoCli` defaults to `false` while we deprecate support for the
+Arduino IDE, but there will be a prompt when the extension first activates to
+switch to the Arduino CLI.
+
+If you want to use a custom version of Arduino CLI, it can be downloaded from
+the repository's [release page](https://github.com/arduino/arduino-cli/releases/).
+For custom versions, `arduino.path` must be set to the directory containing the
+Arduino CLI executable.
+
+### Legacy Arduino IDE
+Use of the legacy Arduino IDE is not recommended, and support for the legacy
+Arduino IDE will be removed in a future version of the extension. The legacy
+Arduino IDE can be installed from the Arduino [download page](https://www.arduino.cc/en/main/software#download).
+- The supported legacy Arduino IDE versions are `1.6.x` and up to, but not including, `2.0.0`.
 - The Windows Store's version of the Arduino IDE is not supported because of the sandbox environment that the application runs in.
 - *Note:* Arduino IDE `1.8.7` had some breaking changes, causing board package and library installation failures.  These failures were corrected in `1.8.8` and later.
-- *Note:* Arduino IDE `2.X.Y` is not supported at this time [issue 1477](https://github.com/microsoft/vscode-arduino/issues/1477)
-
-### Arduino CLI
-The Arduino CLI can be downloaded from the repository's [release page](https://github.com/arduino/arduino-cli/releases/tag/0.13.0)
-- The extension has only been tested with v0.13.0.
-- If you use the CLI you will have to set `arduino.path` since the CLI does not have a default path.
+- *Note:* Arduino IDE `2.X.Y` is not supported and there are no plans for support in the future ([issue 1477](https://github.com/microsoft/vscode-arduino/issues/1477)).
 
 ## Installation
 Open VS Code and press <kbd>F1</kbd> or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> *or* <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> to open command palette, select **Install Extension** and type `vscode-arduino`.
@@ -69,9 +81,9 @@ This extension provides several commands in the Command Palette (<kbd>F1</kbd> o
 ## Options
 | Option | Description |
 | --- | --- |
-| `arduino.useArduinoCli` | Whether to use the Arduino CLI (`true`) or the Arduino IDE (`false`) -- defaults to `false`. If using `true`,  make sure to set the `arduino.path` and `arduino.commandPath` values correctly. |
-| `arduino.path`  | Path to the Arduino installation.  You can use a custom version of Arduino by modifying this setting to include the full path. Example: `C:\\Program Files\\Arduino` for Windows, `/Applications` for Mac, `/home/<username>/Downloads/arduino-1.8.1` for Linux. (Requires a restart after change). The default value is automatically detected from your Arduino IDE installation path. To use the Arduino CLI, use the path that contains the `arduino-cli` executable (e.g. `/usr/local/bin`). |
-| `arduino.commandPath` | Path to an executable (or script) relative to `arduino.path`. The default value is `arduino_debug.exe` for Windows, `Contents/MacOS/Arduino` for Mac and `arduino` for Linux, You also can use a custom launch script to run Arduino by modifying this setting. (Requires a restart after change) Example: `run-arduino.bat` for Windows, `Contents/MacOS/run-arduino.sh` for Mac and `bin/run-arduino.sh` for Linux. To use the Arduino CLI, use `arduino-cli`. |
+| `arduino.useArduinoCli` | Whether to use the Arduino CLI (`true`) or the legacy Arduino IDE (`false`) -- defaults to `false`. If using `true`, either leave the `arduino.path` and `arduino.commandPath` values unset to use the bundled version of Arduino CLI, or point them at a custom version of Arduino CLI. Note that a future version of the extension will change this default to `true` and remove support for legacy Arduino IDE. |
+| `arduino.path`  | Path to the Arduino installation.  You can use a custom version of Arduino by modifying this setting to include the full path. Example: `C:\\Program Files\\Arduino` for Windows, `/Applications` for Mac, `/home/<username>/Downloads/arduino-1.8.1` for Linux. (Requires a restart after change). The default value is automatically detected from your legacy Arduino IDE installation path. To use the Arduino CLI, use the path that contains the `arduino-cli` executable (e.g. `/usr/local/bin`), or leave it unset to use the bundled version of Arduino CLI. |
+| `arduino.commandPath` | Path to an executable (or script) relative to `arduino.path`. The default value is `arduino_debug.exe` for Windows, `Contents/MacOS/Arduino` for Mac and `arduino` for Linux, You also can use a custom launch script to run Arduino by modifying this setting. (Requires a restart after change) Example: `run-arduino.bat` for Windows, `Contents/MacOS/run-arduino.sh` for Mac and `bin/run-arduino.sh` for Linux. To use the bundled version of Arduino CLI, leave this option unset. To use a custom version of Arduino CLI, use `arduino-cli`. |
 | `arduino.additionalUrls` | Additional Boards Manager URLs for 3rd party packages as a string array. The default value is empty. |
 | `arduino.logLevel` | CLI output log level. Could be info or verbose. The default value is `"info"`. |
 | `arduino.clearOutputOnBuild` | Clear the output logs before uploading or verifying. Default value is `false`. |
@@ -87,8 +99,7 @@ The following Visual Studio Code settings are available for the Arduino extensio
 
 ```json
 {
-    "arduino.path": "C:/Program Files (x86)/Arduino",
-    "arduino.commandPath": "arduino_debug.exe",
+    "arduino.useArduinoCli": true,
     "arduino.logLevel": "info",
     "arduino.allowPDEFiletype": false,
     "arduino.enableUSBDetection": true,
@@ -100,7 +111,6 @@ The following Visual Studio Code settings are available for the Arduino extensio
     ],
 }
 ```
-*Note:* You only need to set `arduino.path` in Visual Studio Code settings, other options are not required.
 
 The following settings are as per sketch settings of the Arduino extension. You can find them in
 `.vscode/arduino.json` under the workspace.

assets/platform/alpine-arm64/placeholder.txt

@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on alpine-arm64.

assets/platform/alpine-x64/placeholder.txt

@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on alpine-x64.

assets/platform/darwin-arm64/placeholder.txt

@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on darwin-arm64.

assets/platform/darwin-x64/placeholder.txt

@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on darwin-x64.

assets/platform/linux-arm64/placeholder.txt

@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on linux-arm64.