Fixed linting

Author: elektronikworkshop

src/arduino/arduino.ts

@@ -74,7 +74,7 @@ export class ArduinoApp {
     constructor(private _settings: IArduinoSettings) {
         const analysisDelayMs = 1000 * 3;
         this._analysisManager = new AnalysisManager(
-            () => { return this._building; },
+            () => this._building,
             async () => { await this.build(BuildMode.Analyze); },
             analysisDelayMs);
     }
@@ -633,7 +633,7 @@ Please make sure the folder is not occupied by other procedures .`);
      * @returns True if successful, false on error.
      */
     protected async runPreBuildCommand(dc: DeviceContext): Promise<boolean> {
-        const prebuildcmdline = dc.prebuild; 
+        const prebuildcmdline = dc.prebuild;
         if (prebuildcmdline) {
             arduinoChannel.info(`Running pre-build command: ${prebuildcmdline}`);
             const args = prebuildcmdline.split(/\s+/);
@@ -679,14 +679,14 @@ Please make sure the folder is not occupied by other procedures .`);
         }
 
         if (!dc.sketch || !util.fileExistsSync(path.join(ArduinoWorkspace.rootPath, dc.sketch))) {
-            if (mode == BuildMode.Analyze) {
+            if (mode === BuildMode.Analyze) {
                 // Analyze runs non interactively
                 return false;
             }
             if (!await dc.resolveMainSketch()) {
                 vscode.window.showErrorMessage("No sketch file was found. Please specify the sketch in the arduino.json file");
                 return false;
-            }    
+            }
         }
 
         const selectSerial = async () => {
@@ -805,8 +805,8 @@ Please make sure the folder is not occupied by other procedures .`);
             stdoutCallback,
         ).then(async () => {
             await cleanup();
-            if (mode != BuildMode.Analyze) {
-                const cmd = os.platform() == "darwin"
+            if (mode !== BuildMode.Analyze) {
+                const cmd = os.platform() === "darwin"
                     ? "Cmd + Alt + I"
                     : "Ctrl + Alt + I";
                 arduinoChannel.info(`To rebuild your IntelliSense configuration run "${cmd}"`);

src/arduino/arduinoContentProvider.ts

@@ -8,10 +8,9 @@ import ArduinoActivator from "../arduinoActivator";
 import ArduinoContext from "../arduinoContext";
 import * as Constants from "../common/constants";
 import * as JSONHelper from "../common/cycle";
+import { DeviceContext } from "../deviceContext";
 import * as Logger from "../logger/logger";
 import LocalWebServer from "./localWebServer";
-import { VscodeSettings } from "./vscodeSettings";
-import { DeviceContext } from "../deviceContext";
 
 export class ArduinoContentProvider implements vscode.TextDocumentContentProvider {
     private _webserver: LocalWebServer;

src/arduino/board.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
-import { IBoard, IBoardConfigItem, IPlatform, BoardConfigResult } from "./package";
+import { BoardConfigResult, IBoard, IBoardConfigItem, IPlatform } from "./package";
 
 export function parseBoardDescriptor(boardDescriptor: string, plat: IPlatform): Map<string, IBoard> {
     const boardLineRegex = /([^\.]+)\.(\S+)=(.+)/;
@@ -142,7 +142,7 @@ export class Board implements IBoard {
         for (const o of targetConfig.options) {
             // Make sure that we only set valid options, e.g. when loading
             // from config files.
-            if (o.id == optionId) {
+            if (o.id === optionId) {
                 if (targetConfig.selectedOption !== optionId) {
                     targetConfig.selectedOption = optionId;
                     return BoardConfigResult.Success;

src/arduino/boardManager.ts

@@ -291,7 +291,7 @@ export class BoardManager {
                 // setting partially valid configurations can lead to nasty
                 // surprises. When setting a new board this is acceptable
                 const r = this._currentBoard.loadConfig(dc.configuration);
-                if (r != BoardConfigResult.Success && r != BoardConfigResult.SuccessNoChange) {
+                if (r !== BoardConfigResult.Success && r !== BoardConfigResult.SuccessNoChange) {
                     this._currentBoard.resetConfig();
                     // we don't reset dc.configuration to give the user a
                     // chance to fix her/his configuration
@@ -317,7 +317,7 @@ export class BoardManager {
         const dc = DeviceContext.getInstance();
         if (this._currentBoard) {
             const r = this._currentBoard.loadConfig(dc.configuration);
-            if (r != BoardConfigResult.Success && r != BoardConfigResult.SuccessNoChange) {
+            if (r !== BoardConfigResult.Success && r !== BoardConfigResult.SuccessNoChange) {
                 this._currentBoard.resetConfig();
                 // We reset the configuration here but do not write it back
                 // to the configuration file - this can be annoying when
@@ -328,17 +328,17 @@ export class BoardManager {
         }
     }
 
-    public invalidConfigWarning(result: BoardConfigResult) {
+    private invalidConfigWarning(result: BoardConfigResult) {
         let what = "";
         switch (result) {
             case BoardConfigResult.InvalidFormat:
-                what = ': Invalid format must be of the form "key1=value2,key1=value2,..."';
+                what = ": Invalid format must be of the form \"key1=value2,key1=value2,...\"";
                 break;
             case BoardConfigResult.InvalidConfigID:
-                what = ': Invalid configuration key';
+                what = ": Invalid configuration key";
                 break;
             case BoardConfigResult.InvalidOptionID:
-                what = ': Invalid configuration value';
+                what = ": Invalid configuration value";
                 break;
         }
         vscode.window.showWarningMessage(`Invalid board configuration detected in configuration file${what}. Falling back to defaults.`);

src/arduino/intellisense.ts

@@ -121,7 +121,7 @@ export function makeCompilerParserContext(dc: DeviceContext): ICoCoPaContext {
  */
 function makeCompilerParserEngines(dc: DeviceContext) {
 
-    let sketch = path.basename(dc.sketch);
+    const sketch = path.basename(dc.sketch);
     const trigger = ccp.getTriggerForArduinoGcc(sketch);
     const gccParserEngine = new ccp.ParserGcc(trigger);
     return [gccParserEngine];
@@ -136,11 +136,10 @@ function makeCompilerParserEngines(dc: DeviceContext) {
 async function findDirContaining(dir: string, what: string): Promise<string | undefined> {
     const readdir = tp.promisify(fs.readdir);
     const fsstat = tp.promisify(fs.stat);
-    
+
     for (const entry of await readdir(dir)) {
         const p = path.join(dir, entry);
         const s = await fsstat(p);
-        console.log(p);
         if (s.isDirectory()) {
             const result = await findDirContaining(p, what);
             if (result) {
@@ -217,7 +216,7 @@ enum AnalysisEvent {
 /**
  * This class manages analysis builds for the automatic IntelliSense
  * configuration synthesis. Its primary purposes are:
- * 
+ *
  *  * delaying analysis requests caused by DeviceContext setting change
  *      events such that multiple subsequent requests don't cause
  *      multiple analysis builds
@@ -257,7 +256,7 @@ export class AnalysisManager {
      * analysis request. This delay is used as polling interval as well when
      * checking for ongoing builds.
      */
-    constructor(isBuilding:() => boolean,
+    constructor(isBuilding: () => boolean,
                 doBuild: () => Promise<void>,
                 waitPeriodMs: number = 1000) {
         this._isBuilding = isBuilding;
@@ -271,33 +270,32 @@ export class AnalysisManager {
      * within a wait period or until any build in progress has terminated.
      */
     public async requestAnalysis() {
-        console.log("requesting analysis");
         await this.update(AnalysisEvent.AnalysisRequest);
     }
 
     /**
      * Update the manager's state machine.
      * @param event The event which will cause the state transition.
-     * 
+     *
      * Implementation note: asynchronous edge actions must be called after
-     * setting the new state since they don't return immediately. 
+     * setting the new state since they don't return immediately.
      */
     private async update(event: AnalysisEvent) {
 
         switch (this._state) {
 
             case AnalysisState.Idle:
-                if (event == AnalysisEvent.AnalysisRequest) {
+                if (event === AnalysisEvent.AnalysisRequest) {
                     this._state = AnalysisState.Waiting;
                     this.startWaitTimeout();
                 }
                 break;
 
             case AnalysisState.Waiting:
-                if (event == AnalysisEvent.AnalysisRequest) {
+                if (event === AnalysisEvent.AnalysisRequest) {
                     // every new request restarts timer
                     this.startWaitTimeout();
-                } else if (event == AnalysisEvent.WaitTimeout) {
+                } else if (event === AnalysisEvent.WaitTimeout) {
                     if (this._isBuilding()) {
                         // another build in progress, continue waiting
                         this.startWaitTimeout();
@@ -310,15 +308,15 @@ export class AnalysisManager {
                 break;
 
             case AnalysisState.Analyzing:
-                if (event == AnalysisEvent.AnalysisBuildDone) {
+                if (event === AnalysisEvent.AnalysisBuildDone) {
                     this._state = AnalysisState.Idle;
-                } else if (event == AnalysisEvent.AnalysisRequest) {
+                } else if (event === AnalysisEvent.AnalysisRequest) {
                     this._state = AnalysisState.AnalyzingWaiting;
                 }
                 break;
 
             case AnalysisState.AnalyzingWaiting:
-                if (event == AnalysisEvent.AnalysisBuildDone) {
+                if (event === AnalysisEvent.AnalysisBuildDone) {
                     // emulate the transition from idle to waiting
                     // (we don't care if this adds an additional
                     // timeout - event driven analysis is not time-

src/deviceContext.ts

@@ -296,11 +296,11 @@ export class DeviceContext implements IDeviceContext, vscode.Disposable {
                             /* TODO (EW, 2020-02-18):
                              * is 'c' actually allowed? Also found on within other files.
                              * And the regular expression doesn't need the intenal groups.
-                             * The outer group can be an anonymous group. 
+                             * The outer group can be an anonymous group.
                              * And \w doesn't match dashes - so any sketch containing dashes
                              * will not be found.
                              * The correct expression therefore would be something like this:
-                             * 
+                             *
                              *   /^[\w\-]+\.(?:ino|cpp)$/
                              *
                              * I'd recommend to define such regular expressions (including)

src/deviceSettings.ts

@@ -17,10 +17,10 @@ import * as logger from "./logger/logger";
  * to prevent invalid or badly formatted values to enter your settings.
  */
 class Setting<T> {
+    /** The setting's default value. */
+    public readonly default: T;
     /** The actual value of the setting. */
     private _value: T | undefined;
-    /** The setting's default value. */
-    readonly default: T;
     /** Indicates if the value was changed since the last call to this.commit(). */
     private _modified: boolean;
     /** Event emitter which fires when the value is changed. */
@@ -51,7 +51,7 @@ class Setting<T> {
      * To clear the modified flag call commit().
      */
     public get modified() {
-        return this._modified;        
+        return this._modified;
     }
     /** Returns the modified-event emitter. */
     public get emitter() {
@@ -104,15 +104,15 @@ class StrSetting extends Setting<string> {
  * provides common operations on them.
  */
 export class DeviceSettings {
-    port: StrSetting = new StrSetting();
-    board: StrSetting = new StrSetting();
-    sketch: StrSetting = new StrSetting();
-    output: StrSetting = new StrSetting();
-    debugger: StrSetting = new StrSetting();
-    intelliSenseGen: StrSetting = new StrSetting();
-    configuration: StrSetting = new StrSetting();
-    prebuild: StrSetting = new StrSetting();
-    programmer: StrSetting = new StrSetting();
+    public port: StrSetting = new StrSetting();
+    public board: StrSetting = new StrSetting();
+    public sketch: StrSetting = new StrSetting();
+    public output: StrSetting = new StrSetting();
+    public debugger: StrSetting = new StrSetting();
+    public intelliSenseGen: StrSetting = new StrSetting();
+    public configuration: StrSetting = new StrSetting();
+    public prebuild: StrSetting = new StrSetting();
+    public programmer: StrSetting = new StrSetting();
 
     /**
      * @returns true if any of the settings values has its modified flag