Shader Clippy — VS Code extension

In-editor diagnostics, hover docs, and quick-fix code actions for HLSL — powered by the shader-clippy linter. This extension is a thin wrapper around the shader-clippy-lsp JSON-RPC server (see ADR 0014).

How it works (in 30 seconds)

Install the extension. The matching .vsix for your OS+arch ships the shader-clippy-lsp server binary inside it — no extra download.
Open any .hlsl / .hlsli / .fx / .fxh / .vsh / .psh / .csh / .gsh / .hsh / .dsh file in VS Code.
The extension activates automatically and spawns the LSP server. You'll see a "$(check) Shader Clippy" badge in the bottom-right status bar once the server is ready.
Squiggles appear under any line that triggers a rule, and matching entries land in the Problems panel (Ctrl+Shift+M on Windows/Linux, Cmd+Shift+M on macOS).
Hover a squiggle for an explanation + a link to the per-rule docs. Click the lightbulb (or Ctrl+.) to apply a quick-fix when the rule is machine-applicable.

If the status-bar badge shows "$(error) Shader Clippy" — click it to open the Shader Clippy Output channel and see the failure reason (usually a missing binary or a permissions error). See the Troubleshooting section below for the common cases.

Features

Inline diagnostics as you type, with the same rule ids the CI gate emits.
Code-action quick-fixes for every machine_applicable rule (lightbulb menu).
Hover tooltips that link to the per-rule documentation page.
Workspace-aware: respects .shader-clippy.toml walk-up resolution and multi-root projects (per ADR 0014 §4).
No telemetry. The extension never reports back. Diagnostics stay local.

The diagnostics surfaced in VS Code's Problems panel are byte-for-byte the same as the diagnostics the CLI emits in CI logs (modulo formatting).

Requirements

VS Code 1.85 or newer.

The shader-clippy-lsp server binary is bundled inside the extension — since v0.5.3 the Marketplace ships a per-platform .vsix for each of linux-x64, win32-x64, and darwin-arm64, and the matching binary lives at <extension>/server/<platform>/shader-clippy-lsp[.exe]. Marketplace installs and .vsix sideloads both Just Work with no extra download.

Power-user overrides (only set these if you need them):

shaderClippy.serverPath — point at a custom-built shader-clippy-lsp binary (e.g. a local debug build). Bypasses the bundled binary.
PATH lookup — if shader-clippy-lsp (or shader-clippy-lsp.exe) is on PATH, it takes precedence over the bundled binary.

Installation

From the Marketplace

Search for "Shader Clippy" by nelcit in the Extensions view (Ctrl+Shift+X), or install from the command line:

code --install-extension nelcit.shader-clippy

The Marketplace serves the matching .vsix for your OS+arch automatically; the LSP binary is included.

From a `.vsix` (sideload)

Per-platform .vsix files are attached to every GitHub Release — pick the one for your platform:

shader-clippy-<version>-linux-x64.vsix
shader-clippy-<version>-win32-x64.vsix
shader-clippy-<version>-darwin-arm64.vsix

Then:

code --install-extension shader-clippy-<version>-<target>.vsix

Settings

Setting	Type	Default	Purpose
`shaderClippy.serverPath`	`string`	`""`	Explicit path to a custom `shader-clippy-lsp` binary. Empty = use the binary bundled with the extension (or `shader-clippy-lsp` on `PATH`).
`shaderClippy.targetProfile`	`string`	`""`	Slang target profile (e.g. `sm_6_6`, `vs_6_7`, `ps_6_8`). Empty = server default per stage. Forwarded to `LintOptions::target_profile`.
`shaderClippy.enableReflection`	`boolean`	`true`	Enable Phase 3 reflection-aware rules. Disable on slow machines to keep AST-only latency.
`shaderClippy.enableControlFlow`	`boolean`	`true`	Enable Phase 4 CFG-aware rules.
`shaderClippy.trace.server`	`string`	`"off"`	Trace LSP communication (`off` / `messages` / `verbose`).
`shaderClippy.inlineDiagnostics`	`string`	`"off"`	Render the diagnostic message inline at end of line (Error Lens style). `off` / `errors-only` / `all`.
`shaderClippy.showStatusBar`	`boolean`	`true`	Show the Shader Clippy badge in the status bar. Disable if your status bar is crowded.

Auto-fix on save

Add this to your settings.json to apply every machine-applicable fix each time you save an HLSL file:

"editor.codeActionsOnSave": {
  "source.fixAll.shaderClippy": "always"
}

You can also trigger it manually via Shader Clippy: Fix All in Document (Ctrl+Shift+P).

Commands

Command	Default keybinding (HLSL files)	Description
`Shader Clippy: Restart Server`	—	Stop and re-spawn the LSP server (useful after a binary update).
`Shader Clippy: Show Output Channel`	—	Reveal the extension's output panel.
`Shader Clippy: Re-lint Active Document`	`Ctrl+Alt+L` (`Cmd+Alt+L` on macOS)	Force a re-lint via a save round-trip; useful after editing `.shader-clippy.toml`.
`Shader Clippy: Open Rule Docs`	`Ctrl+Alt+D` (`Cmd+Alt+D` on macOS)	Open the per-rule docs page on github.com for the diagnostic at the cursor.

Right-click anywhere inside an HLSL file for an Shader Clippy submenu that surfaces the four commands above. Keybindings only fire when the active editor language is HLSL.

Rule documentation

Every diagnostic includes a hover link to the rule's docs page. Browse the full catalog at docs/rules/.

License

Apache-2.0. See LICENSE in the repo root.

This extension bundles vscode-languageclient (MIT, Microsoft Corp.) and @types/vscode (MIT). Third-party license texts are reproduced in THIRD_PARTY_LICENSES.md.

Troubleshooting

No diagnostics when opening a .hlsl file? Three checks:

Status-bar badge. Look at the bottom-right corner of the VS Code window. You should see one of:
- $(check) Shader Clippy → server running. If you still see no diagnostics, the file may not contain anything the rule pack flags. Try a known-bad pattern like pow(x, 2.0);.
- $(sync~spin) Shader Clippy → still starting. Wait 1–2 seconds.
- $(error) Shader Clippy → activation failed. Click the badge to open the Output channel; the failure reason is at the top.
- No badge at all → the extension didn't activate. Check the editor's bottom-right language indicator: it must say "HLSL". Click it and pick "HLSL" if it says "Plain Text".
Output channel. Ctrl+Shift+P → "Shader Clippy: Show Output Channel". The first lines tell you which binary the resolver picked and whether the LSP started cleanly.
Manual serverPath. If the bundled binary is missing or broken on your platform, download shader-clippy-lsp from the matching GitHub Release, extract it (Windows: keep all 7 sibling .dll files in the same directory!), and set shaderClippy.serverPath to its absolute path.

Contributing / local testing

See DEVELOPMENT.md for the F5 dev loop and tools/build-vsix-local.{ps1,sh} workflow that lets contributors verify changes BEFORE tagging a release. The local workflow uses the exact same packaging steps as release-vscode.yml.

Reporting issues

File bugs at https://github.com/NelCit/shader-clippy/issues. Please include:

The output of Shader Clippy: Show Output Channel.
Your shaderClippy.* settings.
A minimal reproducer shader.

Shader Clippy

NelCit