mishamyrt/checode
mishamyrt
Checode是一款代码注释关键词提取工具，可识别并报告代码中的TODO、FIXME等标记，支持多语言、多线程处理，适用于CI环境，帮助团队追踪代码中的待办任务与问题。
下载次数: 0状态：社区镜像维护者：mishamyrt仓库类型：镜像最近更新：4 年前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
Checode镜像说明
镜像概述
Checode是一款轻量级代码注释关键词提取工具，能够自动识别代码中的TODO、FIXME、STOPSHIP等标记，并生成结构化报告。它支持多语言项目，采用多线程处理提升扫描效率，可无缝集成到CI/CD流程中，帮助开发团队高效追踪未完成任务或待修复问题。
核心功能
- 语言无关：兼容各类编程语言的注释语法，无需针对特定语言配置。
- 多线程处理：利用多线程并行扫描代码，大幅缩短大规模代码库的处理时间。
- CI就绪：提供简洁的CI配置示例，可快速集成到GitLab CI等持续集成环境。
使用场景
- 本地代码扫描：直接在命令行中扫描本地代码目录，快速获取注释标记报告。
- CI/CD集成：作为质量检查步骤，在CI流程中自动扫描代码，及时发现待处理任务。
配置说明
Checode默认读取当前目录下的.checode.yaml配置文件，默认配置如下：
yamlkeywords: TODO: warn FIXME: err STOPSHIP: err
可通过自定义配置文件扩展关键词处理规则，例如：
yamlkeywords: XXX: warn HACK: warn
若需使用自定义配置文件，可通过-c参数指定：
shchecode -c custom_config.yaml src/
Docker部署示例
命令行使用
shdocker run --rm -v $(pwd):/app docker.xuanyuan.run/mishamyrt/checode checode src/
（注：将src/替换为你需要扫描的代码目录路径）
GitLab CI集成
在.gitlab-ci.yml中添加以下配置：
yamlchecode: stage: quality_assurance image: mishamyrt/checode script: - checode src/
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
DockerHub 原生拉取命令
docker pull mishamyrt/checode:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"