Sync with current Cookiecutter template

.editorconfig

@@ -23,8 +23,8 @@ indent_size = 2
 indent_size = 2
 trim_trailing_whitespace = false
 
-[*.ts]
+[*.{mjs,ts}]
 indent_size = 2
 
-[*.yml]
+[*.{yaml,yml}]
 indent_size = 2

.gitattributes

@@ -20,10 +20,13 @@
 
 *.json          text eol=lf
 *.md            text eol=lf
+*.mjs           text eol=lf
 *.ts            text eol=lf
+*.txt           text eol=lf
+*.yaml          text eol=lf
 *.yml           text eol=lf
 
 # No need to diff or patch these
+/.yarn/plugins/**               binary
 /.yarn/releases/*.cjs           binary
 /.yarn/sdks/**                  binary
-/.yarn/plugins/**               binary

.github/workflows/unit-tests.yml

@@ -0,0 +1,38 @@
+name: Run unit tests
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install yarn if not present
+        run: |-
+          if which yarn; then
+            exit
+          fi
+          curl -fsSL --create-dirs -o ~/bin/yarn \
+            https://github.com/yarnpkg/yarn/releases/download/v1.22.19/yarn-1.22.19.js
+          chmod +x ~/bin/yarn
+          echo ~/bin >> "${GITHUB_PATH}"
+
+      - name: Use specified Node.js version
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: .nvmrc
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Compile
+        run: yarn compile
+
+      - name: Run linter
+        run: yarn lint
+
+      - name: Run unit tests
+        run: yarn test

.gitignore

@@ -1,7 +1,3 @@
-/extension/build/
-/extension/dist/
-/extension/examples/
-/extension/work/
 /.pnp.*
 /.yarn/*
 !/.yarn/patches/

.vscode/extensions.json

@@ -6,6 +6,7 @@
     "dbaeumer.vscode-eslint",
     "editorconfig.editorconfig",
     "henrynguyen5-vsc.vsc-nvm",
+    "orta.vscode-jest",
     "redhat.vscode-yaml"
   ]
 }

.vscode/launch.json

@@ -5,10 +5,11 @@
       "type": "extensionHost",
       "request": "launch",
       "args": [
-        "--extensionDevelopmentPath=${workspaceFolder}/extension"
+        "--extensionDevelopmentPath=${workspaceFolder}/extension/build"
       ],
       "outFiles": [
-        "${workspaceFolder}/extension/build/**/*.js"
+        "${workspaceFolder}/extension/build/**/*.js",
+        "${workspaceFolder}/extension/build/**/*.js.map"
       ],
       "preLaunchTask": "Compile"
     }

.yarn/sdks/typescript/lib/tsserver.js

@@ -93,6 +93,8 @@ const moduleWrapper = tsserver => {
             str = `zip:${str}`;
           } break;
         }
+      } else {
+        str = str.replace(/^\/?/, process.platform === `win32` ? `` : `/`);
       }
     }
 

.yarn/sdks/typescript/lib/tsserverlibrary.js

@@ -93,6 +93,8 @@ const moduleWrapper = tsserver => {
             str = `zip:${str}`;
           } break;
         }
+      } else {
+        str = str.replace(/^\/?/, process.platform === `win32` ? `` : `/`);
       }
     }
 

.yarn/sdks/typescript/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typescript",
-  "version": "5.0.2-sdk",
+  "version": "5.1.6-sdk",
   "main": "./lib/typescript.js",
   "type": "commonjs"
 }

.yarnrc.yml

@@ -1,9 +1,7 @@
 enableGlobalCache: true
 
-nodeLinker: pnp
-
 plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-outdated.cjs
     spec: "https://mskelton.dev/yarn-outdated/v3"
 
-yarnPath: .yarn/releases/yarn-3.5.0.cjs
+yarnPath: .yarn/releases/yarn-3.6.1.cjs

README.md

@@ -67,16 +67,21 @@ the following numbering scheme:
 
 ### Publishing to the Marketplace
 
-After deciding on a target version, run:
+1. Check out the `main` branch and make sure it is pristine.
 
-- `git checkout main`
-- `yarn login`
-- `yarn publish-vsce [--pre-release] [version]`
+2. Decide on a new version number under which to publish the package.
 
-The `yarn publish-vsce` command first updates the version number in
-[extension/package.json](./extension/package.json) to the given
-version. Then it packages and publishes the extension to the VS Code
-Extension Marketplace.
+3. Edit the `extension/share/dist/package.json` manifest to reflect
+   the new version number.
+
+4. Run: `yarn package`
+
+5. If necessary, run: `yarn workspace extension login`
+
+6. Run: `yarn workspace extension publish-vsce`
+
+The final `yarn […] publish-vsce` command packages and publishes the
+extension to the VS Code Extension Marketplace.
 
 ### Publishing to the Open VSX Registry
 
@@ -96,13 +101,16 @@ Follow these steps to publish the extension to the Open VSX Registry:
 
 2. Make sure you have published the extension to the VS Code
    Extension Marketplace. This ensures that the version number has
-   been updated and that a `.vsix` file has been generated.
+   been updated.
+
+3. Run `yarn package` to generate a `.vsix` package.
 
-3. Run the `yarn ovsx publish` command with the correct
-   `extension/[…].vsix` file as the sole argument. Example in Bash:
+4. Run the `yarn […] ovsx publish` command with the correct
+   `extension/dist/[…].vsix` file as the sole argument.  
+   Example in Bash:
 
    ```bash
-   yarn ovsx publish "extension/ifm-$(jq -r .version extension/package.json).vsix"
+   yarn workspace extension ovsx publish "dist/ifm-$(jq -r .version extension/share/dist/package.json).vsix"
    ```
 
 ### Committing, tagging and creating a GitHub prerelease and PR
