Merge branch 'main' into dev/gcampbell/OutputFolder

Author: benmcmorran

.github/workflows/build.yml

@@ -7,13 +7,11 @@ on:
   push:
     branches:
       - main
-      - release
     tags:
       - v*
   pull_request:
     branches:
       - main
-      - release
 
 jobs:
   build:

.vscode/settings.json

@@ -11,5 +11,12 @@
         "**/.git/objects/**": true,
         "**/out/*": true,
         "**/node_modules/**": true
+    },
+    "terminal.integrated.automationProfile.linux":  { 
+        "path": "${env:SHELL}",
+        "env": {
+            "HOME": "${env:HOME}",
+            "USER": "${env:USER}"
+        }
     }
 }

CHANGELOG.md

@@ -1,6 +1,23 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## Version 0.4.11
+
+- Release date: February 10, 2022
+
+### Changed
+
+This release includes a major change in internal handling of serial port
+communication ([#1450](https://github.com/microsoft/vscode-arduino/pull/1450)),
+which is designed to address antivirus false positives from the old serial
+monitor. Please report any issues you see with the serial monitor.
+
+- Show all supported boards and set default build directory [#1425](https://github.com/microsoft/vscode-arduino/pull/1425)
+- Add option for printing timestamp before each line of Serial Monitor output [#1430](https://github.com/microsoft/vscode-arduino/pull/1430)
+- Fix problem with stripping whitespace [#1433](https://github.com/microsoft/vscode-arduino/pull/1433)
+- Added Mac shortcuts on readme [#1439](https://github.com/microsoft/vscode-arduino/pull/1439)
+- Switch from serial-monitor-cli to node-serialport [#1450](https://github.com/microsoft/vscode-arduino/pull/1450)
+
 ## Version 0.4.10
 
 - Release date: January 14, 2022

CONTRIBUTING.md

@@ -9,8 +9,7 @@ There are many ways that you can contribute, beyond writing code. The goal of th
 If you are interested in writing code to fix issues, first look at the issues with the [help-wanted](https://github.com/Microsoft/vscode-arduino/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) label. They should have the context and code pointers needed to get started. If not, then feel free to ask for some, and we will be happy to provide any guidance you need.
 
 When you are doing code fix, please work against [main](https://github.com/microsoft/vscode-arduino/tree/main)
-branch and also submit pull request to `main` branch.
-Changes will be merged into `release` branch after production release.
+branch and also submit pull request to `main` branch. Production releases will be tagged from `main`.
 
 
 

README.md

@@ -29,9 +29,9 @@ The Arduino CLI can be downloaded from the repository's [release page](https://g
 - If you use the CLI you will have to set `arduino.path` since the CLI does not have a default path.
 
 ## Installation
-Open VS Code and press <kbd>F1</kbd> or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> to open command palette, select **Install Extension** and type `vscode-arduino`.
+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`.
 
-Or launch VS Code Quick Open (<kbd>Ctrl</kbd> + <kbd>P</kbd>), paste the following command, and press enter.
+Or launch VS Code Quick Open (<kbd>Ctrl</kbd> + <kbd>P</kbd> *or* <kbd>Cmd</kbd> + <kbd>P</kbd> ), paste the following command, and press enter.
 ```bash
 ext install vscode-arduino
 ```
@@ -42,7 +42,7 @@ You can also install directly from the Marketplace within Visual Studio Code, se
 You can find code samples and tutorials each time that you connect a supported device. Alternatively you can visit our [IoT Developer Blog Space](https://devblogs.microsoft.com/iotdev/) or [Get Started Tutorials](https://docs.microsoft.com/azure/iot-hub/iot-hub-arduino-iot-devkit-az3166-get-started).
 
 ## Commands
-This extension provides several commands in the Command Palette (<kbd>F1</kbd> or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>) for working with `*.ino` files:
+This extension provides several commands in the Command Palette (<kbd>F1</kbd> or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> *or* <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>) for working with `*.ino` files:
 
 - **Arduino: Board Manager**: Manage packages for boards. You can add 3rd party Arduino board by configuring `Additional Board Manager URLs` in the board manager.
 - **Arduino: Change Baud Rate**: Change the baud rate of the selected serial port.
@@ -80,10 +80,12 @@ This extension provides several commands in the Command Palette (<kbd>F1</kbd> o
 | `arduino.disableTestingOpen` | Enable/disable automatic sending of a test message to the serial port for checking the open status. The default value is `false` (a test message will be sent). |
 | `arduino.skipHeaderProvider` | Enable/disable the extension providing completion items for headers. This functionality is included in newer versions of the C++ extension. The default value is `false`.|
 | `arduino.defaultBaudRate` | Default baud rate for the serial port monitor. The default value is 115200. Supported values are 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 74880, 115200, 230400 and 250000 |
-| `arduino.defaultTimestampFormat` | Format of timestamp printed before each line of Serial Monitor output. You can find list of all available placeholders [here](https://strftime.org). |
+| `arduino.defaultTimestampFormat` | Format of timestamp printed before each line of Serial Monitor output. You can find list of all available placeholders [here](https://github.com/samsonjs/strftime#supported-specifiers). |
 | `arduino.disableIntelliSenseAutoGen` | When `true` vscode-arduino will not auto-generate an IntelliSense configuration (i.e. `.vscode/c_cpp_properties.json`) by analyzing Arduino's compiler output. |
+| `arduino.analyzeOnOpen` | When true, automatically run analysis when the project is opened. Only works when `arduino.analyzeOnSettingChange` is true. |
+| `arduino.analyzeOnSettingChange` | When true, automatically run analysis when board, configuration, or sketch settings are changed. |
 
-The following Visual Studio Code settings are available for the Arduino extension. These can be set in global user preferences <kbd>Ctrl</kbd> + <kbd>,</kbd> or workspace settings (`.vscode/settings.json`). The latter overrides the former.
+The following Visual Studio Code settings are available for the Arduino extension. These can be set in global user preferences <kbd>Ctrl</kbd> + <kbd>,</kbd> *or* <kbd>Cmd</kbd> + <kbd>,</kbd> or workspace settings (`.vscode/settings.json`). The latter overrides the former.
 
 ```json
 {
@@ -122,7 +124,7 @@ The following settings are as per sketch settings of the Arduino extension. You
 - `port` - Name of the serial port connected to the device. Can be set by the `Arduino: Select Serial Port` command. For Mac users could be "/dev/cu.wchusbserial1420".
 - `board` - Currently selected Arduino board alias. Can be set by the `Arduino: Change Board Type` command. Also, you can find the board list there.
 - `output` - Arduino build output path. If not set, Arduino will create a new temporary output folder each time, which means it cannot reuse the intermediate result of the previous build leading to long verify/upload time, so it is recommended to set the field. Arduino requires that the output path should not be the workspace itself or in a subfolder of the workspace, otherwise, it may not work correctly. By default, this option is not set. It's worth noting that the contents of this file could be deleted during the build process, so pick (or create) a directory that will not store files you want to keep.
-- `debugger` - The short name of the debugger that will be used when the board itself does not have a debugger and there is more than one debugger available. You can find the list of debuggers [here](https://github.com/Microsoft/vscode-arduino/blob/release/misc/debuggerUsbMapping.json). By default, this option is not set.
+- `debugger` - The short name of the debugger that will be used when the board itself does not have a debugger and there is more than one debugger available. You can find the list of debuggers [here](https://github.com/Microsoft/vscode-arduino/blob/main/misc/debuggerUsbMapping.json). By default, this option is not set.
 - `prebuild` - External command which will be invoked before any sketch build (verify, upload, ...). For details see the [Pre- and Post-Build Commands](#Pre--and-Post-Build-Commands) section.
 - `postbuild` - External command to be run after the sketch has been built successfully. See the afore mentioned section for more details.
 - `intelliSenseGen` - Override the global setting for auto-generation of the IntelliSense configuration (i.e. `.vscode/c_cpp_properties.json`). Three options are available:
@@ -198,14 +200,14 @@ Make sure that your Arduino board can work with [STLink](http://www.st.com/en/de
 
 Steps to start debugging:
 1. Plug in your board to your development machine properly. For those boards that do not have an on-board debugging chip, you need to use a STLink or JLink connector.
-2. Go to the **Debug View** (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>D</kbd>). and set breakpoints in your source files.
+2. Go to the **Debug View** (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>D</kbd> *or* <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>D</kbd>). and set breakpoints in your source files.
 3. Press <kbd>F5</kbd> to select your debugging environment.
 4. When your breakpoint is hit, you can see variables and add expression(s) to watch on the Debug Side Bar.
 
 > To learn more about how to debug Arduino code, visit our [team blog](https://blogs.msdn.microsoft.com/iotdev/2017/05/27/debug-your-arduino-code-with-visual-studio-code/).
 
 ## Change Log
-See the [Change log](https://github.com/Microsoft/vscode-arduino/blob/release/CHANGELOG.md) for details about the changes in each version.
+See the [Change log](https://github.com/Microsoft/vscode-arduino/blob/main/CHANGELOG.md) for details about the changes in each version.
 
 ## Supported Operating Systems
 Currently this extension supports the following operating systems:
@@ -243,7 +245,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
 The [Microsoft Enterprise and Developer Privacy Statement](https://www.microsoft.com/en-us/privacystatement/EnterpriseDev/default.aspx) describes the privacy statement of this software.
 
 ## License
-This extension is licensed under the [MIT License](https://github.com/Microsoft/vscode-arduino/blob/release/LICENSE.txt). Please see the [Third Party Notice](https://github.com/Microsoft/vscode-arduino/blob/release/ThirdPartyNotices.txt) file for additional copyright notices and terms.
+This extension is licensed under the [MIT License](https://github.com/Microsoft/vscode-arduino/blob/main/LICENSE.txt). Please see the [Third Party Notice](https://github.com/Microsoft/vscode-arduino/blob/main/ThirdPartyNotices.txt) file for additional copyright notices and terms.
 
 ## Contact Us
 If you would like to help build the best Arduino experience with VS Code, you can reach us directly at [gitter chat room](https://gitter.im/Microsoft/vscode-arduino).

azure-pipelines.yml

@@ -15,13 +15,11 @@ parameters:
 
 pr:
   - main
-  - release
 
 trigger:
   branches:
     include:
       - main
-      - release
   tags:
     include:
       - v*
@@ -32,13 +30,13 @@ pool:
 variables:
   # MicroBuild requires TeamName to be set.
   TeamName: C++ Cross Platform and Cloud
-  # If the user didn't override the signing type, then only real-sign on tags,
-  # main, or release.
+  # If the user didn't override the signing type, then only real-sign on tags or
+  # the main branch.
   ${{ if ne(parameters.SignTypeOverride, 'default') }}:
     SignType: ${{ parameters.SignTypeOverride }}
-  ${{ if and(eq(parameters.SignTypeOverride, 'default'), or(startsWith(variables['Build.SourceBranch'], 'refs/tags'), eq(variables['Build.SourceBranchName'], 'main'), eq(variables['Build.SourceBranchName'], 'release'))) }}:
+  ${{ if and(eq(parameters.SignTypeOverride, 'default'), or(startsWith(variables['Build.SourceBranch'], 'refs/tags'), eq(variables['Build.SourceBranchName'], 'main'))) }}:
     SignType: real
-  ${{ if and(eq(parameters.SignTypeOverride, 'default'), not(or(startsWith(variables['Build.SourceBranch'], 'refs/tags'), eq(variables['Build.SourceBranchName'], 'main'), eq(variables['Build.SourceBranchName'], 'release')))) }}:
+  ${{ if and(eq(parameters.SignTypeOverride, 'default'), not(or(startsWith(variables['Build.SourceBranch'], 'refs/tags'), eq(variables['Build.SourceBranchName'], 'main')))) }}:
     SignType: test
 
 steps:
@@ -115,21 +113,13 @@ steps:
       includeRootFolder: false
       archiveType: zip
       archiveFile: $(Build.StagingDirectory)\vscode-arduino.vsix
-  - script: python .\build\markExecutableFiles.py
-    displayName: Make serial monitor executable
   - task: MSBuild@1
     displayName: Sign VSIX
     inputs:
       solution: .\build\SignVsix.proj
       msbuildArguments: /p:SignType=$(SignType)
     # MicroBuild signing will always fail on public PRs.
-    # TODO: Signing the VSIX strips out the "main" executables for
-    # serial-monitor-cli on Mac and Linux, completely breaking serial
-    # functionality in the extension on these platforms. For now we disable VSIX
-    # signing because it's not a strict requirement, but we should investigate
-    # if we can either add extensions to these files or support extensionless
-    # files in VSIX signing.
-    condition: and(false, ne(variables['Build.Reason'], 'PullRequest'))
+    condition: ne(variables['Build.Reason'], 'PullRequest')
   - publish: $(Build.StagingDirectory)\vscode-arduino.vsix
     artifact: VS Code extension VSIX
     displayName: Publish extension VSIX as artifact

build/SignFiles.proj

@@ -13,14 +13,6 @@
     <FilesToSign Include="$(OutDir)\**\*.js" Exclude="$(OutDir)\**\node_modules\**\*.js">
       <Authenticode>Microsoft400</Authenticode>
     </FilesToSign>
-    <!-- Authenticode only works on Windows files. If we get the ability to sign Linux and Mac executables, the signing
-         steps should probably move to the serial-monitor-cli repo instead of doing all the signing here. -->
-    <FilesToSign Include="$(OutDir)\out\serial-monitor-cli\win32\*.exe">
-      <Authenticode>Microsoft400</Authenticode>
-    </FilesToSign>
-    <FilesToSign Include="$(OutDir)\out\serial-monitor-cli\win32\*.dll">
-      <Authenticode>Microsoft400</Authenticode>
-    </FilesToSign>
     <FilesToSign Include="$(OutDir)\**\node_modules\**\*.js">
       <Authenticode>3PartyScriptsSHA2</Authenticode>
     </FilesToSign>

build/markExecutableFiles.py

@@ -63,28 +63,6 @@ gulp.task("node_modules-webpack", (done) => {
     });
 });
 
-gulp.task("insert-serial-monitor-cli", async (done) => {
-    const platforms = [
-        "linux",
-        "darwin",
-        "win32",
-    ];
-    const release = "latest";
-    const destDir = path.resolve("out", "serial-monitor-cli");
-
-    async function downloadAndUnzip(platform) {
-        const fileName = `${platform}.zip`;
-        const zipPath = path.join(destDir, fileName);
-        await download(`https://github.com/microsoft/serial-monitor-cli/releases/${release}/download/${fileName}`,
-                       destDir,
-                       );
-        await extract(zipPath, { dir: path.join(destDir, platform) });
-        fs.rmSync(zipPath);
-    }
-
-    Promise.all(platforms.map(downloadAndUnzip)).then(done);
-});
-
 gulp.task("ts-compile", () => {
     const tsProject = ts.createProject("./tsconfig.json");
     return tsProject.src()
@@ -156,7 +134,7 @@ gulp.task("test", (done) => {
     });
 });
 
-gulp.task("build", gulp.series("clean", "ts-compile", "html-webpack", "node_modules-webpack", "insert-serial-monitor-cli"));
+gulp.task("build", gulp.series("clean", "ts-compile", "html-webpack", "node_modules-webpack"));
 
 gulp.task("build_without_view", gulp.series("clean", "ts-compile"));