feat: Create a VSCode extension

Author: armsnyder

.github/dependabot.yml

@@ -15,3 +15,10 @@ updates:
     commit-message:
       prefix: chore
       include: scope
+  - package-ecosystem: npm
+    directory: /vscode-extension
+    schedule:
+      interval: monthly
+    commit-message:
+      prefix: chore
+      include: scope

.github/release-please-config.json

@@ -4,8 +4,11 @@
     ".": {
       "release-type": "simple",
       "bump-minor-pre-major": true,
-      "include-v-in-tag": true,
-      "extra-files": ["README.md"]
+      "include-v-in-tag": true
+    },
+    "vscode-extension": {
+      "bump-minor-pre-major": true,
+      "include-v-in-tag": true
     }
   }
 }

.github/workflows/assets.yaml .github/workflows/release.yaml.github/workflows/assets.yaml renamed to .github/workflows/release.yaml

@@ -1,11 +1,11 @@
 # yaml-language-server: $schema=https://www.schemastore.org/github-workflow.json
-name: Assets
+name: Release
 on:
   push:
     tags: ["v*"]
 jobs:
   release:
-    name: Assets
+    name: Release
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -14,6 +14,10 @@ jobs:
         uses: actions/setup-go@v5
         with:
           go-version-file: go.mod
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
       - name: Install Cosign
         uses: sigstore/cosign-installer@v3
       - name: Create app token
@@ -36,3 +40,11 @@ jobs:
           MACOS_NOTARY_ISSUER_ID: ${{ secrets.MACOS_NOTARY_ISSUER_ID }}
           COSIGN_KEY: ${{ secrets.COSIGN_KEY }}
           COSIGN_PWD: ${{ secrets.COSIGN_PWD }}
+      - name: Install dependencies
+        run: npm ci
+        working-directory: vscode-extension
+      - name: Publish VSCode extension
+        run: npm run publish
+        working-directory: vscode-extension
+        env:
+          VSCE_PAT: ${{ secrets.VSCE_PAT }}

.github/workflows/vscode-ci.yaml

@@ -0,0 +1,39 @@
+# yaml-language-server: $schema=https://www.schemastore.org/github-workflow.json
+name: VSCode Extension CI
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'vscode-extension/**'
+      - '.github/workflows/ci-vscode.yaml'
+  pull_request:
+    branches: [main]
+    paths:
+      - 'vscode-extension/**'
+      - '.github/workflows/ci-vscode.yaml'
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+      - name: Install dependencies
+        run: npm ci
+        working-directory: vscode-extension
+      - name: Check types
+        run: npm run typecheck
+        working-directory: vscode-extension
+      - name: Lint
+        run: npm run lint
+        working-directory: vscode-extension
+      - name: Check formatting
+        run: npm run format:check
+        working-directory: vscode-extension
+      - name: Run tests
+        run: xvfb-run -a npm test
+        working-directory: vscode-extension

README.md

@@ -16,26 +16,35 @@ External editor support for `.gdshader` files.
 
 Godot's shader language is powerful, but editing `.gdshader` files outside the
 Godot editor is painful. This project aims to bring proper language tooling
-(autocomplete, hover, references, etc.) to editors like Neovim and VSCode.
+(autocomplete, hover, references, etc.) to editors like Neovim and VSCode. It
+aims to be memory-efficient and editor-agnostic.
 
 ## 🌱 Prior Work
 
