a reactive (signals based) hypermedia web framework (wip)
stormlightlabs.github.io/volt/
desertthunder.dev
hypermedia
frontend
signals
1# Volt Developer CLI
2
3Development tools for the Volt.js project. Uses:
4
5- `commander` for command-line parsing
6- `chalk` for colored output
7- TypeScript Compiler API for parsing source files
8
9## Installation
10
11From the project root:
12
13```sh
14pnpm install
15```
16
17The `volt` command will be available after installation.
18
19## Commands
20
21### `volt docs`
22
23Generates API documentation from TypeScript source files.
24
25- Scans all `.ts` files in `src/`
26- Extracts JSDoc comments and type signatures
27- Outputs markdown files to `docs/api/`
28- Supports `@example` tags in JSDoc
29
30Generated documentation includes:
31
32- Function signatures and descriptions
33- Interface definitions and members
34- Type aliases
35- Code examples from `@example` tags
36
37### `volt stats`
38
39Displays lines of code statistics.
40
41- Default: counts code in `src/` only
42- Excludes JSDoc comments, single-line comments, and empty lines
43- Use `--full` to include test files
44
45Outputs:
46
47- Total files
48- Total lines (including comments)
49- Code lines (excluding docs/comments)
50- Documentation/comment lines
51
52## Development
53
54### Build
55
56```sh
57pnpm build
58```
59
60Compiles TypeScript to `dist/` using tsdown.
61
62### Test
63
64```sh
65pnpm test # Watch mode
66pnpm test:run # Single run
67```
68
69### Type Check
70
71```sh
72pnpm typecheck
73```