refactor: Refactored to use an extension controller + require return …

…types (#92)

- Refactored `extension` module to use a controller class. This should
make things easier to test and encourages better architecture
- Enabled linting rule to require return types + fixed offending code

supports #79

.eslintrc.json

@@ -19,6 +19,11 @@
   "overrides": [
     {
       "files": ["*.ts"],
+      // Since parserOptions.project is used, can't include files outside of
+      // the listed tsconfig files and seems silly to add a tsconfig just for
+      // the one file. It will still be linted by the base config above. It just
+      // won't be included in this overrides section.
+      "excludedFiles": ["vitest.config.ts"],
       "parserOptions": {
         "project": [
           "./tsconfig.json",
@@ -29,7 +34,8 @@
 
       "rules": {
         "no-return-await": "off",
-        "@typescript-eslint/return-await": "error"
+        "@typescript-eslint/return-await": "error",
+        "@typescript-eslint/explicit-function-return-type": "error"
       }
     }
   ],

.vscodeignore

@@ -7,8 +7,10 @@ src/**
 .yarnrc
 vsc-extension-quickstart.md
 **/tsconfig.json
+**/tsconfig.unit.json
 **/.eslintrc.json
 **/*.map
 **/*.ts
+**/__mocks__/**
 e2e/**
 test-reports/**

e2e/testUtils.ts

@@ -11,7 +11,9 @@ export const PYTHON_AND_GROOVY_SERVER_CONFIG = [
 /**
  * Find the connection status bar item if it is visible.
  */
-export async function findConnectionStatusBarItem() {
+export async function findConnectionStatusBarItem(): Promise<
+  WebdriverIO.Element | undefined
+> {
   const workbench = await browser.getWorkbench();
 
   return workbench.getStatusBar().getItem(
@@ -23,7 +25,7 @@ export async function findConnectionStatusBarItem() {
 /**
  * Check if the connection status bar item is visible.
  */
-export async function hasConnectionStatusBarItem() {
+export async function hasConnectionStatusBarItem(): Promise<boolean> {
   return (await findConnectionStatusBarItem()) != null;
 }
 

e2e/tsconfig.json

@@ -14,6 +14,7 @@
     "moduleResolution": "node",
     "esModuleInterop": true
   },
-  // Override ../tsconfig.json `exclude`
+  // Override ../tsconfig.json `include` and `exclude`
+  "include": ["."],
   "exclude": ["node_modules"]
 }

src/__mocks__/vscode.ts

@@ -0,0 +1,10 @@
+/**
+ * Mock `vscode` module. Note that `vi.mock('vscode')` has to be explicitly
+ * called in any test module needing to use this mock. It will not be loaded
+ * automatically.
+ */
+import { vi } from 'vitest';
+
+export const workspace = {
+  getConfiguration: vi.fn().mockReturnValue(new Map()),
+};

src/dh/dhc.ts

@@ -26,7 +26,7 @@ export function getEmbedWidgetUrl(
   serverUrl: string,
   title: string,
   psk?: string
-) {
+): string {
   serverUrl = serverUrl.replace(/\/$/, '');
   return `${serverUrl}/iframe/widget/?name=${title}${psk ? `&psk=${psk}` : ''}`;
 }