fix(lint): adjust eslint settings and fix warnings (#304)

Defaults are coming from eslint:recommended from this section here:
```
"extends": [
    "eslint:recommended",
    "plugin:@typescript-eslint/recommended"
],
```
With a few changes specific to the Google style guide and our codebase.

The config for naming conventions is mostly a copy of the default
[here](https://typescript-eslint.io/rules/naming-convention#options)

But with a few adjustments to allow snake_case properties, PascalCase
globals, and PascalCase enum members.

Eventually we will turn off explicit-any when our protocol messages are
properly typed.

Author: chmeyer-ms

.eslintrc.json

@@ -8,12 +8,44 @@
     "plugins": [
         "@typescript-eslint"
     ],
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
     "rules": {
-        "@typescript-eslint/naming-convention": "warn",
+        "@typescript-eslint/naming-convention": [
+            "warn",
+            { 
+                "selector": "default", 
+                "format": ["camelCase", "snake_case"], // protocol messages use snake_case
+                "leadingUnderscore": "allow"
+            },
+            {
+                "selector": "enumMember",
+                "format": ["PascalCase"],
+                "leadingUnderscore": "allow"
+            },
+            {
+                "selector": "variable",
+                "format": ["UPPER_CASE", "PascalCase"], // TODO: remove PascalCase uses
+                "modifiers": ["global", "const"]
+            },
+            {
+                "selector": "typeLike",
+                "format": ["PascalCase"]
+            }
+        ],
+        "@typescript-eslint/no-explicit-any": "off", // TODO: enable when messages are typed
+        "@typescript-eslint/no-non-null-assertion": "off",
         "@typescript-eslint/semi": ["warn", "always"],
         "curly": "warn",
         "eqeqeq": "warn",
-        "no-throw-literal": "warn"
+        // indent 4 spaces
+        "indent": ["warn", 4, { "SwitchCase": 1 }],
+        "no-throw-literal": "warn",
+        // turn off base rules as they can report incorrect errors
+        "no-unused-vars": "off",
+        "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }]
     },
     "ignorePatterns": [
         "**/*.d.ts"

src/config-provider.ts

@@ -1,4 +1,3 @@
-
 // Copyright (C) Microsoft Corporation.  All rights reserved.
 
 import * as vscode from 'vscode';
@@ -7,26 +6,27 @@ import * as vscode from 'vscode';
 // Custom fields specified in package.json.
 //
 export class ConfigProvider implements vscode.DebugConfigurationProvider {
+    resolveDebugConfiguration(
+        folder: vscode.WorkspaceFolder | undefined,
+        config: vscode.DebugConfiguration
+    ): vscode.ProviderResult<vscode.DebugConfiguration> {
+        // set some defaults to allow attach without a launch.json
+        if (!config.type) {
+            config.type = 'minecraft-js';
+        }
+        if (!config.request) {
+            config.request = 'attach';
+        }
+        if (!config.name) {
+            config.name = 'Attach to Minecraft';
+        }
+        if (!config.localRoot) {
+            config.localRoot = '${workspaceFolder}/scripts/';
+        }
+        if (!config.port) {
+            config.inputPort = '${command:PromptForPort}'; // prompt user for port
+        }
 
-	resolveDebugConfiguration(folder: vscode.WorkspaceFolder | undefined, config: vscode.DebugConfiguration, token?: vscode.CancellationToken): vscode.ProviderResult<vscode.DebugConfiguration> {
-
-		// set some defaults to allow attach without a launch.json
-		if (!config.type) {
-			config.type = 'minecraft-js';
-		}
-		if (!config.request) {
-			config.request = 'attach';
-		}
-		if (!config.name) {
-			config.name = 'Attach to Minecraft';
-		}
-		if (!config.localRoot) {
-			config.localRoot = "${workspaceFolder}/scripts/";
-		}
-		if (!config.port) {
-			config.inputPort = "${command:PromptForPort}"; // prompt user for port
-		}
-
-		return config;
-	}
+        return config;
+    }
 }

src/extension.ts

@@ -11,7 +11,7 @@ import { ReplayStatsProvider } from './stats/replay-stats-provider';
 
 // called when extension is activated
 //
-export function activate(context: vscode.ExtensionContext) {
+export function activate(context: vscode.ExtensionContext): void {
     const liveStatsProvider = new StatsProvider('Live', 'minecraftDiagnosticsLive');
     const eventEmitter: EventEmitter = new EventEmitter();
 
@@ -24,7 +24,7 @@ export function activate(context: vscode.ExtensionContext) {
     context.subscriptions.push(vscode.debug.registerDebugConfigurationProvider('minecraft-js', configProvider));
 
     // register a debug adapter descriptor factory for 'minecraft-js', this factory creates the DebugSession
-    let descriptorFactory = new ServerDebugAdapterFactory(homeViewProvider, liveStatsProvider, eventEmitter);
+    const descriptorFactory = new ServerDebugAdapterFactory(homeViewProvider, liveStatsProvider, eventEmitter);
     context.subscriptions.push(vscode.debug.registerDebugAdapterDescriptorFactory('minecraft-js', descriptorFactory));
     if ('dispose' in descriptorFactory) {
         context.subscriptions.push(descriptorFactory);
@@ -51,7 +51,7 @@ export function activate(context: vscode.ExtensionContext) {
     // Create a command to allow keyboard shortcuts to run Minecraft commands
     const runMinecraftCommand = vscode.commands.registerCommand(
         'minecraft-debugger.runMinecraftCommand',
-        (...args: any[]) => {
+        (...args: unknown[]) => {
             if (args.length === 0) {
                 vscode.window.showErrorMessage('No command provided.');
                 return;
@@ -79,8 +79,8 @@ export function activate(context: vscode.ExtensionContext) {
                 canSelectMany: false,
                 openLabel: 'Open',
                 filters: {
-                    'MC Stats Files': ['mcstats'],
-                    'All Files': ['*'],
+                    'MC Stats Files': ['mcstats'], // eslint-disable-line @typescript-eslint/naming-convention
+                    'All Files': ['*'], // eslint-disable-line @typescript-eslint/naming-convention
                 },
             });
             if (!fileUri || fileUri.length === 0) {
@@ -101,7 +101,3 @@ export function activate(context: vscode.ExtensionContext) {
         replayDiagnosticsCommand
     );
 }
-
-// called when extension is deactivated
-//
-export function deactivate() {}

src/message-stream-parser.ts

@@ -1,30 +1,31 @@
-
 // Copyright (C) Microsoft Corporation.  All rights reserved.
 
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const Parser = require('stream-parser');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const Transform = require('stream').Transform;
 
 // Data transform attached to socket.
 // Parses messages to json as they arrive from debugee,
 // then raises them as events for consumption by the DA.
 //
 export class MessageStreamParser extends Transform {
-	constructor() {
-		super();
-		this._bytes(9, this.onLength);
-	}
+    constructor() {
+        super();
+        this._bytes(9, this.onLength);
+    }
 
-	private onLength(buffer: Buffer) {
-		let length = parseInt(buffer.toString(), 16);
-		this.emit('length', length);
-		this._bytes(length, this.onMessage);
-	}
+    private onLength(buffer: Buffer) {
+        const length = parseInt(buffer.toString(), 16);
+        this.emit('length', length);
+        this._bytes(length, this.onMessage);
+    }
 
-	private onMessage(buffer: Buffer) {
-		let json = JSON.parse(buffer.toString());
-		this.emit('message', json);
-		this._bytes(9, this.onLength);
-	}
+    private onMessage(buffer: Buffer) {
+        const json = JSON.parse(buffer.toString());
+        this.emit('message', json);
+        this._bytes(9, this.onLength);
+    }
 }
 
-Parser(MessageStreamParser.prototype);
+Parser(MessageStreamParser.prototype);

src/panels/home-view-provider.ts

@@ -20,7 +20,7 @@ export class HomeViewProvider implements vscode.WebviewViewProvider {
         this._eventEmitter = eventEmitter;
     }
 
-    public setDebuggerStatus(isConnected: boolean, minecraftCapabilities: MinecraftCapabilities) {
+    public setDebuggerStatus(isConnected: boolean, minecraftCapabilities: MinecraftCapabilities): void {
         this._view?.webview.postMessage({
             type: 'debugger-status',
             isConnected: isConnected,
@@ -33,11 +33,7 @@ export class HomeViewProvider implements vscode.WebviewViewProvider {
         this._eventEmitter.emit('request-debugger-status');
     }
 
-    public resolveWebviewView(
-        webviewView: vscode.WebviewView,
-        _context: vscode.WebviewViewResolveContext,
-        _token: vscode.CancellationToken
-    ) {
+    public resolveWebviewView(webviewView: vscode.WebviewView): void {
         this._view = webviewView;
 
         this._view.webview.options = {

src/panels/minecraft-diagnostics.ts

@@ -99,7 +99,7 @@ export class MinecraftDiagnosticsPanel {
         this._statsTracker.addStatListener(this._statsCallback);
     }
 
-    public static render(extensionUri: Uri, statsTracker: StatsProvider) {
+    public static render(extensionUri: Uri, statsTracker: StatsProvider): void {
         const statsTrackerId = statsTracker.uniqueId;
         const existingPanel = MinecraftDiagnosticsPanel.activeDiagnosticsPanels.find(
             panel => panel._statsTracker.uniqueId === statsTrackerId
@@ -126,7 +126,7 @@ export class MinecraftDiagnosticsPanel {
         }
     }
 
-    public dispose() {
+    public dispose(): void {
         if (this._statsCallback !== undefined) {
             this._statsTracker.removeStatListener(this._statsCallback);
             this._statsCallback = undefined;

src/server-debug-adapter-factory.ts

@@ -21,10 +21,7 @@ export class ServerDebugAdapterFactory implements vscode.DebugAdapterDescriptorF
         this._eventEmitter = eventEmitter;
     }
 
-    createDebugAdapterDescriptor(
-        _session: vscode.DebugSession,
-        _executable: vscode.DebugAdapterExecutable | undefined
-    ): vscode.ProviderResult<vscode.DebugAdapterDescriptor> {
+    createDebugAdapterDescriptor(): vscode.ProviderResult<vscode.DebugAdapterDescriptor> {
         if (!this.server) {
             // start listening on a random port
             this.server = Net.createServer(socket => {
@@ -38,7 +35,7 @@ export class ServerDebugAdapterFactory implements vscode.DebugAdapterDescriptorF
         return new vscode.DebugAdapterServer((this.server.address() as Net.AddressInfo).port);
     }
 
-    dispose() {
+    dispose(): void {
         if (this.server) {
             this.server.close();
         }