Merge branch 'VSC-574-ha_initial_commit2' into 'master'

VSC-574 Initial commit

Closes VSC-574

See merge request ide/vscode/iar-vsc-common-testutils!2

Author: HampusAdolfsson

.github/workflows/build.yml

@@ -0,0 +1,13 @@
+name: build
+on: [push, workflow_dispatch]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 'lts/*'
+      - run: npm install
+      - run: npm run lint
+      - run: npm run prepare

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+dist/

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+node .husky/pre-commit.js

.husky/pre-commit.js

@@ -0,0 +1,34 @@
+/// -----------------------------
+// This hook forces all source files in the repository to have the MPL license header at the start of the file.
+/// -----------------------------
+
+const { readFileSync } = require("fs");
+const { exit } = require("process");
+var proc = require('child_process');
+
+function runAndGetStdout(command, callback) {
+    proc.exec(command, function(error, stdout, stderr) {
+        callback(stdout);
+    });
+};
+
+const MPLv2_header = `/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */`
+
+runAndGetStdout("git diff --cached --name-only --diff-filter=ACMR", function(changedFiles) {
+    const filesArray = changedFiles.trim().split("\n");
+    // Check that all typescript files have the mpl preamble
+    const res = filesArray.filter(file => file.endsWith(".ts"))
+        .map(file => {
+            const contents = readFileSync(file).toString().replace(/\r\n/g, "\n");
+            if (!contents.startsWith(MPLv2_header)) {
+                console.log("Missing or malformed MPLv2 license header in file: " + file);
+                return false;
+            }
+            return true;
+        });
+    if (!res.every(v => v)) {
+        exit(1);
+    }
+});

.vscode/tasks.json

@@ -0,0 +1,13 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "watch",
+      "group": "build",
+      "problemMatcher": ["$tsc-watch"],
+      "label": "npm: watch",
+      "detail": "tsc -p . --watch"
+    }
+  ]
+}

README.md

@@ -0,0 +1,35 @@
+# iar-vsc-common-testutils
+
+This package contains testing- and development code that is shared between IAR VS Code extensions.
+
+This package is not meant to be published to a package registry; rather, it should be used by adding a `package.json`
+dependency on this repository:
+```json
+"dependencies": {
+    ...
+    "iar-vsc-common-testutils": "git@github.com:IARSystems/iar-vsc-common-testutils.git#<tag>"
+}
+```
+The typescript source code is transpiled on installation.
+
+For development, it is practical to use a local version of this repository. Simply clone this repository next to the extension repositories. Then, in the extension directory, run:
+```sh
+npm link <path-to>/iar-vsc-common-testutils
+```
+The link stays active until you next run `npm install` or `npm unlink`
+
+To use your changes in the extensions, commit your changes, then create and push a tag:
+```sh
+git tag v1.1.1
+git push origin tag v1.1.1
+```
+
+In the extension(s) `package.json` file, update the dependency to the new tag.
+
+```json
+"dependencies": {
+    ...
+    "iar-vsc-common-testutils": "git@github.com:IARSystems/iar-vsc-common-testutils.git#v1.1.1"
+}
+```
+

eslint.config.mjs

@@ -0,0 +1,49 @@
+// @ts-check
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+import globals from "globals";
+
+export default tseslint.config(
+    {
+        ignores: ["dist/**"],
+    },
+    {
+        extends: [
+            eslint.configs.recommended,
+            ...tseslint.configs.recommended,
+        ],
+        files: ["**/*.ts"],
+        languageOptions: {
+            globals: globals.node,
+            parserOptions: {
+                project: ["./tsconfig.json"],
+            },
+        },
+        rules: {
+            "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }], // Same as in tsconfig. Allow such vars if they start with an underscore.
+            "require-await": "error",                                   // Helps catch missing awaits
+            "strict": "error",                                          // Disallows use of e.g. reserved keywords
+            "prefer-promise-reject-errors": "error",                    // Throwing real Errors helps traceability
+            "@typescript-eslint/no-namespace": "off",
+            "@typescript-eslint/prefer-readonly": "error",
+            "@typescript-eslint/consistent-type-definitions": "error",  // Prefer 'interface' over 'type'
+            "@typescript-eslint/no-non-null-assertion": "warn",
+            "no-empty": "off",                                          // Empty catch blocks can be useful
+            "no-inner-declarations": "off",                             // Seems to break when using TS namespaces
+            "eqeqeq": "error",                                          // == can be obscure/unintuitive, so use ===
+            "@typescript-eslint/no-deprecated": "warn",
+            // CODE FORMATTING =================
+            "semi": "warn",
+            "camelcase": "warn",
+            "indent": ["warn", 4],
+            "space-before-blocks": "warn",
+            "keyword-spacing": "warn",
+            "space-before-function-paren": ["warn", "never"],
+            "dot-location": "warn",
+            "quotes": ["warn", "double", { "allowTemplateLiterals": true }],  // Disallows single quote strings
+            "comma-spacing": "warn",
+            "brace-style": "warn",
+            "no-trailing-spaces": "warn",
+        },
+    },
+);