Done-0/fuck-u-code: Legacy-Mess Detector – assess the “legacy-mess level” of your code and output a beautiful terminal report | 屎山代码检测器,评估代码的“屎山等级”并输出美观的终端报告 #
fuck-u-code Public
Legacy-Mess Detector – assess the “legacy-mess level” of your code and output a beautiful terminal report | 屎山代码检测器,评估代码的“屎山等级”并输出美观的终端报告
Open in github.dev Open in a new github.dev tab Open in codespace
fuck-u-code #
一款专门揭露屎山代码的质量分析工具,用犀利又搞笑的方式告诉你: 你的代码到底有多烂 。
特性 #
- 多语言支持: Go、JS/TS、Python、Java、C/C++
- 屎山指数: 0~100 分,越高越烂
- 七维度检测: 复杂度 / 函数长度 / 注释率 / 错误处理 / 命名 / 重复度 / 结构
- 彩色终端报告: 批评也能笑着听
- Markdown 输出: 方便 AI 分析与文档集成
- 灵活配置: 摘要 / 详细模式,多语言报告
安装 #
# 方法一:Go 安装
go install github.com/Done-0/fuck-u-code/cmd/fuck-u-code@latest
# 方法二:源码构建
git clone https://github.com/Done-0/fuck-u-code.git
cd fuck-u-code && go build -o fuck-u-code ./cmd/fuck-u-code
# 方法三:Docker 构建
docker build -t fuck-u-code .
使用方法 #
# 基本分析
fuck-u-code analyze /path/to/project
# 或
fuck-u-code /path/to/project
# Docker 运行
docker run --rm -v "/path/to/project:/build" fuck-u-code analyze
# 默认分析当前目录
fuck-u-code analyze
常用选项 #
| 选项 | 简写 | 描述 |
|---|---|---|
--verbose | -v | 显示详细报告 |
--top N | -t | 最烂的前 N 个文件 |
--issues N | -i | 每文件显示 N 个问题 |
--summary | -s | 只看总结,不看过程 |
--markdown | -m | 输出 Markdown 格式报告 |
--lang | -l | 报告语言 (zh-CN/en-US) |
--exclude | -e | 排除指定目录或文件 |
--skipindex | -x | 跳过 index.js/ts 文件 |
示例 #
fuck-u-code analyze --verbose
fuck-u-code analyze --top 3
fuck-u-code analyze --lang en-US
fuck-u-code analyze --summary
fuck-u-code analyze --exclude "**/test/**"
fuck-u-code analyze --markdown > report.md
高级用法 #
Markdown 输出 #
适合 AI 分析、文档集成、CI/CD、团队协作
fuck-u-code analyze --markdown
fuck-u-code analyze --markdown > report.md
fuck-u-code analyze --markdown --top 10 --lang en-US > report.md
Markdown 报告包含:总体评分 / 指标表格 / 问题文件 / 改进建议
默认排除路径 #
- 前端:
node_modules、dist、build、*.min.js等 - 后端:
vendor、bin、target、logs、migrations等
疑难解答 #
command not found→ 把 Go bin 路径加到PATH:
并写入export PATH="$PATH:$(go env GOPATH)/bin".bash_profile/.zshrc等
许可证 #
MIT
贡献 #
欢迎提 PR,一起优化“fuck-u-code” 🚀