cljkondo/clj-kondo

clj-kondo Docker镜像文档

镜像概述和主要用途

clj-kondo Docker镜像是一款针对Clojure及ClojureScript代码的静态分析工具（linter）容器化版本。该镜像旨在帮助开发者通过便捷的容器化方式，对代码进行自动化检查，及时发现语法错误、潜在问题及风格不一致，从而提升代码质量与开发效率。

核心功能和特性

• 精准静态分析：深度扫描Clojure/ClojureScript代码，检测未定义变量、类型不匹配、语法错误等问题
• 灵活代码风格检查：支持自定义规则配置，适配团队代码规范与项目需求
• 高效性能表现：采用增量分析机制，对大型项目仍保持快速响应
• 多场景兼容性：兼容Clojure标准库及主流框架，支持.clj、.cljs、.cljc等文件类型
• 轻量易用：容器化设计简化部署流程，无需复杂环境依赖配置

使用场景和适用范围

• 本地开发辅助：集成到IDE或命令行工作流，在编码阶段实时反馈代码问题
• CI/CD流程集成：作为自动化构建环节的质量门禁，在代码提交或合并前执行检查
• 开源项目维护：帮助项目维护者统一代码风格，降低贡献代码审核成本
• 团队协作规范：通过一致的检查规则，确保团队成员代码风格统一

使用方法和配置说明

1. 获取镜像

从Docker Hub拉取最新版本镜像：

bash
docker pull docker.xuanyuan.run/clj-kondo/clj-kondo

如需指定版本，可添加标签（例如v2024.03.17）：

bash
docker pull docker.xuanyuan.run/clj-kondo/clj-kondo:v2024.03.17

2. 基本代码检查

挂载本地项目目录并执行检查（将当前目录作为项目根目录）：

bash
docker run --rm -v $(pwd):/app docker.xuanyuan.run/clj-kondo/clj-kondo --lint /app

• --rm：容器运行结束后自动清理
• -v $(pwd):/app：将本地项目目录挂载至容器内/app路径
• --lint /app：对挂载目录下的代码执行检查

3. 自定义配置

通过项目内.clj-kondo/config.edn文件定义检查规则，容器会自动读取配置：

bash
# 项目结构示例
your-project/
├── .clj-kondo/
│   └── config.edn  # 自定义规则配置
└── src/
    └── core.clj

执行检查命令（配置文件会随项目目录一同挂载）：

bash
docker run --rm -v $(pwd):/app docker.xuanyuan.run/clj-kondo/clj-kondo --lint /app/src

4. CI/CD集成示例（GitHub Actions）

在自动化流程中添加代码检查步骤：

yaml
jobs:
  code-quality:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      
      - name: Run clj-kondo lint
        run: |
          docker run --rm -v $(pwd):/app docker.xuanyuan.run/clj-kondo/clj-kondo --lint /app

更多信息

完整的Docker使用指南及高级配置选项，请参考官方文档：https://github.com/clj-kondo/clj-kondo/blob/master/doc/install.md#docker