Skip to content

Commit 6c80322

Browse files
committed
Updated README.md to improve the feature comparison table and usage instructions, emphasizing the advantages and performance features of CodeState
1 parent 220da17 commit 6c80322

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -162,21 +162,28 @@ codestate --list-extensions
162162

163163
## Comparison
164164

165-
| Tool | Quick ASCII visuals | Duplicate code | Git hotspots/churn | Contributors stats | Exports (HTML/CSV/Excel) | Caching |
166-
| --- | --- | --- | --- | --- | --- | --- |
167-
| CodeState | Yes (pie/heatmap/bar) | Yes | Yes | Yes | Yes | Yes |
168-
| cloc | No | No | No | No | Limited | No |
169-
| scc | Limited | No | No | No | Limited | No |
170-
| radon | Complexity only | No | No | No | No | No |
165+
| Feature | CodeState | cloc | scc | tokei |
166+
| --- | --- | --- | --- | --- |
167+
| Stats (files/lines/comments) | Yes | Yes | Yes | Yes |
168+
| ASCII charts / heatmap in terminal | Yes | No | No | No |
169+
| Report exports (HTML / Markdown / CSV) | Yes | Limited | Limited | Limited |
170+
| .gitignore awareness & caching | Yes | Manual excludes | Manual excludes | Manual excludes |
171+
| Hotspots / duplicates / naming checks | Yes | No | No | No |
172+
173+
Notes:
174+
- “Manual excludes” means the tool supports flags to ignore paths but doesn’t automatically read .gitignore or provide built-in caching like CodeState.
175+
- See Performance benchmarks below for speed guidance and how to reproduce measurements.
171176

172177
## Why CodeState?
173178

174-
- Beyond LOC: detect duplicates, complexity hotspots, refactor candidates, naming, dead code.
175-
- Developer-facing: ASCII charts (pie/heatmap/bar) directly in terminal — great for quick reviews.
176-
- History-aware: hotspots/churn from git to guide refactoring.
177-
- Team insights: contributors and blame stats per file.
178-
- Fast on repeats: built-in caching for large repos.
179-
Flexible exports: HTML/Markdown/JSON/CSV/Excel for reports and CI artifacts.
179+
- Instant understanding: go beyond LOC to highlight duplicates, complexity hotspots, refactor candidates, naming issues, and dead code — right in your terminal.
180+
- Visual by default: ASCII pie/heatmap/bar charts make trends obvious during reviews, without leaving the CLI.
181+
- History-aware decisions: git hotspots/churn help you prioritize the files that matter most.
182+
- Team visibility: contributors and blame insights per file unlock ownership and onboarding context.
183+
- CI-ready artifacts: export HTML/Markdown/JSON/CSV/Excel for reports, dashboards, and pipelines.
184+
- Faster repeat runs: built-in caching and .gitignore support keep large repositories snappy over time.
185+
186+
Tip: Combine CodeState with a GitHub Action to post a compact Markdown summary on every PR.
180187

181188
## Star History
182189

0 commit comments

Comments
 (0)