(maint) Manual eslint fixes

Address reported errors from existing eslint rulesets.

Author: jpogran

src/configuration.ts

@@ -1,14 +1,14 @@
 'use strict';
 
-import * as path from 'path';
 import * as fs from 'fs';
-
+import * as path from 'path';
 import { PathResolver } from './configuration/pathResolver';
-import { ISettings, ConnectionType, ProtocolType, PuppetInstallType } from './settings';
 import * as pdk from './configuration/pdkResolver';
+import { ConnectionType, ISettings, ProtocolType, PuppetInstallType } from './settings';
 
 /** Creates an Aggregate Configuration based on the VSCode Workspace settings (ISettings) */
 export function CreateAggregrateConfiguration(settings: ISettings): IAggregateConfiguration {
+  // eslint-disable-next-line @typescript-eslint/no-use-before-define
   const value = new AggregateConfiguration(settings);
 
   return value;

src/configuration/pathResolver.ts

@@ -1,10 +1,11 @@
-import * as path from 'path';
 import * as fs from 'fs';
+import * as path from 'path';
 
 export class PathResolver {
   public static getprogramFiles(): string {
     switch (process.platform) {
       case 'win32':
+        // eslint-disable-next-line no-case-declarations
         let programFiles = process.env['ProgramFiles'] || 'C:\\Program Files';
 
         if (process.env['PROCESSOR_ARCHITEW6432'] === 'AMD64') {

src/configuration/pdkResolver.ts

@@ -47,6 +47,7 @@ export interface IPDKRubyInstance {
 //             | 2.5.0               <---- pdkGemDir (GEM_PATH #2, replaceSlashes) (contains all the ancillary gems e.g. puppet-lint, rspec)
 
 export function pdkInstances(pdkRootDirectory: string): IPDKRubyInstances {
+  // eslint-disable-next-line @typescript-eslint/no-use-before-define
   return new PDKRubyInstances(pdkRootDirectory);
 }
 
@@ -90,6 +91,7 @@ class PDKRubyInstances implements IPDKRubyInstances {
     }
 
     fs.readdirSync(rubyDir).forEach((item) => {
+      // eslint-disable-next-line @typescript-eslint/no-use-before-define
       this.rubyInstances.push(new PDKRubyInstance(this.pdkDirectory, path.join(rubyDir, item)));
     });
 
@@ -222,14 +224,14 @@ class PDKRubyInstance implements IPDKRubyInstance {
     return (
       '{' +
       [
-        `rubyVersion: \"${this._rubyVersion}\"`,
-        `rubyDir: \"${this._rubyDir}\"`,
-        `rubyVerDir: \"${this.rubyVerDir}\"`,
-        `gemVerDir: \"${this.gemVerDir}\"`,
-        `gemDir: \"${this.gemDir}\"`,
-        `gemDir: \"${this.gemDir}\"`,
-        `puppetVersions: \"${this.puppetVersions}\"`,
-        `valid: \"${this.valid}\"`,
+        `rubyVersion: "${this._rubyVersion}"`,
+        `rubyDir: "${this._rubyDir}"`,
+        `rubyVerDir: "${this.rubyVerDir}"`,
+        `gemVerDir: "${this.gemVerDir}"`,
+        `gemDir: "${this.gemDir}"`,
+        `gemDir: "${this.gemDir}"`,
+        `puppetVersions: "${this.puppetVersions}"`,
+        `valid: "${this.valid}"`,
       ].join(', ') +
       '}'
     );

src/extension.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-use-before-define */
 'use strict';
 
 import * as fs from 'fs';
@@ -7,22 +8,22 @@ import { IFeature } from './feature';
 import { BoltFeature } from './feature/BoltFeature';
 import { DebuggingFeature } from './feature/DebuggingFeature';
 import { FormatDocumentFeature } from './feature/FormatDocumentFeature';
-import { UpdateConfigurationFeature } from './feature/UpdateConfigurationFeature';
 import { PDKFeature } from './feature/PDKFeature';
+import { PuppetModuleHoverFeature } from './feature/PuppetModuleHoverFeature';
+import { PuppetNodeGraphFeature } from './feature/PuppetNodeGraphFeature';
 import { PuppetResourceFeature } from './feature/PuppetResourceFeature';
 import { PuppetStatusBarFeature } from './feature/PuppetStatusBarFeature';
+import { UpdateConfigurationFeature } from './feature/UpdateConfigurationFeature';
 import { ConnectionHandler } from './handler';
 import { StdioConnectionHandler } from './handlers/stdio';
 import { TcpConnectionHandler } from './handlers/tcp';
-import { ConnectionType, ProtocolType, PuppetInstallType, ISettings } from './settings';
 import { ILogger } from './logging';
 import { OutputChannelLogger } from './logging/outputchannel';
-import { legacySettings, SettingsFromWorkspace } from './settings';
+import { ConnectionType, legacySettings, ProtocolType, PuppetInstallType, SettingsFromWorkspace } from './settings';
 import { reporter } from './telemetry';
-import { PuppetModuleHoverFeature } from './feature/PuppetModuleHoverFeature';
-import { PuppetNodeGraphFeature } from './feature/PuppetNodeGraphFeature';
 import { PuppetFactsProvider } from './views/facts';
 
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const axios = require('axios');
 
 export const puppetLangID = 'puppet'; // don't change this
@@ -96,6 +97,7 @@ export function activate(context: vscode.ExtensionContext) {
     notifyIfNewPDKVersion(extContext, configSettings);
   }
 
+  // eslint-disable-next-line default-case
   switch (configSettings.workspace.editorService.protocol) {
     case ProtocolType.STDIO:
       connectionHandler = new StdioConnectionHandler(extContext, statusBar, logger, configSettings);
@@ -277,10 +279,10 @@ async function notifyIfNewPDKVersion(context: vscode.ExtensionContext, settings:
     .then((response) => {
       return response.data;
     })
-    .then((latest_version) => {
-      if (version !== latest_version) {
+    .then((latestVersion) => {
+      if (version !== latestVersion) {
         return vscode.window.showWarningMessage(
-          `The installed PDK version is ${version}, the newest version is ${latest_version}. To find out how to update to the latest version click the more info button`,
+          `The installed PDK version is ${version}, the newest version is ${latestVersion}. To find out how to update to the latest version click the more info button`,
           { modal: false },
           { title: dontCheckAgainNotice },
           { title: viewPDKDownloadPage },

src/feature/BoltFeature.ts

@@ -1,10 +1,11 @@
-import { ExtensionContext, commands, window, Uri } from 'vscode';
-import { IFeature } from '../feature';
-import * as path from 'path';
 import * as fs from 'fs';
+import * as path from 'path';
+import { commands, ExtensionContext, Uri, window } from 'vscode';
+import { IFeature } from '../feature';
 import { reporter } from '../telemetry';
 
 export class BoltFeature implements IFeature {
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   dispose() {}
 
   showDeprecation() {
@@ -68,6 +69,7 @@ export class BoltFeature implements IFeature {
           ignoreFocusOut: true,
         })
         .then((answer) => {
+          // eslint-disable-next-line default-case
           switch (answer) {
             case 'no':
               break;

src/feature/DebuggingFeature.ts

@@ -1,12 +1,12 @@
+/* eslint-disable */
 'use strict';
 
-import * as vscode from 'vscode';
 import * as cp from 'child_process';
-
+import * as vscode from 'vscode';
+import { IAggregateConfiguration } from '../configuration';
 import { IFeature } from '../feature';
-import { ILogger } from '../logging';
 import { CommandEnvironmentHelper } from '../helpers/commandHelper';
-import { IAggregateConfiguration } from '../configuration';
+import { ILogger } from '../logging';
 
 // Socket vs Exec DebugAdapter types
 // https://github.com/Microsoft/vscode/blob/2808feeaf6b24feaaa6ba49fb91ea165c4d5fb06/src/vs/workbench/parts/debug/node/debugger.ts#L58-L61

src/feature/PuppetModuleHoverFeature.ts

@@ -1,14 +1,16 @@
-import * as vscode from 'vscode';
 import { getLocation } from 'jsonc-parser';
+import * as vscode from 'vscode';
 import { IFeature } from '../feature';
 import { ILogger } from '../logging';
 
 export class PuppetModuleHoverFeature implements IFeature {
   constructor(public context: vscode.ExtensionContext, public logger: ILogger) {
     const selector = [{ language: 'json', scheme: '*', pattern: '**/metadata.json' }];
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
     context.subscriptions.push(vscode.languages.registerHoverProvider(selector, new PuppetModuleHoverProvider(logger)));
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   dispose() {}
 }
 
@@ -47,6 +49,7 @@ export class PuppetModuleHoverProvider implements vscode.HoverProvider {
       msg.push(`### ${result.slug}`);
 
       const releaseDate = new Date(result.releases[0].created_at);
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
       const dateformat = require('dateformat');
       msg.push(`\nLatest version: ${result.releases[0].version} (${dateformat(releaseDate, 'dS mmmm yyyy')})`);
 
@@ -58,10 +61,10 @@ export class PuppetModuleHoverProvider implements vscode.HoverProvider {
       msg.push(`\nOwner: ${result.owner.slug}`);
 
       const forgeUri = `https://forge.puppet.com/${result.owner.username}/${result.name}`;
-      msg.push(`\nForge: \[${forgeUri}\](${forgeUri})\n`);
+      msg.push(`\nForge: [${forgeUri}](${forgeUri})\n`);
 
       if (result.homepage_url !== null) {
-        msg.push(`\nProject: \[${result.homepage_url}\](${result.homepage_url})\n`);
+        msg.push(`\nProject: [${result.homepage_url}](${result.homepage_url})\n`);
       }
 
       const md = msg.join('\n');
@@ -75,6 +78,7 @@ export class PuppetModuleHoverProvider implements vscode.HoverProvider {
       url: `https://forgeapi.puppet.com/v3/modules/${name}?exclude_fields=readme%20changelog%20license%20reference`,
     };
     return new Promise(function (resolve, reject) {
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
       const request = require('request');
       request.get(options, function (err, resp, body) {
         if (err) {

src/feature/PuppetNodeGraphFeature.ts

@@ -1,13 +1,12 @@
-import * as vscode from 'vscode';
 import * as path from 'path';
-
+import * as vscode from 'vscode';
 import { IFeature } from '../feature';
 import { ConnectionHandler } from '../handler';
-import { ILogger } from '../logging';
 import { ConnectionStatus } from '../interfaces';
+import { ILogger } from '../logging';
 import { PuppetNodeGraphRequest, PuppetNodeGraphResponse } from '../messages';
-import { reporter } from '../telemetry';
 import { ISettings, SettingsFromWorkspace } from '../settings';
+import { reporter } from '../telemetry';
 
 const PuppetNodeGraphToTheSideCommandId = 'puppet.puppetShowNodeGraphToSide';
 
@@ -40,6 +39,7 @@ export class PuppetNodeGraphFeature implements IFeature {
           return;
         }
 
+        // eslint-disable-next-line @typescript-eslint/no-use-before-define
         const provider = new NodeGraphWebViewProvider(
           vscode.window.activeTextEditor.document.uri,
           handler,
@@ -89,6 +89,7 @@ class NodeGraphWebViewProvider implements vscode.Disposable {
       { enableScripts: true },
     );
     this.panel.webview.html = this.getHtml(this.context.extensionPath);
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
     this.panel.onDidDispose(() => {});
     this.panel.webview.onDidReceiveMessage((message) => {
       switch (message.command) {

src/feature/PuppetResourceFeature.ts

@@ -2,22 +2,23 @@
 
 import * as vscode from 'vscode';
 import { IFeature } from '../feature';
+import { ConnectionHandler } from '../handler';
+import { ConnectionStatus } from '../interfaces';
 import { ILogger } from '../logging';
 import {
   PuppetCommandStrings,
-  PuppetResourceRequestParams,
   PuppetResourceRequest,
+  PuppetResourceRequestParams,
   PuppetResourceResponse,
 } from '../messages';
-import { reporter } from '../telemetry';
-import { ConnectionStatus } from '../interfaces';
-import { ConnectionHandler } from '../handler';
 import { ISettings, SettingsFromWorkspace } from '../settings';
+import { reporter } from '../telemetry';
 
 export class PuppetResourceFeature implements IFeature {
   private _connectionHandler: ConnectionHandler;
   private logger: ILogger;
 
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   dispose() {}
 
   constructor(context: vscode.ExtensionContext, connMgr: ConnectionHandler, logger: ILogger) {
@@ -30,9 +31,7 @@ export class PuppetResourceFeature implements IFeature {
     );
   }
   public run() {
-    const thisCommand = this;
-
-    if (thisCommand._connectionHandler.status !== ConnectionStatus.RunningLoaded) {
+    if (this._connectionHandler.status !== ConnectionStatus.RunningLoaded) {
       vscode.window.showInformationMessage('Puppet Resource is not available as the Language Server is not ready');
       return;
     }
@@ -45,6 +44,7 @@ export class PuppetResourceFeature implements IFeature {
         }
 
         const doc = editor.document;
+        // eslint-disable-next-line @typescript-eslint/no-use-before-define
         const requestParams = new RequestParams();
         requestParams.typename = moduleName;
 
@@ -76,15 +76,15 @@ export class PuppetResourceFeature implements IFeature {
             },
             (progress) => {
               progress.report({ message: `Gathering Puppet ${moduleName} Resources` });
-              return thisCommand._connectionHandler.languageClient
+              return this._connectionHandler.languageClient
                 .sendRequest(PuppetResourceRequest.type, requestParams)
                 .then((resourceResult) => {
                   this.respsonseToVSCodeEdit(resourceResult, editor, doc);
                 });
             },
           );
         } else {
-          thisCommand._connectionHandler.languageClient
+          this._connectionHandler.languageClient
             .sendRequest(PuppetResourceRequest.type, requestParams)
             .then((resourceResult) => {
               this.respsonseToVSCodeEdit(resourceResult, editor, doc);

src/feature/PuppetStatusBarFeature.ts

@@ -1,11 +1,12 @@
+/* eslint-disable @typescript-eslint/no-use-before-define */
 'use strict';
 
 import * as vscode from 'vscode';
+import { IAggregateConfiguration } from '../configuration';
 import { IFeature } from '../feature';
-import { ILogger } from '../logging';
 import { ConnectionStatus } from '../interfaces';
+import { ILogger } from '../logging';
 import { PuppetCommandStrings } from '../messages';
-import { IAggregateConfiguration } from '../configuration';
 import { ProtocolType } from '../settings';
 
 class PuppetStatusBarProvider {
@@ -116,6 +117,7 @@ class PuppetStatusBarProvider {
 class PuppetConnectionMenuItem implements vscode.QuickPickItem {
   public description = '';
 
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   constructor(public readonly label: string, public readonly callback: () => void = () => {}) {}
 }