codestat 0.2.0

Fast and safe code statistics tool
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

# CodeStat

A fast code statistics tool written in Rust. Counts lines of code and shows language distribution for Git repositories or directories.

[中文文档](./README.zh.md)

## Features

- Fast parallel processing using Rayon
- Memory-safe Rust implementation
- Counts code, comments, and blank lines separately
- Detects 50+ programming languages
- Respects .gitignore rules
- Output in table, JSON, or CSV format
- Incremental caching for faster re-runs

## Installation

```bash
cargo install codestat
```

Or build from source:

```bash
git clone https://github.com/Cactusinhand/codestat
cd codestat
cargo build --release
```

The binary will be at `target/release/codestat`.

## Usage

Basic usage:

```bash
# Analyze current directory
codestat

# Analyze specific directory
codestat /path/to/project

# Analyze single file
codestat src/main.rs
```

Output formats:

```bash
# Table (default)
codestat --format table .

# JSON
codestat --format json .

# CSV
codestat --format csv .
```

Options:

```bash
# Show per-file statistics
codestat -F .

# Show progress
codestat --progress .

# Include hidden files
codestat --hidden .

# Filter by language
codestat --languages rust,python,go .

# Exclude patterns
codestat --exclude "*.test.js,*.min.css" .

# Disable parallel processing (less memory)
codestat --no-parallel .

# Follow symlinks
codestat --follow-links .
```

## Example Output

Table format:

```
================================================================================
 Language                  Files      Lines       Code   Comments     Blanks
--------------------------------------------------------------------------------
 Rust                          9       2536       1993        215        328
 Markdown                      2        356        260          0         96
 TOML                          1         35         32          0          3
--------------------------------------------------------------------------------
 Total                        12       2927       2285        215        427
================================================================================

Statistics completed in 0.014s (857 files/s, 209071 lines/s)
```

JSON format:

```json
{
  "summary": {
    "elapsed_ms": 6,
    "error_count": 0,
    "total_blanks": 405,
    "total_bytes": 84917,
    "total_code": 2235,
    "total_comments": 215,
    "total_files": 12,
    "total_lines": 2855
  },
  "languages": [
    {
      "blanks": 328,
      "bytes": 78300,
      "code": 1993,
      "comments": 215,
      "files": 9,
      "lines": 2536,
      "name": "Rust"
    },
    {
      "blanks": 74,
      "bytes": 5779,
      "code": 210,
      "comments": 0,
      "files": 2,
      "lines": 284,
      "name": "Markdown"
    },
    {
      "blanks": 3,
      "bytes": 838,
      "code": 32,
      "comments": 0,
      "files": 1,
      "lines": 35,
      "name": "TOML"
    }
  ],
  "files": null
}
```

## Implementation Notes

Techniques used for performance:

- **Memory mapping**: Large files use mmap to avoid copy overhead
- **Byte-level parsing**: Works on `&[u8]` directly, no UTF-8 validation
- **Parallel batching**: Files sorted by size for better load balancing
- **Cached detection**: Language detection uses static HashMap with O(1) lookup

## License

MIT