Skip to content

Update docs for 12-language support #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
montfort merged 1 commit into from
Mar 31, 2026
Merged

Update docs for 12-language support #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ Do not capture PII, tokens, or secrets in OTel attributes or logs. Record instru
*DevTrail | [Strange Days Tech](https://strangedays.tech) — Because every change tells a story.*

## Active Technologies
- Rust (edition 2024, MSRV to be determined by tree-sitter 0.25 requirements) + tree-sitter 0.25, serde (serialization), 10 tree-sitter grammar crates (see research.md) (001-code-metrics-library)
- Rust (edition 2024, MSRV to be determined by tree-sitter 0.25 requirements) + tree-sitter 0.25, serde (serialization), 12 tree-sitter grammar crates (10 Tier 1 + Kotlin, Swift) (001-code-metrics-library)
- N/A (pure computation library, reads files via `std::fs`) (001-code-metrics-library)

## Recent Changes
- 001-code-metrics-library: Added Rust (edition 2024, MSRV to be determined by tree-sitter 0.25 requirements) + tree-sitter 0.25, serde (serialization), 10 tree-sitter grammar crates (see research.md)
- 001-code-metrics-library: Added Kotlin and Swift (Tier 2) via tree-sitter-kotlin-ng 1.1 and tree-sitter-swift 0.7, expanding to 12 languages
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Multi-language code complexity metrics powered by [tree-sitter](https://tree-sit

Arborist computes **cognitive complexity** (SonarSource), **cyclomatic complexity**
(McCabe), and **source lines of code** (SLOC) for functions and methods across
10 programming languages -- all from a single, embeddable Rust library.
12 programming languages -- all from a single, embeddable Rust library.

## Supported Languages

Expand All @@ -20,6 +20,8 @@ Arborist computes **cognitive complexity** (SonarSource), **cyclomatic complexit
| C++ | `cpp` | `.cpp`, `.cc`, `.cxx`, `.hpp`, `.hxx`, `.hh` |
| C | `c` | `.c`, `.h` |
| PHP | `php` | `.php` |
| Kotlin | `kotlin` | `.kt`, `.kts` |
| Swift | `swift` | `.swift` |

## Installation

Expand All @@ -38,7 +40,7 @@ Select specific languages to reduce compile time:
arborist = { version = "0.1", default-features = false, features = ["rust", "python"] }
```

Enable all 10 languages:
Enable all 12 languages:

```toml
[dependencies]
Expand All @@ -50,7 +52,7 @@ arborist = { version = "0.1", features = ["all"] }
| Flag | Includes |
|------|----------|
| `default` | `rust`, `python`, `javascript`, `typescript`, `java`, `go` |
| `all` | All 10 Tier 1 languages |
| `all` | All 12 languages (Tier 1 + Tier 2) |
| Individual | One language each (e.g., `rust`, `python`, `csharp`) |

## Quick Start
Expand Down
6 changes: 4 additions & 2 deletions specs/001-code-metrics-library/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ arborist = "0.1"
[dependencies]
arborist = { version = "0.1", default-features = false, features = ["rust", "python"] }

# Or all 10 Tier 1 languages
# Or all 12 languages (Tier 1 + Tier 2)
[dependencies]
arborist = { version = "0.1", features = ["all"] }
```
Expand Down Expand Up @@ -104,7 +104,7 @@ Per the project constitution, development follows test-first, fixture-driven wor
| Flag | Languages |
|------|-----------|
| `default` | Rust, Python, JavaScript, TypeScript, Java, Go |
| `all` | All 10 Tier 1 languages |
| `all` | All 12 languages (Tier 1 + Tier 2) |
| `rust` | Rust only |
| `python` | Python only |
| `javascript` | JavaScript + JSX |
Expand All @@ -115,3 +115,5 @@ Per the project constitution, development follows test-first, fixture-driven wor
| `c` | C |
| `go` | Go |
| `php` | PHP |
| `kotlin` | Kotlin + Kotlin Script |
| `swift` | Swift |