Add analyzeOnSettingChange

Author: benmcmorran

README.md

@@ -82,7 +82,8 @@ 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. |
+| `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* <kbd>Cmd</kbd> + <kbd>,</kbd> or workspace settings (`.vscode/settings.json`). The latter overrides the former.
 

package.json

@@ -544,8 +544,13 @@
         },
         "arduino.analyzeOnOpen": {
           "type": "boolean",
-          "default": false,
-          "markdownDescription": "When true, automatically run analysis when the project is opened."
+          "default": true,
+          "markdownDescription": "When true, automatically run analysis when the project is opened. Only works when `arduino.analyzeOnSettingChange` is true."
+        },
+        "arduino.analyzeOnSettingChange": {
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "When true, automatically run analysis when board, configuration, or sketch settings are changed."
         }
       }
     },

src/arduino/arduino.ts

@@ -101,16 +101,18 @@ export class ArduinoApp {
             }
         }
 
-        // set up event handling for IntelliSense analysis
-        const requestAnalysis = async () => {
-            if (isCompilerParserEnabled()) {
-                await this._analysisManager.requestAnalysis();
-            }
-        };
-        const dc = DeviceContext.getInstance();
-        dc.onChangeBoard(requestAnalysis);
-        dc.onChangeConfiguration(requestAnalysis);
-        dc.onChangeSketch(requestAnalysis);
+        if (this._settings.analyzeOnSettingChange) {
+            // set up event handling for IntelliSense analysis
+            const requestAnalysis = async () => {
+                if (isCompilerParserEnabled()) {
+                    await this._analysisManager.requestAnalysis();
+                }
+            };
+            const dc = DeviceContext.getInstance();
+            dc.onChangeBoard(requestAnalysis);
+            dc.onChangeConfiguration(requestAnalysis);
+            dc.onChangeSketch(requestAnalysis);
+        }
     }
 
     /**

src/arduino/arduinoSettings.ts

@@ -23,6 +23,7 @@ export interface IArduinoSettings {
     preferences: Map<string, string>;
     useArduinoCli: boolean;
     defaultTimestampFormat: string;
+    analyzeOnSettingChange: boolean;
     reloadPreferences(): void;
 }
 
@@ -169,6 +170,10 @@ export class ArduinoSettings implements IArduinoSettings {
         return this._defaultTimestampFormat;
     }
 
+    public get analyzeOnSettingChange(): boolean {
+        return VscodeSettings.getInstance().analyzeOnSettingChange;
+    }
+
     public reloadPreferences() {
         this._preferences = util.parseConfigFile(this.preferencePath);
         if (this.preferences.get("sketchbook.path")) {

src/arduino/vscodeSettings.ts

@@ -21,6 +21,7 @@ const configKeys = {
     DISABLE_INTELLISENSE_AUTO_GEN: "arduino.disableIntelliSenseAutoGen",
     DEFAULT_TIMESTAMP_FORMAT: "arduino.defaultTimestampFormat",
     ANALYZE_ON_OPEN: "arduino.analyzeOnOpen",
+    ANALYZE_ON_SETTING_CHANGE: "arduino.analyzeOnSettingChange",
 };
 
 export interface IVscodeSettings {
@@ -39,6 +40,7 @@ export interface IVscodeSettings {
     disableIntelliSenseAutoGen: boolean;
     defaultTimestampFormat: string;
     analyzeOnOpen: boolean;
+    analyzeOnSettingChange: boolean;
     updateAdditionalUrls(urls: string[]): void;
 }
 
@@ -130,6 +132,10 @@ export class VscodeSettings implements IVscodeSettings {
         return this.getConfigValue<boolean>(configKeys.ANALYZE_ON_OPEN);
     }
 
+    public get analyzeOnSettingChange(): boolean {
+        return this.getConfigValue<boolean>(configKeys.ANALYZE_ON_SETTING_CHANGE);
+    }
+
     public async updateAdditionalUrls(value) {
         await this.setConfigValue(configKeys.ADDITIONAL_URLS, value, true);
     }