sourceatlas 0.1.1

Analyze source code repositories and generate project statistics
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

# SourceAtlas


SourceAtlas is a command-line tool written in Rust that scans a source code repository and generates useful statistics.

I started this project as a way to learn Rust by building something practical instead of only completing exercises. The goal isn't to compete with existing tools, but to build a clean, well-structured application while learning more about idiomatic Rust and software engineering.

## Features


Current features include:

- Recursive directory scanning
- Ignores common build and IDE directories:
  - `target`
  - `build`
  - `node_modules`
  - `.idea`
  - `.vscode`
- Reports:
  - Directories scanned
  - Files scanned
  - Files analyzed
  - Files skipped
  - Total lines
  - Blank lines
  - Non-blank lines
  - Characters
  - Functions (currently Rust only)
  - TODO comments
- Gracefully skips unreadable or binary files
- Unit tested

## Installation


Install from crates.io:

```bash
cargo install sourceatlas
```

Or build from source:

```bash
git clone https://github.com/jesse-kroon/sourceatlas.git
cd sourceatlas
cargo build --release
```

## Usage


Scan the current directory:

```bash
sourceatlas scan .
```

Scan another directory:

```bash
sourceatlas scan /path/to/project
```

## Example Output


```text
----------
|sourceatlas|
----------

DIRECTORIES
--------
total directories: 55

FILES
--------
total files found: 86
total files analyzed: 43
total files skipped: 43
total lines: 1607
total characters: 40438
total non-blank lines: 1372
total blank lines: 235
total functions: 16
total TODO's: 26
```

*The above output is generated when running sourceatlas on itself*

## Roadmap


Some features I'd like to add:

- More visually appealing report generation
- Support for more languages
- Custom ignore files
- JSON output
- Markdown reports
- Better language detection
- Parallel directory scanning
- Additional repository metrics

## Why SourceAtlas?


The idea behind the name is simple: rather than just counting lines of code, SourceAtlas aims to provide an overview of a source tree—almost like a map of a repository.

## License


This project is licensed under the MIT License.