wgsl-analyzer is a language server plugin for the WGSL Shading language.

It comes with a VS Code plugin located in ./editors/code. Due to the nature of the language server protocol, it should be possible to create plugins for other editors as well.

The extension is published on the marketplace, so you can simply download the extension like any other.

If you are not using a platform for which the vscode extension ships prebuilt binaries (currently only windows-x64, linux-x64 and macos-x64), then you need to compile the language server yourself:

cargo install --git https://github.com/wgsl-analyzer/wgsl-analyzer.git wgsl-analyzer

Specify the server path in the settings:

{
    "wgsl-analyzer.server.path": "~/.cargo/bin/wgsl-analyzer"
}

• Requires CoC to be installed: https://github.com/neoclide/coc.nvim
• Requires cargo to be installed to build binaries:

1. Install the language server

   cargo install --git https://github.com/wgsl-analyzer/wgsl-analyzer.git wgsl-analyzer

   (if you are not familiar with using and setting up cargo, you might run into problems finding your binary. Ensure that $HOME/.cargo/bin is in your $PATH. More Info about $PATH: https://linuxconfig.org/linux-path-environment-variable)

2. open Neovim / Vim and type :CocConfig to configure coc.nvim.

3. under .languageserver: { ... } create a new field named "wgsl". The field should look like this:

   //  {
   //    "languageserver": {
           "wgsl": {
             "command": "wgsl-analyzer", // alternatively you can specify the absolute path to your binary.
             "filetypes": ["wgsl"],
           },
   //      ...
   //  }

4. In order for your editor to recognize WGSL files as such, you need to put this into your vim.rc

   " Recognize wgsl
   au BufNewFile,BufRead *.wgsl set filetype=wgsl

1. Install the wgsl-analyzer language server

2. Configure the "wgsl" filetype

   vim.api.nvim_create_autocmd({ "BufNewFile", "BufRead" }, {
     pattern = "*.wgsl",
     callback = function()
       vim.bo.filetype = "wgsl"
     end,
   })

3. Configure the nvim lsp

   local lspconfig = require('lspconfig')
   lspconfig.wgsl_analyzer.setup({})

• Assumes you are using wgsl-mode: https://github.com/acowley/wgsl-mode

1. Install the language server

   cargo install --git https://github.com/wgsl-analyzer/wgsl-analyzer wgsl-analyzer

2. Add the following to your init.el

   (with-eval-after-load 'lsp-mode
   (add-to-list 'lsp-language-id-configuration '(wgsl-mode . "wgsl"))
   (lsp-register-client (make-lsp-client :new-connection (lsp-stdio-connection "wgsl-analyzer")
                                           :activation-fn (lsp-activate-on "wgsl")
                                           :server-id 'wgsl-analyzer)))

Configuration for the VS Code plugin can be found in its subdirectory: ./editors/code/README.md.

The lsp server can be built using cargo build --release -p wgsl-analyzer.

The vscode extension can either be built as a platform-specific extension which bundles the language server binary, or as a platform-independent one.

Install node modules:

cd editors/code && npm install

Platform independent extension:

cd editors/code && npm run package

Platform-specific extension:

Copy the server binary (either wgsl-analyzer or wgsl-analyzer.exe) into ./editors/code/out/, then run:

npm run package -- --target <target> -o wgsl-analyzer-<target>.vsix

where the target is one of the targets listed as platform-specific extension targets.

This can be done automatically with cargo run --bin package -- --target linux-x64 --install.

The design is heavily inspired (and in large parts copied from) rust-analyzer.

See wgsl-analyzer architecture for a summary of the architecture.

(Also see rust-analyzer architecture for a summary of the original architecture.)

The extension gets automatically packaged and released to the marketplace in CI.

1. update version in package.json
2. run ./tools/update_version.sh
3. commit and tag with vx.y.z
4. git push && git push --tags