github.com/bwplotka/mdox
mdox (spelled as md docs) is a CLI for maintaining automated, high-quality project documentation and website leveraging Github Flavored Markdown and git.
89/100: overall quality above the stdlib waterlevel. Compare against stdlib or another package. How ratings work. API and README badge.
The Go project is only 206x bigger than this project (2891 files against 14).
| Check | Score | Bonus | |
|---|---|---|---|
| complexity | 100 | +7 | |
| average cyclomatic complexity 3.93 against the stdlib average of 4.22 | |||
| complexity_p95 | 100 | +10 | |
| 95th percentile cyclomatic complexity 12 against the stdlib waterlevel of 15 | |||
| file_size_curve | 100 | +10 | |
| share of small files +3.8% against the stdlib size curve | |||
| godoc_coverage | 64 | ||
| 27 of 54 exported symbols carry godoc (50% against the stdlib waterlevel of 77%) | |||
| median_file_size | 100 | +10 | |
| median file 3142 B against the stdlib waterlevel of 3966 B | |||
| median_package_size | 100 | +10 | |
| median package 6005 B against the stdlib waterlevel of 21278 B | |||
| test_ratio | 15 | ||
| 7 test functions for 54 exported symbols (12% pairing, ideal band 80-100%, stdlib waterlevel 80%) | |||