Add analyzeOnOpen and don't analyze by default

Author: benmcmorran

README.md

@@ -82,6 +82,7 @@ This extension provides several commands in the Command Palette (<kbd>F1</kbd> o
 | `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://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. |
 
 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.
 

package.json

@@ -541,6 +541,11 @@
           "type": "string",
           "default": "",
           "markdownDescription": "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.analyzeOnOpen": {
+          "type": "boolean",
+          "default": false,
+          "markdownDescription": "When true, automatically run analysis when the project is opened."
         }
       }
     },

src/arduino/vscodeSettings.ts

@@ -20,6 +20,7 @@ const configKeys = {
     USE_ARDUINO_CLI: "arduino.useArduinoCli",
     DISABLE_INTELLISENSE_AUTO_GEN: "arduino.disableIntelliSenseAutoGen",
     DEFAULT_TIMESTAMP_FORMAT: "arduino.defaultTimestampFormat",
+    ANALYZE_ON_OPEN: "arduino.analyzeOnOpen",
 };
 
 export interface IVscodeSettings {
@@ -37,6 +38,7 @@ export interface IVscodeSettings {
     useArduinoCli: boolean;
     disableIntelliSenseAutoGen: boolean;
     defaultTimestampFormat: string;
+    analyzeOnOpen: boolean;
     updateAdditionalUrls(urls: string[]): void;
 }
 
@@ -124,6 +126,10 @@ export class VscodeSettings implements IVscodeSettings {
         return this.getConfigValue<string>(configKeys.DEFAULT_TIMESTAMP_FORMAT);
     }
 
+    public get analyzeOnOpen(): boolean {
+        return this.getConfigValue<boolean>(configKeys.ANALYZE_ON_OPEN);
+    }
+
     public async updateAdditionalUrls(value) {
         await this.setConfigValue(configKeys.ADDITIONAL_URLS, value, true);
     }

src/arduinoActivator.ts

@@ -10,6 +10,7 @@ import { ExampleManager } from "./arduino/exampleManager";
 import { ExampleProvider } from "./arduino/exampleProvider";
 import { LibraryManager } from "./arduino/libraryManager";
 import { ProgrammerManager } from "./arduino/programmerManager";
+import { VscodeSettings } from "./arduino/vscodeSettings";
 import ArduinoContext from "./arduinoContext";
 import { DeviceContext } from "./deviceContext";
 
@@ -25,11 +26,22 @@ class ArduinoActivator {
             const arduinoSettings = new ArduinoSettings();
             await arduinoSettings.initialize();
             const arduinoApp = new ArduinoApp(arduinoSettings);
-            await arduinoApp.initialize();
+
+            // Initializing the app before the device context will cause a
+            // setting changed event that triggers analysis.
+            const analyzeOnOpen = VscodeSettings.getInstance().analyzeOnOpen;
+            if (analyzeOnOpen) {
+                await arduinoApp.initialize();
+            }
 
             // TODO: After use the device.json config, should remove the dependency on the ArduinoApp object.
             const deviceContext = DeviceContext.getInstance();
             await deviceContext.loadContext();
+
+            if (!analyzeOnOpen) {
+                await arduinoApp.initialize();
+            }
+
             // Show sketch status bar, and allow user to change sketch in config file
             deviceContext.showStatusBar();
             // Arduino board manager & library manager