singapore/lint-condo

lint-condo

镜像概述与主要用途

lint-condo是一个Docker代码检查容器，旨在提供一种简单的方式，在任何有Docker环境的项目中集中运行代码检查（linting）。正如一句话所说：“开始为项目进行代码检查的最佳时间是项目启动时，其次是现在。”一旦开始代码检查，它会成为一种习惯。通过这个一体化镜像，你可以方便地添加额外的检查工具（如Markdown检查、YAML检查等）。我们的目标是支持流行的代码检查工具，同时保持合理的镜像体积（根据https://hub.docker.com/r/singapore/lint-condo/tags/显示约100MB）。

核心功能与特性

内置代码检查工具

lint-condo包含多种流行的代码检查工具，包括：

• https://github.com/brigade/scss-lint
• https://github.com/alecthomas/gometalinter
• https://github.com/amperser/proselint
• https://github.com/adrienverge/yamllint
• https://github.com/twbs/bootlint
• https://github.com/clutchski/coffeelint
• https://github.com/CSSLint/csslint
• https://github.com/charlierudolph/dependency-lint
• https://github.com/projectatomic/dockerfile_lint
• https://github.com/anandthakker/doiuse
• https://github.com/eslint/eslint + 插件
• jshint
• jslint
• markdownlint
• pug-lint
• remark-lint
• sass-lint
• stylelint
• tern-lint
• write-good
• xo

其他特性

• 支持自定义检查命令：可在配置文件中添加任意shell命令或脚本
• 轻量级镜像：体积约100MB，便于快速拉取和运行
• 易于集成：可无缝集成到本地开发流程和持续集成系统

使用场景与适用范围

• 本地开发环境：在开发过程中快速运行代码检查，确保代码质量
• 持续集成（CI）流程：作为CI流程的一部分，在代码提交或PR时自动运行检查，提前发现问题
• 多语言项目：支持多种编程语言和文件格式的代码检查，适用于混合技术栈项目

使用方法与配置说明

基本使用步骤

1. 准备配置文件：在项目根目录创建lint-condo.yaml或.lint-condo.yaml文件，定义要运行的检查命令（格式为shell命令列表）。示例配置文件可参考https://github.com/singapore/lint-condo/blob/master/.lint-condo.yaml。

2. 运行容器：通过Docker命令运行镜像，将项目目录挂载到容器的/src/目录：

sh
docker run -v `pwd`:/src/ docker.xuanyuan.run/singapore/lint-condo

持续集成配置示例

CircleCI

在项目根目录创建circle.yml文件，配置如下：

yaml
machine:
  services:
    - docker

dependencies:
  override:
    - echo true

test:
  override:
    - docker run -v `pwd`:/src/ singapore/lint-condo

建议将代码检查放在CI流程的首位，因为它通常是测试失败的常见原因。

其他CI服务（如SemaphoreCI、Shippable）也可类似配置，只需在测试步骤中添加上述Docker命令即可。

版本控制与标签

• latest标签：用于项目自身的代码检查，可获取最新功能（作为"金丝雀"测试）
• 版本标签：支持固定版本，可根据需要"固定"到特定版本
• 自动构建：Docker Hub会从singapore/lint-condo仓库自动构建镜像，确保可靠性

示例输出

lint-condo会输出每个检查工具的标准输出，随后是检查结果摘要。示例摘要如下：

sh
Summary:
✔ eslint
✔ jscs
✔ jshint
✔ yamllint
✔ markdownlint
✔ proselint
✔ remark
✔ write-good
✔ scss-lint
✔ sass-lint
✔ csslint
✔ stylelint
✔ doiuse
✔ sh test/colors.sh

输出说明

1. 摘要会简化"已知"命令（如eslint、csslint等）的参数，保持简洁
2. 支持自定义命令/脚本，如示例中的sh test/colors.sh，可用于执行项目特定的检查脚本

贡献与协作

如果缺少你需要的代码检查工具，请提交issue。欢迎协作或贡献代码。