sca 0.1.0

Smells Code Analyzer rewritten in Rust
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

# Smells Code Analyzer (Rust)

Rust implementation of the original `smells-code-analyzer` CLI.  
The binary reproduces the TypeScript version’s behaviour: it loads the same JSON
configuration, filters candidate files, walks TypeScript syntax trees via
tree-sitter, calls the configured language server for reference counts, and
prints the familiar emoji-styled report.

## Features
- Compatible CLI: `sca --config-file <path> [--threshold <n>]`
- JSON config schema shared with the Node.js tool
- File discovery and content filtering using `globset`/`ignore`
- Tree-sitter based structural matching with nested node targets
- Minimal LSP client (JSON-RPC) for `initialize`, `didOpen`, `references`, `shutdown`
- ASCII/non-ASCII sanitisation pipeline equivalent to the original implementation
- Threshold enforcement with non-zero exit code on smell overflow

## Getting Started
```bash
cd sca-rust
cargo build --release
./target/release/sca --config-file ../config.json
```

You can override the maximum number of allowed “dead” entities:
```bash
./target/release/sca --config-file ../config.json --threshold 50
```

> **Note**  
> The language server referenced in the config (e.g. `node .../typescript-language-server`)
> must be accessible on the host machine before running the binary.

## Project Layout
```
src/
  main.rs          # CLI entry + orchestration
  config.rs        # JSON config loading, validation, encoding helpers
  model.rs         # Shared data structures
  sanitize.rs      # Source pre-processing
  analyzer/
    mod.rs         # Analyzer facade + aggregation helpers
    files.rs       # File discovery utilities
    tree.rs        # Tree-sitter traversal and node extraction
    lsp.rs         # Async JSON-RPC LSP client
    report.rs      # Emoji-styled report rendering
```

Logging is powered by `tracing`. Set `RUST_LOG=debug` for verbose diagnostics,
including raw LSP stderr output.

## Testing & Tooling
- `cargo fmt` ensures Rustfmt compliance (already applied).
- `cargo test` runs unit coverage (`sanitize` and `report` modules today).
- `cargo check` validates the build graph (requires access to crates.io).

## Publishing
1. Update `Cargo.toml` metadata (`version`, `description`, `repository`, `readme`, `keywords`, etc.).  
   The manifest already contains sensible defaults; bump the version before each release.
2. Ensure the crate builds cleanly and the README renders:  
   `cargo fmt && cargo check && cargo test && cargo doc --no-deps`.
3. Create a tagged release in git (e.g. `git tag -a vX.Y.Z -m "sca-rust vX.Y.Z"`).
4. Dry-run the publish to crates.io:
   ```bash
   cargo publish --dry-run
   ```
5. Publish for real once the dry-run succeeds:
   ```bash
   cargo publish
   ```
6. (Optional) Build release binaries for GitHub Releases:
   ```bash
   cargo build --release
   # tar/zip target/release/sca for each target triple you cross-compile
   ```
   Consider using `cross` or GitHub Actions to produce multi-platform artefacts.

## Next Steps
- Expand unit coverage for config parsing and tree traversal.
- Add integration tests against a TypeScript fixture to snapshot reports.
- Evaluate caching with pooled tree-sitter parsers for large codebases.