-[@GodOfAvacyn](https://github.com/GodOfAvacyn) is the wonderful author of the
-[treesitter plugin](https://github.com/GodOfAvacyn/tree-sitter-gdshader) and
-[language server](https://github.com/GodOfAvacyn/gdshader-lsp) for the Godot
-shader language. Their treesitter plugin is great! As of writing, their
-language server has many false positive diagnostics, and the project became
-inactive while they were
-[working on a full rewrite](https://github.com/GodOfAvacyn/gdshader-lsp/issues/3#issuecomment-2176364609).
-I decided to start this new project to fill the gap for myself.
+1. [@GodOfAvacyn](https://github.com/GodOfAvacyn) is the author of the
+   [treesitter plugin](https://github.com/GodOfAvacyn/tree-sitter-gdshader) and
+   [language server](https://github.com/GodOfAvacyn/gdshader-lsp) for the Godot
+   shader language. Their treesitter plugin is great! As of writing, their
+   language server has many false positive diagnostics, and the project became
+   inactive while they were [working on a full
+   rewrite](https://github.com/GodOfAvacyn/gdshader-lsp/issues/3#issuecomment-2176364609).
+
+2. [@AlfishSoftware](https://github.com/AlfishSoftware) is the author of the
+   [Godot Files VSCode
+   Extension](https://github.com/AlfishSoftware/godot-files-vscode), which
+   includes some support for `.gdshader` files. However, it is VSCode-only. If
+   you are a VSCode user, I recommend checking it out!
+
+3. There is an [official Godot VSCode
+   plugin](https://github.com/godotengine/godot-vscode-plugin), but it has
+   minimal shader support and is VSCode-only.
 
 ## 📦 Install
 
 ### Neovim
 
-1. Install by downloading the
-   [latest release](https://github.com/armsnyder/gdshader-language-server/releases/latest)
-   or building from source:
+1. Download the [latest release](https://github.com/armsnyder/gdshader-language-server/releases/latest)
+   or build from source:
 
    ```shell
    wget https://github.com/armsnyder/gdshader-language-server/releases/latest/download/gdshader-language-server_$(uname -s)_$(uname -m).tar.gz
@@ -47,9 +56,9 @@ I decided to start this new project to fill the gap for myself.
    go install github.com/armsnyder/gdshader-language-server@latest
    ```
 
-1. Create a `~/.config/nvim/after/ftplugin/gdshader.lua` file with the following
-   content, adjusting the path to the `gdshader-language-server` binary if
-   necessary:
+1. Create a `~/.config/nvim/after/ftplugin/gdshader.lua` file with the
+   following content, adjusting the path to the `gdshader-language-server`
+   binary if necessary:
 
    ```lua
    vim.lsp.start({
@@ -61,7 +70,7 @@ I decided to start this new project to fill the gap for myself.
 
 ### VSCode
 
-Coming soon? Contributions welcome!
+Work in progress
 
 ## Roadmap
 
@@ -80,6 +89,8 @@ Planned features:
 - [ ] VSCode wrapper extension
 - [ ] Make the code more maintainable by generating rules based on the official
       Godot documentation
+- [ ] [Grammar](https://code.visualstudio.com/api/references/contribution-points#contributes.grammars)
+      for the VSCode extension
 
 ## 🤝 Contributing
 

vscode-extension/.gitignore

@@ -0,0 +1,6 @@
+/node_modules/
+/.vscode-test/
+
+# These files are copied from the repo root during CI
+/cosign.pub
+/CHANGELOG.md

vscode-extension/.vscode-test.mjs

@@ -0,0 +1,24 @@
+import { defineConfig } from "@vscode/test-cli";
+import fs from "fs";
+import url from "url";
+import path from "path";
+
+function detectMinimumVSCodeVersion() {
+  const __filename = url.fileURLToPath(import.meta.url);
+  const __dirname = path.dirname(__filename);
+  const packageJsonPath = path.join(__dirname, "package.json");
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
+  const vscodeVersion = packageJson.engines.vscode.replace(/^\^/, "");
+  return vscodeVersion;
+}
+
+export default defineConfig([
+  {
+    version: "stable",
+    files: "**/*.test.js",
+  },
+  {
+    version: detectMinimumVSCodeVersion(),
+    files: "**/*.test.js",
+  },
+]);

vscode-extension/.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Run Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "--disable-extensions",
+        "--extensionDevelopmentPath=${workspaceFolder}"
+      ]
+    }
+  ]
+}

vscode-extension/README.md

@@ -0,0 +1,10 @@
+[![GitHub Repo Stars](https://img.shields.io/github/stars/armsnyder/gdshader-language-server)](https://github.com/armsnyder/gdshader-language-server)
+[![GitHub Issues](https://img.shields.io/github/issues/armsnyder/gdshader-language-server)](https://github.com/armsnyder/gdshader-language-server/issues)
+[![Go Report Card](https://goreportcard.com/badge/github.com/armsnyder/gdshader-language-server)](https://goreportcard.com/report/github.com/armsnyder/gdshader-language-server)
+
+This extension provides language support for Godot's `.gdshader` files.
+
+### 🚧 Preview Status
+
+This extension is in its early stages and currently only supports basic keyword
+completion. Once I deem it useful enough I will remove the preview status.

vscode-extension/eslint.config.mjs

@@ -0,0 +1,21 @@
+import js from "@eslint/js";
+import { defineConfig, globalIgnores } from "eslint/config";
+import globals from "globals";
+
+/** @type {import('eslint').Linter.Config[]} */
+export default defineConfig([
+  globalIgnores([".vscode-test/**", "node_modules/**"]),
+  js.configs.recommended,
+  {
+    files: ["**/*.js"],
+    languageOptions: {
+      globals: {
+        ...globals.commonjs,
+        ...globals.node,
+        ...globals.mocha,
+      },
+      ecmaVersion: 2022,
+      sourceType: "commonjs",
+    },
+  },
+]);