Axelgustavlindstrom/cmclean
GitHub: Axelgustavlindstrom/cmclean
一款语言无关的源代码注释结构 linter，用于扫描并标记代码库中堆积的 TODO、作者标签、阻塞式评论等注释残留物。
Stars: 0 | Forks: 0
# cmclean
一个用于源代码树的注释结构 linter。它会扫描源代码文件，并在注释残留物堆积之前将其标记出来：TODO/FIXME/HACK、作者标签、可疑的单行注释、过长的注释以及阻塞式评论。
## 关于
`cmclean` 是一个与语言无关的代码库静态分析助手。它会标记受支持文件类型（包括 Python、JavaScript/TypeScript、Markdown 和 JSON/YAML/TOML）中的有问题的注释模式。它不是一个完整的 linter；它的职责是*注释清理*。
## 功能
- 检测类 TODO 残留物：`TODO`、`FIXME`、`HACK`、`XXX`
- 检测作者标签：`@author`、`@created by`、`@written by`
- 检测可疑残留物：奇怪的符号、异常内容
- 检测归咎/阻塞式评论：`@blame`、`@debugger`、`@temp`、`@workaround`
- 检测超过配置长度的过长注释
- 支持识别 `.py`、`.js`、`.ts`、`.tsx`、`.md`、`.yaml`、`.yml`、`.json`、`.toml` 等多语言文件
- 输出 JSON 或人类可读的文本
- 通过 `python -m cmclean` 进行模块式调用
## 安装
```
python -m pip install cmclean
```
## 用法
```
cmclean /path/to/project
cmclean /path/to/project --json
```
```
python -m cmclean /path/to/project
python -m cmclean /path/to/project --json
```
### 退出代码
- `0` 未发现有问题的注释
- `1` 发现问题或调用错误
## 项目结构
```
cmclean/
├── .github/workflows/tests.yml
├── src/cmclean/
│ ├── __init__.py
│ ├── __main__.py
│ ├── cli.py
│ ├── engine.py
│ └── models.py
├── tests/
│ └── test_cmclean.py
├── docs/
│ └── docs.md
├── examples/demo_clean.py
├── pyproject.toml
└── README.md
```
## 开发
```
python -m pip install -e '.[dev]'
python -m pytest
```
## 代码仓库
https://github.com/Axelgustavlindstrom/cmclean
## 许可证
本项目基于 MIT 许可证授权。详情请参阅 `LICENSE`。
标签：Apache Flink, Python, SOC Prime, 云安全监控, 代码清理, 代码规范检查, 开发工具, 无后门, 网络入侵检测, 逆向工具, 静态分析