Candle Tools
Candle Tools is a Visual Studio Code extension for working with CASM and CandleC projects.
Features
For .casm files, Candle Tools provides CASM syntax highlighting, autocompletion, and a custom file icon. It also provides a custom icon for compiled .candle files.
When project features are enabled for a workspace folder, the extension uses CandleC to show source diagnostics and exposes commands to build, check, and clean the project. These commands are also available as tasks through the VS Code task system. See the CandleC command-line reference and project documentation for details about those operations.
CASM highlighting and completion work without enabling project features. Project diagnostics and commands are opt-in per workspace folder.
Configure CandleC
Set the CandleC executable before using diagnostics or project commands. Open the Command Palette and run Candle Tools: Select CandleC Executable, or set candleTools.candlecPath to the executable's absolute path in VS Code settings.
In a CandleC project, run Candle Tools: Enable CandleC for This Project to enable automatic diagnostics and project tasks for the current workspace folder. Run Candle Tools: Disable CandleC for This Project to turn them off. You can also control this per-folder with candleTools.enableProjectFeatures, which defaults to false.
| Setting | Description |
|---|---|
candleTools.candlecPath | Absolute path to the CandleC executable used for project commands and diagnostics. |
candleTools.enableProjectFeatures | Enable automatic diagnostics and project tasks for this workspace folder. Defaults to false. |
Commands
Commands are available from the Command Palette and the Candle Tools status bar menu.
| Command | Description |
|---|---|
| Candle Tools: Select CandleC Executable | Choose the CandleC executable used by the extension. |
| Candle Tools: Enable CandleC for This Project | Enable diagnostics and project tasks for the current workspace folder. |
| Candle Tools: Disable CandleC for This Project | Disable diagnostics and project tasks for the current workspace folder. |
| Candle Tools: Build Project | Build the current project. |
| Candle Tools: Check Project | Check the current project and report diagnostics. |
| Candle Tools: Clean Project | Clean generated build artifacts. |
| Candle Tools: Run CandleC Task | Run a supported CandleC task. |