{"id":51026826,"url":"https://github.com/gitstq/commentpilot","last_synced_at":"2026-06-21T20:02:24.122Z","repository":{"id":358095204,"uuid":"1240005931","full_name":"gitstq/commentpilot","owner":"gitstq","description":"🔍 CommentPilot - Lightweight Code Comment Quality Intelligent Analysis Engine | 轻量级代码注释质量智能分析引擎 - Zero dependencies, multi-language support, coverage analysis, quality scoring, TODO tracking","archived":false,"fork":false,"pushed_at":"2026-05-15T17:08:55.000Z","size":17,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-15T19:53:32.362Z","etag":null,"topics":["cli","code-coverage","code-quality","comment-analysis","developer-tools","documentation","linting","python","static-analysis","zero-dependency"],"latest_commit_sha":null,"homepage":"https://github.com/gitstq/commentpilot","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gitstq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-15T17:08:02.000Z","updated_at":"2026-05-15T17:09:03.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/gitstq/commentpilot","commit_stats":null,"previous_names":["gitstq/commentpilot"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/gitstq/commentpilot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitstq%2Fcommentpilot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitstq%2Fcommentpilot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitstq%2Fcommentpilot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitstq%2Fcommentpilot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gitstq","download_url":"https://codeload.github.com/gitstq/commentpilot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitstq%2Fcommentpilot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34623906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-21T02:00:05.568Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","code-coverage","code-quality","comment-analysis","developer-tools","documentation","linting","python","static-analysis","zero-dependency"],"created_at":"2026-06-21T20:02:23.394Z","updated_at":"2026-06-21T20:02:24.110Z","avatar_url":"https://github.com/gitstq.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CommentPilot - Lightweight Code Comment Quality Intelligent Analysis Engine\n# 轻量级代码注释质量智能分析引擎\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)\n[![Zero Dependencies](https://img.shields.io/badge/dependencies-zero-green.svg)](https://github.com/gitstq/commentpilot)\n\n**CommentPilot** 是一个零依赖的命令行工具，用于分析代码注释质量、覆盖率，并检测缺失或过时的注释。\n\n## ✨ 核心特性\n\n- 🔍 **注释覆盖率分析** - 统计代码中的注释比例\n- ⚠️ **缺失注释检测** - 自动检测未添加注释的函数、类、模块\n- 📝 **注释质量评分** - 智能评估注释质量\n- 📋 **TODO/FIXME 追踪** - 汇总项目中的待办事项\n- 🌐 **多语言支持** - Python, JavaScript, TypeScript, Go, Java, Rust, C/C++, C#, PHP, Ruby, Swift, Kotlin, Scala, Lua, Shell\n- 📊 **TUI 仪表板** - 美观的终端界面展示\n- 📄 **多格式报告** - JSON, HTML, Markdown\n- ⚡ **零依赖** - 纯 Python 实现，无需安装第三方库\n\n## 🚀 快速开始\n\n### 安装\n\n```bash\n# 克隆仓库\ngit clone https://github.com/gitstq/commentpilot.git\ncd commentpilot\n\n# 直接运行\npython commentpilot.py ./your-project\n```\n\n### 使用方法\n\n```bash\n# 分析项目\npython commentpilot.py ./src\n\n# 输出 JSON 格式\npython commentpilot.py ./src --format json --output report.json\n\n# 输出 HTML 报告\npython commentpilot.py ./src --format html --output report.html\n\n# 排除特定目录\npython commentpilot.py ./src --exclude \"tests,docs,vendor\"\n```\n\n## 📖 详细使用指南\n\n### 命令行参数\n\n| 参数 | 说明 |\n|------|------|\n| `path` | 要分析的项目目录 |\n| `--format, -f` | 输出格式：console, json, markdown, html |\n| `--output, -o` | 输出文件路径 |\n| `--exclude, -e` | 排除的目录/文件模式（逗号分隔） |\n| `--version, -v` | 显示版本号 |\n\n### 支持的语言\n\n| 语言 | 扩展名 |\n|------|--------|\n| Python | .py |\n| JavaScript | .js, .mjs, .cjs |\n| TypeScript | .ts, .tsx |\n| Go | .go |\n| Java | .java |\n| Rust | .rs |\n| C | .c, .h |\n| C++ | .cpp, .hpp, .cc |\n| C# | .cs |\n| PHP | .php |\n| Ruby | .rb |\n| Swift | .swift |\n| Kotlin | .kt, .kts |\n| Scala | .scala |\n| Lua | .lua |\n| Shell | .sh, .bash, .zsh |\n\n### 输出示例\n\n```\n============================================================\n📊 CommentPilot Analysis Report\n============================================================\n\n📁 Project: /path/to/project\n⏰ Analyzed: 2025-05-15T17:00:00\n\n----------------------------------------\n📈 Summary\n----------------------------------------\n  Total Files:      42\n  Total Lines:      12,345\n  Code Lines:       9,876\n  Comment Lines:    1,234\n  Coverage:         10.0%\n  Quality Score:    65.5/100\n\n----------------------------------------\n🌐 Language Statistics\n----------------------------------------\n  python       25 files,  8,000 lines, 12.5% coverage\n  javascript   12 files,  3,000 lines,  8.3% coverage\n  go            5 files,  1,345 lines, 15.2% coverage\n\n----------------------------------------\n📋 TODO Summary\n----------------------------------------\n  TODO         15\n  FIXME         3\n\n----------------------------------------\n💡 Recommendations\n----------------------------------------\n  ⚠️ Warning: Comment coverage is low (\u003c20%). Add comments to improve code maintainability.\n  📋 Found 18 TODO/FIXME items to review.\n\n============================================================\n```\n\n## 📦 项目结构\n\n```\ncommentpilot/\n├── commentpilot.py      # 主程序\n├── test_commentpilot.py # 测试脚本\n├── README.md            # 说明文档\n├── README_CN.md         # 中文说明\n├── README_TW.md         # 繁体中文说明\n├── LICENSE              # MIT 许可证\n└── .gitignore           # Git 忽略配置\n```\n\n## 🤝 贡献指南\n\n欢迎提交 Issue 和 Pull Request！\n\n1. Fork 本仓库\n2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)\n3. 提交更改 (`git commit -m 'feat: Add some AmazingFeature'`)\n4. 推送到分支 (`git push origin feature/AmazingFeature`)\n5. 创建 Pull Request\n\n## 📄 开源协议\n\n本项目采用 MIT 协议开源 - 详见 [LICENSE](LICENSE) 文件。\n\n## 🙏 致谢\n\n感谢所有为代码质量做出贡献的开发者！\n\n---\n\n**Made with ❤️ by CommentPilot Team**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitstq%2Fcommentpilot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitstq%2Fcommentpilot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitstq%2Fcommentpilot/lists"}