@@ -111,17 +119,17 @@ With the extension now published on the Marketplace, commit the
 change, create a tag, push, cut a GitHub (pre-)release, and create a
 pull request against `main`:
 
-```
+```bash
 (
   set -eux
   git checkout -b publish
-  tag="$(jq -r '"v" + .version' extension/package.json)"
+  tag="$(jq -r '"v" + .version' extension/share/dist/package.json)"
   echo "New tag: ${tag}"
   git add -u
   git commit --edit -m "Release ${tag}"
   git tag "${tag}"
   git push --tags
-  gh release create --generate-notes --prerelease "${tag}"
+  gh release create --draft --generate-notes "${tag}"
   gh pr create --fill --web
 )
 ```
@@ -168,7 +176,7 @@ dependencies. That includes the `@types`, `@typescript-eslint`, and
 `yarn upgrade-yarn-itself` section).
 
 Also excluded is the `@types/vscode` package. For details, see
-section _Upgrading the VS Code API_.
+section _Upgrading the VS Code API version_.
 
 ### yarn upgrade-yarn-itself
 
@@ -217,13 +225,13 @@ To start editing a dependency, run `yarn patch <dependency>`.
 For example, to start editing the `vsce` executable, run:
 
 ```shell
-yarn patch @vscode/vsce@npm:2.18.0
+yarn patch @vscode/vsce@npm:2.19.0
 ```
 
 Since this project is already patching this dependency, you may want to apply the existing patch to the temporary working directory:
 
 ```shell
-patch < path/to/this/project/.yarn/patches/@vscode-vsce-npm-2.18.0-c171711221.patch
+patch < path/to/this/project/.yarn/patches/@vscode-vsce-npm-2.19.0-c171711221.patch
 ```
 
 ### Committing a patch for the first time
@@ -247,7 +255,7 @@ Note: `yarn repatch` is a custom script. It serves to work around two issues in
 - It may also use an incorrect key in the resolution entry it writes to `package.json`.  
   The key should match the dependency’s semver expression, not the resolved version.
   Using the latter as a key causes the resolution to never apply.  
-  Example for a correct key: `"@vscode/vsce@^2.18.0"`
+  Example for a correct key: `"@vscode/vsce@^2.19.0"`
 
 ## Handling vulnerable dependencies
 
@@ -329,7 +337,7 @@ source code repository:
 | `.` | This directory | Apache-2.0 | [License](./LICENSE)<br>with License header below |
 | `./.yarn/releases` | The `yarn` package manager | BSD-2-Clause | [License](./.yarn/releases/LICENSE) |
 | `./.yarn/sdks` | SDK files for `yarn` | BSD-2-Clause | [License](./.yarn/sdks/LICENSE) |
-| `./extension` | The source code for this VS Code extension | Apache-2.0 | [License](./extension/LICENSE.txt)<br>with [License header](./extension/README.md#license) |
+| `./extension` | Front-end source code for this VS Code extension | Apache-2.0 | [License](./extension/LICENSE.txt)<br>with [License header](./extension/README.md#license) |
 
 In each of the directories the table mentions, you will find one
 license file, named `LICENSE` or `LICENSE.txt`.  

.eslintrc.yaml → extension/.eslintrc.yaml

@@ -2,14 +2,18 @@ env:
   node: true
 extends:
   - eslint:recommended
-  - plugin:@typescript-eslint/recommended-requiring-type-checking
+  - plugin:@typescript-eslint/recommended-type-checked
+  - plugin:@typescript-eslint/stylistic-type-checked
+ignorePatterns:
+  - build/
+  - work/
 parser: "@typescript-eslint/parser"
 parserOptions:
   ecmaFeatures:
     impliedStrict: true
   ecmaVersion: 2022
   project:
-    - extension/tsconfig.json
+    - tsconfig.json
 plugins:
   - "@typescript-eslint"
 root: true
@@ -30,7 +34,10 @@ rules:
   default-case-last: 1
   default-case: 2
   dot-location: [1, property]
-  dot-notation: [1, { allowKeywords: false }]
+
+  # For compatibility with typescript-eslint
+  dot-notation: 0
+
   eqeqeq: 1
   func-call-spacing: 1
   generator-star-spacing: [1, before]
@@ -64,17 +71,13 @@ rules:
   no-octal-escape: 2
   no-return-assign: 1
   no-self-compare: 1
-
-  # For compatibility with typescript-eslint
-  no-shadow: 0
-
+  no-shadow: 1
   no-tabs: 2
   no-template-curly-in-string: 1
   no-throw-literal: 2
   no-trailing-spaces: 1
   no-undefined: 1
   no-unexpected-multiline: 1
-  no-unreachable: 1
   no-unused-expressions: 1
 
   # For compatibility with typescript-eslint
@@ -115,16 +118,16 @@ rules:
   yoda: 1
 
   "@typescript-eslint/array-type": 1
+  "@typescript-eslint/dot-notation": 1
 
   # In VS Code, this allows developers to manually specify
   # inferrable types so the distracting inline hints go away
   "@typescript-eslint/no-inferrable-types": 0
 
-  "@typescript-eslint/no-shadow": 1
-
   # https://github.com/typescript-eslint/typescript-eslint/issues/4912
   "@typescript-eslint/no-unsafe-argument": 0
   "@typescript-eslint/no-unsafe-assignment": 0
   "@typescript-eslint/no-unsafe-member-access": 0
 
+  "@typescript-eslint/no-unused-vars": [1, { argsIgnorePattern: ^_,  varsIgnorePattern: ^_ }]
   "@typescript-eslint/unbound-method": 0

extension/.gitignore

@@ -0,0 +1,5 @@
+/build/
+/dist/
+/examples/
+/types/
+/work/