CCLS

A language server for Circom, built with Rust and TypeScript.

🚀 Installation

1. Clone the repository:

   git clone https://github.com/vuvoth/ccls.git
   cd ccls

2. Install Rust (if not already installed):
   👉 https://www.rust-lang.org/tools/install

3. Build or test the project:

   cargo test     # Run tests
   cargo build    # Build the project

---

🧪 Running Tests (with insta snapshots)

Optional, but recommended for snapshot testing.

1. Install cargo-insta:

   curl -LsSf https://insta.rs/install.sh | sh

2. Run the tests:

   cargo test

3. Review snapshot changes:

   cargo insta review

📘 More info: Insta Quickstart

---

🐞 Debugging the Extension

1. Install CCLS server and client:

   cargo xtask install --server
   cargo xtask install --client
   npm audit fix --force   # optional

2. Run the extension in VSCode:

   • Open the ccls project in VSCode.
   • Open the Run and Debug panel.
   • Select Run Extension (Debug Build) and start debugging.

3. A new VSCode window will open.
   Open a Circom file and try features like Go to Definition.

---