Update VSCode plugin (#1895)

* Update VSCode plugin NPM package
* Update VSCode syntax
  * Rewrite the `definition` rule to make it simpler and work with multiline types
    * Use shared `#types` group with added support for `rec`
  * Refactor groups to use ordered include `patterns` and unordered `repository` of named subgroups
  * Add escape sequences to strings
* Fix a typo in a regular expression that broke syntax highlighting
* Generate the syntax JSON file from YAML
---

* Closes #1887

.github/workflows/vscode-ci.yml

@@ -42,6 +42,7 @@ jobs:
         npm clean-install           && \
         tsc --build .               && \
         cd ..                       && \
+        npm run gen-syntax          && \
         npm clean-install           && \
         npm run build --if-present
     - run: |

.github/workflows/vscode-publish.yml

@@ -21,6 +21,7 @@ jobs:
           npm clean-install           && \
           tsc --build .               && \
           cd ..                       && \
+          npm run gen-syntax          && \
           npm clean-install           && \
           npm run build --if-present
       - name: Publish to Visual Studio Marketplace

editors/vscode/.vscodeignore

@@ -1,4 +1,5 @@
 .vscode/**
 .vscode-test/**
 .gitignore
+test/**
 DEVELOPING.md

editors/vscode/DEVELOPING.md

@@ -28,15 +28,14 @@
 
 ### Updating the syntax highlighting
 
-Whenever swarm language adds new features, the highlighting needs to be updated.
+Whenever swarm language adds new features, the highlighting might need to be updated.
 
 To save some time, get the current reserved words by running `swarm-docs`:
 ```bash
-cabal run swarm:swarm-docs -- editors
+cabal run -O0 swarm:swarm-docs -- editors
 ```
 
-You still have to add for example types manually.
-
+You still have to add for example type keywords (`rec`, `forall`) manually.
 
 ### Add more language features
 
@@ -54,9 +53,16 @@ npm install
 If you want to include the LSP client then after the previous install do:
 ```sh
 cd client
+npm update
+npm install
 tsc --build
 ```
 
+To generate the JSON TextMate grammar do:
+```sh
+npm run gen-syntax
+```
+
 To build the VSIX package do:
 ```sh
 vsce package --baseImagesUrl "https://raw.githubusercontent.com/swarm-game/swarm/editors/vscode"
@@ -76,3 +82,6 @@ Then you may have to update the test snapshot as follows:
 ```
 npm test vscode-tmgrammar-snap -- --updateSnapshot
 ```
+
+**WARNING:** Always run the snapshot test to see if half of the
+syntax is not suddenly missing because of a typo.