nemooudeis/ktlint

ktlint容器，为CI流水线构建

镜像概述和主要用途

该Docker镜像用于在CI（持续集成）环境中运行https://ktlint.github.io/%E4%BB%A3%E7%A0%81%E9%A3%8E%E6%A0%BC%E6%A3%80%E6%9F%A5%E5%B7%A5%E5%85%B7%EF%BC%8C%E6%97%A0%E9%9C%80%E5%9C%A8%E6%9C%AC%E5%9C%B0%E6%88%96CI%E6%9C%BA%E5%99%A8%E4%B8%8A%E5%8D%95%E7%8B%AC%E5%AE%89%E8%A3%85ktlint%E3%80%82%E6%BA%90%E4%BB%A3%E7%A0%81%E6%89%98%E7%AE%A1%E4%BA%8Ehttps://github.com/NemoOudeis/ci-docker/tree/master/ktlint%E3%80%82%E9%80%9A%E8%BF%87%E8%AF%A5%E9%95%9C%E5%83%8F%EF%BC%8C%E5%8F%AF%E5%9C%A8%E8%BF%9C%E7%A8%8B%E6%9C%BA%E5%99%A8%E6%88%96CI%E6%B5%81%E6%B0%B4%E7%BA%BF%E4%B8%AD%E4%BE%BF%E6%8D%B7%E6%89%A7%E8%A1%8CKotlin%E4%BB%A3%E7%A0%81%E9%A3%8E%E6%A0%BC%E6%A3%80%E6%9F%A5%E3%80%82

核心功能和特性

• 无需本地安装：直接通过Docker容器运行ktlint，避免环境依赖问题
• CI友好：专为CI流水线设计，可作为构建流程中的独立步骤集成
• 快速反馈：在测试执行前提供代码风格检查结果，缩短问题反馈周期
• 灵活文件匹配：支持通过命令参数指定需要检查的Kotlin文件路径

使用场景和适用范围

• CI/CD流水线：作为代码提交或PR（拉取请求）检查的前置步骤
• 快速风格验证：当测试流程耗时较长时，优先执行ktlint检查以快速发现代码风格问题
• 多环境一致性：确保不同开发或CI环境中使用统一的ktlint版本和配置
• 支持主流CI平台：如CircleCI、Jenkins、GitLab CI等

使用方法和配置说明

基本使用（本地或远程机器）

通过docker run命令直接运行，挂载当前工作目录到容器内的/code路径，指定需要检查的Kotlin文件：

shell
docker run --rm --mount type=bind,src=${PWD},dst=/code nemooudeis/ktlint ktlint "/code/**/*.kt"

参数说明：

• --rm：容器退出后自动删除
• --mount type=bind,src=${PWD},dst=/code：将当前目录（${PWD}）挂载到容器内的/code目录
• nemooudeis/ktlint：镜像名称
• ktlint "/code/**/*.kt"：执行ktlint命令，检查/code目录下所有.kt文件

CI流水线集成示例（CircleCI）

在CircleCI配置中添加独立的ktlint检查任务，仅检查PR与origin/master之间变更的Kotlin文件：

yaml
jobs:
  ktlint:
    docker: 
      - image: nemooudeis/ktlint
    steps:
      - checkout  # 拉取代码
      - run: 
          name: ktlint检查PR与origin/master之间变更的Kotlin文件
          command: |
            set +e  # 允许grep命令失败（当没有变更的Kotlin文件时）
            # 获取PR与origin/master之间变更的Kotlin文件列表
            files=$(git diff $(git show-ref origin/master -s) HEAD --name-only --relative | grep '\.kt[s"]\?

配置说明：
- `jobs.ktlint`：定义ktlint检查任务，使用`nemooudeis/ktlint`镜像
- `steps.checkout`：拉取代码到CI环境
- `steps.run.command`：执行具体检查逻辑，仅检查变更的Kotlin文件以提高效率
- `workflows`：设置构建流程，确保`build`任务在`ktlint`检查通过后执行)
            # 若没有变更的Kotlin文件，输出提示并正常退出
            [ -z "$files" ] && echo "未变更Kotlin文件，检查通过！" && exit 0
            # 对变更的文件执行ktlint检查
            echo $files | xargs ktlint --relative .

  build:  # 实际构建、测试、部署等任务

workflows:
  version: 2
  build_and_publish:
    jobs:
      - ktlint  # 先执行ktlint检查
      - build:
          requires:
            - ktlint  # 构建任务依赖ktlint检查通过

配置说明：

• CODE_TOKEN_13：定义ktlint检查任务，使用__CODE_TOKEN_14__镜像
• CODE_TOKEN_15：拉取代码到CI环境
• CODE_TOKEN_16：执行具体检查逻辑，仅检查变更的Kotlin文件以提高效率
• CODE_TOKEN_17：设置构建流程，确保__CODE_TOKEN_18__任务在__CODE_TOKEN_19__检查通过后执行