Introduction
Last verified against: v0.3 — multi-dialect setting (default HSPICE), expanded HSPICE reference corpus, bare .DATA value rows parse without syntax errors, dialect-aware hover, generated mdBook dialect catalog; VS Code commands register before LSP start; Linux glibc 2.31+ binaries; Marketplace publish on each push to main
spice-lsp is a language server and formatter for SPICE circuit simulation netlists. The end goal is a VS Code extension that provides real-time diagnostics, dialect-aware documentation on hover, navigation, formatting, and connectivity warnings while editing .cir, .sp, .spf, and related files.
This book is generated with mdBook from the docs/ directory.
How to read this book
| Stage | Chapters |
|---|---|
| Setup and ship MVP | Getting Started → Principles → MVP Guide → Demo and Testing |
| Understand the system | Architecture → LSP Features |
| Long-term direction | Dialect Reference and Net Semantics → Dialect reference catalog → Formatter → Limitations |
| VS Code | VS Code Integration |
Quick setup lives in the repository README.md.
Roadmap at a glance
MVP Syntax diagnostics in VS Code
v0.2 Outline, go to definition, duplicate/undefined warnings
v0.3 Completion, file-local hover
v0.4 Formatter, dialect setting
v0.5 Curated dialect reference (hover) + dangling-node / floating-net warnings
v0.5 is where you maintain reference/<dialect>/ documentation and the LSP begins SPICE-specific semantic assistance beyond syntax. Not part of MVP.
Build the book locally
pixi run mdbook-build # render static site to docs/book/
pixi run mdbook-serve # preview at http://127.0.0.1:3000
Published site
Pushes to main that touch docs/ deploy the book to the gh-pages branch via .github/workflows/deploy-docs.yml.
https://amirhosseindavoody.github.io/spice-lsp/