Merge pull request #184 from Techatrix/dev

code formatting, strict typechecking, linting, code cleanup and bugfixes

.github/workflows/main.yml

@@ -7,10 +7,15 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v1
-      - name: build
+      - uses: actions/checkout@v4
+
+      - run: npm install
+      - run: npm run build
+      - run: npm run typecheck
+      - run: npm run lint
+      - run: npm run format -- --check
+
+      - name: package extension
         run: |
-          npm install
-          npm run compile
           npx vsce package
           ls -lt *.vsix

.prettierignore

@@ -0,0 +1,3 @@
+node_modules
+out
+*.md

.prettierrc

@@ -0,0 +1,12 @@
+{
+    "printWidth": 120,
+    "tabWidth": 4,
+    "overrides": [
+        {
+            "files": ["*.yml", "*.yaml", "package-lock.json", "package.json", "syntaxes/*.json"],
+            "options": {
+                "tabWidth": 2
+            }
+        }
+    ]
+}

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+    "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
+}

.vscode/launch.json

@@ -1,18 +1,14 @@
 {
-    "version": "0.1.0",
+    "version": "0.2.0",
     "configurations": [
         {
             "type": "extensionHost",
             "request": "launch",
             "name": "Launch Extension",
             "runtimeExecutable": "${execPath}",
-            "args": [
-                "--extensionDevelopmentPath=${workspaceFolder}"
-            ],
-            "outFiles": [
-                "${workspaceFolder}/out/**/*.js"
-            ],
-            "preLaunchTask": "npm: compile"
+            "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
+            "outFiles": ["${workspaceFolder}/out/**/*.js"],
+            "preLaunchTask": "Build Extension"
         }
     ]
-}
+}

.vscode/settings.json

@@ -5,5 +5,9 @@
     },
     "search.exclude": {
         "out": true // set this to false to include "out" folder in search results
-    }
-}
+    },
+    // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+    "typescript.tsc.autoDetect": "off",
+    "eslint.experimental.useFlatConfig": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+}

.vscode/tasks.json

@@ -4,17 +4,23 @@
     "version": "2.0.0",
     "tasks": [
         {
+            "label": "Build Extension in Background",
+            "group": "build",
             "type": "npm",
             "script": "watch",
-            "problemMatcher": "$tsc-watch",
-            "isBackground": true,
-            "presentation": {
-                "reveal": "never"
+            "problemMatcher": {
+                "base": "$tsc-watch"
             },
-            "group": {
-                "kind": "build",
-                "isDefault": true
+            "isBackground": true
+        },
+        {
+            "label": "Build Extension",
+            "group": "build",
+            "type": "npm",
+            "script": "build",
+            "problemMatcher": {
+                "base": "$tsc"
             }
         }
     ]
-}
+}

eslint.config.mjs

@@ -0,0 +1,27 @@
+// @ts-check
+
+import prettierConfig from "eslint-config-prettier";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config({
+    files: ["**/*.ts"],
+    extends: [...tseslint.configs.stylisticTypeChecked, ...tseslint.configs.strictTypeChecked],
+    rules: {
+        ...prettierConfig.rules,
+        "@typescript-eslint/naming-convention": "error",
+        "@typescript-eslint/switch-exhaustiveness-check": "error",
+        eqeqeq: "error",
+        "no-throw-literal": "off",
+        "@typescript-eslint/only-throw-error": "error",
+        "no-shadow": "off",
+        "@typescript-eslint/no-shadow": "error",
+        "no-duplicate-imports": "error",
+        "sort-imports": ["error", { allowSeparatedGroups: true }],
+    },
+    languageOptions: {
+        parserOptions: {
+            project: true,
+            tsconfigRootDir: "__dirname",
+        },
+    },
+});

language-configuration.json

@@ -31,21 +31,21 @@
         {
             "beforeText": "^\\s*//!.*$",
             "action": {
-                "indent": "none", 
+                "indent": "none",
                 "appendText": "//! "
             }
         },
         {
             "beforeText": "^\\s*///.*$",
             "action": {
-                "indent": "none", 
+                "indent": "none",
                 "appendText": "/// "
             }
         },
         {
             "beforeText": "^\\s*\\\\\\\\.*$",
             "action": {
-                "indent": "none", 
+                "indent": "none",
                 "appendText": "\\\\"
             }
         }