Skip to content

README.md

Latest commit

 

History

History
153 lines (107 loc) · 4.35 KB

README.md

File metadata and controls

153 lines (107 loc) · 4.35 KB

ganko-vscode

VS Code extension for Solid.js language support, powered by @drskillissue/ganko and @drskillissue/ganko-lsp.

Features

Diagnostics and Analysis

  • Solid-specific diagnostics for reactivity, correctness, and performance
  • CSS and JSX policy diagnostics (including accessibility-oriented checks)
  • Rule severity overrides directly from VS Code settings
  • Optional ESLint config ingestion from eslint.config.{mjs,js,cjs}

Navigation and Code Intelligence

  • Go to definition, find references, and rename symbol
  • Hover information, completions, and signature help
  • Document symbols and workspace symbol search
  • Document highlights, folding ranges, and selection ranges
  • Linked editing for JSX tag pairs
  • Code actions for fixable diagnostics

Reactive Tooling

  • Reactive graph visualization command (Solid: Show Reactive Graph)
  • Mermaid-rendered graph panel for dependency exploration

Editor Integration

  • Semantic token support for Solid reactive constructs
  • Inlay hints for reactive dependencies
  • Status bar health indicator and output channel integration

File Support

  • TypeScript / JavaScript: .ts, .tsx, .js, .jsx
  • Stylesheets: .css, .scss, .sass, .less

Configuration

Setting Type Default Description
solid.enable boolean true Enable the Solid language server
solid.exclude string[] [] Glob patterns to exclude from analysis (e.g. ["backend/**", "scripts/**"]). Matched relative to workspace root.
solid.logLevel string "info" Log level for the language server (trace, debug, info, warning, error, critical, off)
solid.trace.server string "off" LSP trace level (off, messages, verbose)
solid.accessibilityPolicy string "wcag-aa" Policy template for CSS/JSX style linting (wcag-aa, wcag-aaa, mobile-first, dense-ui, large-text)
solid.eslintConfig.enable boolean true Read rule overrides from ESLint config
solid.eslintConfig.path string - Custom ESLint config path (relative to workspace root). Uses auto-discovery if not set.
solid.enableTypeScriptDiagnostics boolean false Push TypeScript diagnostics alongside ganko diagnostics
solid.lsp.env object {} Environment variables passed to the LSP process

Rule Overrides

Rule overrides are configured per rule key as solid.rules.<rule-id>.

  • Allowed values: error, warn, off, default
  • default uses the built-in rule severity

Example:

{
  "solid.rules.signal-call": "error",
  "solid.rules.effect-as-memo": "warn",
  "solid.rules.prefer-for": "off",
  "solid.rules.css-policy-contrast": "warn"
}

Severity precedence (highest to lowest):

  1. VS Code solid.rules.<rule-id> overrides
  2. ESLint config overrides (when solid.eslintConfig.enable is true)
  3. Built-in rule defaults

Commands

Command Description
Solid: Restart Language Server Restarts the language server
Solid: Show Reactive Graph Opens a reactive dependency graph panel
Solid: Show Output Channel Opens extension logs
Solid: Show Memory Usage Shows language server heap usage

Semantic Tokens

Token types contributed by the extension:

  • solidSignal
  • solidStore
  • solidMemo
  • solidDerived
  • solidProps
  • solidResource
  • solidAccessor
  • solidEffect

Token modifiers:

  • reactive
  • tracked
  • declaration

Status Bar

The extension shows language server state in the status bar:

  • $(loading~spin) Solid LSP - starting
  • $(check) Solid LSP - running
  • $(circle-slash) Solid LSP - stopped
  • $(error) Solid LSP - error

Click the status bar item to open the output channel.

Development

Build

# From monorepo root
bun install
bun run --cwd packages/vscode build

Local Testing

  1. Build the extension:

    bun run --cwd packages/vscode build

  2. Open this repository in VS Code.

  3. Press F5 to launch an Extension Development Host.

  4. Open a Solid project in the new window.

Package

bun run --cwd packages/vscode package

This produces a .vsix file in packages/vscode/.

Workspace Trust

This extension requires a trusted workspace. It does not activate in untrusted workspaces.

Requirements

  • VS Code >=1.105.0
  • Node.js >=22.0.0