rustloc 0.13.0

Rust-aware LOC counter that separates production code from tests — even in the same file
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
82
83
84
85

# rustloc

A Rust-aware lines-of-code counter. Unlike generic LOC tools, rustloc understands that Rust tests live alongside production code and correctly separates them — even in the same file.

[![CI](https://github.com/arthur-debert/rustloc/actions/workflows/ci.yml/badge.svg)](https://github.com/arthur-debert/rustloc/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/rustloc.svg)](https://crates.io/crates/rustloc)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

![Rust Aware](https://raw.githubusercontent.com/arthur-debert/rustloc/main/assets/output-by-module.png)

## Features

**Line types:** Code, Tests, Examples, Docs, Comments, Blanks

**Grouping:** by Crate, Module, or File

**Diffs:** between any two commits, HEAD, or the current working tree

**Output:** terminal tables, JSON, CSV, YAML, XML

## Installation

From crates.io:

```bash
cargo install rustloc
```

Or grab a pre-built binary from [GitHub Releases](https://github.com/arthur-debert/rustloc/releases).

## Usage

### Counting

```bash
rustloc                              # current directory totals
rustloc --by-crate                   # breakdown by crate
rustloc --by-module                  # breakdown by module
rustloc --by-file                    # breakdown by file
rustloc --type code,tests            # show only specific line types
rustloc --crate my-lib               # filter to a specific crate
rustloc --exclude "**/generated/**"  # exclude by glob
```

![by-file output](https://raw.githubusercontent.com/arthur-debert/rustloc/main/assets/output-by-file.png)

### Diffs

```bash
rustloc diff                         # working tree vs last commit
rustloc diff HEAD~5..HEAD            # between any two commits
rustloc diff main..feature --by-file # per-file diff breakdown
rustloc diff --staged                # staged changes only
```

![diff output](https://raw.githubusercontent.com/arthur-debert/rustloc/main/assets/output-diff.png)

### Output formats

```bash
rustloc --output json
rustloc --output csv
rustloc --output yaml
rustloc --output-file-path report.csv --output csv
```

## Library

rustloc is also available as a library crate (`rustloclib`). See the [API documentation](https://docs.rs/rustloclib).

## How it works

rustloc uses a token-based parser with single-character lookahead to analyze Rust source files. It recognizes:

- Test blocks via `#[test]` and `#[cfg(test)]` attributes
- File context from paths (`tests/`, `examples/` directories)
- All Rust comment styles including doc comments
- Raw string literals that may contain comment-like syntax
- Nested block comments

The parsing logic is adapted from [cargo-warloc](https://github.com/Maximkaaa/cargo-warloc) by Maxim Gritsenko.

## License

MIT License — see [LICENSE](LICENSE) for details.