Merge branch 'master' into surround-fixup

Author: sql-koala

.github/CONTRIBUTING.md

@@ -16,6 +16,7 @@ When creating a new bug report do:
 
 ### Improve Existing Issues
 
+- Try to replicate bugs and describe the method if you're able to.
 - Search for [duplicate issues](https://github.com/VSCodeVim/Vim/issues?q=is%3Aissue+is%3Aopen+cursor). See which thread(s) are more mature, and recommend the duplicate be closed, or just provide links to related issues.
 - Find [old issues](https://github.com/VSCodeVim/Vim/issues?page=25&q=is%3Aissue+is%3Aopen) and test them in the latest version of VSCodeVim. If the issue has been resolved, comment & recommend OP to close (or provide more information if not resolved).
 - Give thumbs up / thumbs down to existing issues, to indicate your support (or not)
@@ -29,40 +30,60 @@ When submitting a PR, please fill out the template that is presented by GitHub w
 
 ## First Time Setup
 
-1.  Install prerequisites:
-    - latest [Visual Studio Code](https://code.visualstudio.com/)
-    - [Node.js](https://nodejs.org/) v12.0.0 or higher
-    - [Yarn](https://classic.yarnpkg.com/) v1.x
-    - _Optional_: [Docker Community Edition](https://store.docker.com/search?type=edition&offering=community) 🐋
-1.  In a terminal:
+1. Install prerequisites:
 
-    ```bash
-    # fork and clone the repository
-    git clone git@github.com:<YOUR-FORK>/Vim.git
-    cd Vim
+   - [Visual Studio Code](https://code.visualstudio.com/), latest stable or insiders
+   - [Node.js](https://nodejs.org/) v14.0.0 or higher
+   - [Yarn](https://classic.yarnpkg.com/) v1.x
+   - _Optional_: [Docker Community Edition](https://store.docker.com/search?type=edition&offering=community) 🐋
 
-    # Install the dependencies
-    yarn install
+2. Fork and clone repository:
 
-    # Open in VSCode
-    code .
+   ```bash
+   git clone git@github.com:<YOUR-FORK>/Vim.git
+   cd Vim
+   ```
 
-    # Choose the "Build, Run Extension" in the dropdown of VSCode's
-    # debug tab to build and run the extension.
-    # Or run tests by selecting the appropriate drop down option
+3. Build extension:
 
-    # Alternatively, build and run tests through gulp and npm scripts
-    npx gulp build                  # build
-    npx gulp prepare-test           # build tests
-    yarn test                       # test (must close all instances of VSCode)
+   ```bash
+   # Install the dependencies
+   yarn install
 
-    # Only available if Docker is installed and running
-    npx gulp test                   # run tests inside Docker container
-    npx gulp test --grep testSuite  # run only tests/suites filtered by js regex inside container
+   # Open in VS Code
+   code .
 
-    # Alternatively, build .vsix extension and load it into VSCode for manual testing
-    yarn run vsce package --web     # build vim-xxx.vsix
-    ```
+   # Build with one of these...
+   npx gulp build-dev # Fast build for development
+   npx gulp build     # Slow build for release
+   yarn watch         # Fast build whenever a file changes
+   ```
+
+4. Run extension using VS Code's "Run and Debug" menu
+
+5. Run tests:
+
+   ```bash
+   # If Docker is installed and running:
+   npx gulp test                   # Run tests inside Docker container
+   npx gulp test --grep <REGEX>    # Run only tests/suites matching <REGEX> inside Docker container
+
+   # Otherwise, build and run the tests locally:
+   npx gulp build                  # Build
+   npx gulp prepare-test           # Build tests
+   yarn test                       # Test (must close all instances of VS Code)
+   ```
+
+6. Package and install extension:
+
+   ```bash
+   # Package extension into `vim-<MAJOR>.<MINOR>.<PATCH>.vsix`
+   # (This can be opened and inspected like a .zip file)
+   yarn package
+
+   # Install packaged extension to your local VS Code installation
+   code --install-extension vim-<MAJOR>.<MINOR>.<PATCH>.vsix --force
+   ```
 
 ## Code Architecture
 
@@ -90,43 +111,44 @@ Consists of two data structures:
 
 #### How it works
 
-1.  `handleKeyEventHelper` is called with the most recent keypress.
-2.  `Actions.getRelevantAction` determines if all the keys pressed so far uniquely specify any action in actions.ts. If not, we continue waiting for keypresses.
-3.  `runAction` runs the action that was matched. Movements, Commands and Operators all have separate functions that dictate how to run them - `executeMovement`, `handleCommand`, and `executeOperator` respectively.
-4.  Now that we've updated VimState, we run `updateView` with the new VimState to "redraw" VSCode to the new state.
+1. `handleKeyEventHelper` is called with the most recent keypress.
+2. `Actions.getRelevantAction` determines if all the keys pressed so far uniquely specify any action in actions.ts. If not, we continue waiting for keypresses.
+3. `runAction` runs the action that was matched. Movements, Commands and Operators all have separate functions that dictate how to run them - `executeMovement`, `handleCommand`, and `executeOperator` respectively.
+4. Now that we've updated `VimState`, we run `updateView` with the new VimState to "redraw" VS Code to the new state.
 
-#### vscode.window.onDidChangeTextEditorSelection
+#### `vscode.window.onDidChangeTextEditorSelection`
 
 This is my hack to simulate a click event based API in an IDE that doesn't have them (yet?). I check the selection that just came in to see if it's the same as what I thought I previously set the selection to the last time the state machine updated. If it's not, the user _probably_ clicked. (But she also could have tab completed!)
 
 ## Release
 
+Before you push a release, be sure to make sure the changelog is updated!
+
 To push a release:
 
 ```bash
-npx gulp release --semver [SEMVER] --gitHubToken [TOKEN]
+npx gulp release --semver [SEMVER]
 git push --follow-tags
 ```
 
 The above Gulp command will:
 
-1.  Bump the package version based off the semver supplied. Supported values: patch, minor, major.
-2.  Create a changelog using [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator).
-3.  Create a Git commit with the above changes.
-4.  Create a Git tag using the new package version.
+1. Bump the package version based off the semver supplied. Supported values: patch, minor, major.
+2. Create a Git commit with the above changes.
+3. Create a Git tag using the new package version.
 
 In addition to building and testing the extension, when a tag is applied to the commit, the CI server will also create a GitHub release and publish the new version to the Visual Studio marketplace.
 
 ## Troubleshooting
 
-### Visual Studio Code Slowdown
+### VS Code Slowdown
 
 If you notice a slowdown and have ever run `yarn test` in the past instead of running tests through VSCode, you might find a `.vscode-test/` folder, which VSCode is continually consuming CPU cycles to index. Long story short, you can speed up VSCode by:
 
 ```bash
-$ rm -rf .vscode-test/
+rm -rf .vscode-test/
 ```
 
-## Styleguide
+## Style Guide
 
 Please try your best to adhere to our [style guidelines](https://github.com/VSCodeVim/Vim/blob/master/STYLE.md).

.github/ISSUE_TEMPLATE/bug_report.md

@@ -25,7 +25,7 @@ If remapping-related, please attach log output: https://github.com/VSCodeVim/Vim
 
 <!--
 Ensure you are on the latest VSCode + VSCodeVim
-You can use "Report Issue" by running "Developers: Show Running Extensions" from the Command Pallette to prefill these.
+You can use "Report Issue" by running "Developers: Show Running Extensions" from the Command Palette to prefill these.
 -->
 
 - Extension (VsCodeVim) version:

.github/workflows/build.yml

@@ -3,45 +3,49 @@ name: build
 on:
   push:
     branches:
-      - '**'
+      - 'master'
   pull_request:
     branches:
       - '**'
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout VSCodeVim
-        uses: actions/checkout@v2
-        with:
-          # Get full history; needed for Prettier to amend commit
-          fetch-depth: 0
+        uses: actions/checkout@v3
 
       - name: Set up Node.js
         uses: actions/setup-node@v2-beta
         with:
-          node-version: '12'
+          node-version: '16'
 
       - name: Install dependencies
         run: yarn install
 
       - name: Prettier
+        if: matrix.os != 'windows-latest'
         uses: creyD/prettier_action@v3.3
         with:
-          prettier_options: '--write **/*.{ts,js,json,md,yml}'
-          same_commit: true
-          only_changed: true
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          dry: true
 
       - name: Lint
         run: npx tslint -c tslint.json -p tsconfig.json
 
       - name: Build
         run: gulp webpack
 
-      - name: Test
+      - name: Test on ubuntu-latest
+        if: matrix.os != 'windows-latest'
         run: |
           gulp prepare-test
           xvfb-run -a yarn test
+
+      - name: Test on windows-latest
+        if: matrix.os == 'windows-latest'
+        run: |
+          gulp prepare-test
+          yarn test

.github/workflows/release.yml

@@ -10,12 +10,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout VSCodeVim
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up Node.js
         uses: actions/setup-node@v2-beta
         with:
-          node-version: '12'
+          node-version: '16'
 
       - name: Install dependencies
         run: yarn install
@@ -34,7 +34,7 @@ jobs:
       - name: Build extension package
         id: build_vsix
         run: |
-          yarn run vsce package --web;
+          yarn package;
           echo ::set-output name=vsix_path::$(ls *.vsix);
 
       - name: Create release on GitHub
@@ -59,6 +59,12 @@ jobs:
           asset_content_type: application/zip
 
       - name: Publish to VSCode Extension Marketplace
-        run: yarn run vsce publish --yarn --web
+        run: yarn run vsce publish --yarn
         env:
           VSCE_PAT: ${{ secrets.VSCE_PAT }}
+
+      - name: Publish to Open VSX Registry
+        uses: HaaLeo/publish-vscode-extension@v1
+        id: publishToOpenVSX
+        with:
+          pat: ${{ secrets.OPEN_VSX_TOKEN }}

.github_changelog_generator

@@ -38,6 +38,14 @@
       "outFiles": ["${workspaceRoot}/{out, node_modules}/**/*.js"],
       "preLaunchTask": "gulp: prepare-test",
       "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "Run Web Extension",
+      "type": "pwa-extensionHost",
+      "debugWebWorkerHost": true,
+      "request": "launch",
+      "args": ["--extensionDevelopmentPath=${workspaceRoot}", "--extensionDevelopmentKind=web"],
+      "outFiles": ["${workspaceRoot}/{out, node_modules}/**/*.js"]
     }
   ]
 }

.vscode/launch.json

@@ -15,7 +15,7 @@
     },
     {
       "type": "gulp",
-      "task": "build",
+      "task": "build-dev",
       "problemMatcher": []
     }
   ]

.vscode/tasks.json

@@ -22,4 +22,3 @@ tslint.json
 webpack.config.js
 gulpfile.js
 renovate.json
-.github_changelog_generator