Use YAML

.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/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
 ```
 
-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
 
@@ -53,9 +52,17 @@ 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"
@@ -75,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.

editors/vscode/package.json

@@ -8,15 +8,15 @@
     "repository": {
         "url": "https://github.com/swarm-game/swarm"
     },
-	"keywords": [
-		"multi-root ready"
-	],
-	"engines": {
-		"vscode": "^1.75.0"
-	},
-	"activationEvents": [
-		"onLanguage:swarm"
-	],
+    "keywords": [
+        "multi-root ready"
+    ],
+    "engines": {
+        "vscode": "^1.75.0"
+    },
+    "activationEvents": [
+        "onLanguage:swarm"
+    ],
     "categories": [
         "Programming Languages"
     ],
@@ -50,11 +50,13 @@
         "@typescript-eslint/parser": "^4.23.0",
         "esbuild": "^0.13.13",
         "eslint": "^7.26.0",
+        "js-yaml": "^4.1.0",
         "mocha": "^10.4.0",
         "typescript": "^4.4.3",
         "vscode-tmgrammar-test": "^0.1.1"
     },
     "scripts": {
+        "gen-syntax": "npx js-yaml ./syntaxes/swarm.tmLanguage.yaml > ./syntaxes/swarm.tmLanguage.json",
         "vscode:prepublish": "npm run esbuild-base -- --minify",
         "esbuild-base": "esbuild ./client/src/extension.ts --bundle --outfile=out/main.js --external:vscode --format=cjs --platform=node",
         "esbuild": "npm run esbuild-base -- --sourcemap",

editors/vscode/syntaxes/.gitignore

@@ -0,0 +1 @@
+swarm.tmLanguage.json