divio/lint

Divio lint 镜像文档

镜像概述和主要用途

Divio lint是一个Docker容器，用于对Dockerfile、Python、SCSS和JavaScript代码执行lint检查。它集成了多种主流lint工具，提供统一的代码质量检查解决方案，支持灵活配置和自动化工作流集成。

核心功能和特性

• 支持多类型文件检查：Dockerfile、Python、SCSS和JavaScript
• 集成多种专业lint工具：hadolint(Dockerfile)、ruff(Python)、prettier(SCSS/JS)
• 灵活的配置方式：通过环境变量指定检查路径
• 多种运行模式：全量检查、仅检查不修复、指定子集检查、暂存文件检查
• 内置Divio团队采用的默认配置，开箱即用

使用场景和适用范围

• 本地开发环境的代码质量检查
• 代码提交前的pre-commit钩子
• CI/CD流水线中的自动化代码质量控制
• 多语言项目的统一代码规范管理

使用方法和配置说明

基本使用

在bash中设置便捷别名并运行：

bash
alias lint="docker run --rm -it --env-file=.lint -v $(pwd):/app divio/lint /bin/lint"

# 运行所有配置的linters
lint

# 仅检查不自动修复
lint --check

# 仅运行指定的linters子集
lint --run=js,python

配置文件(.lint)

通过.env格式的.lint文件配置检查路径，内容为相对路径的环境变量：

# Dockerfile路径
LINT_FILE_DOCKER=Dockerfile

# Python代码目录
LINT_FOLDER_PYTHON=src

# SCSS文件路径(支持通配符)
LINT_FOLDER_SCSS=private/sass/**/*.scss

# JavaScript文件路径(支持通配符)
LINT_FOLDER_JS=static/js/**/*.js

注意：未设置的环境变量对应的linter将自动跳过。

可用选项

/bin/lint脚本支持以下选项：

• -c / --check: 仅检查代码合规性，不自动修复错误
• --staged: 仅对Git暂存文件运行检查，隐含--check选项，适用于pre-commit钩子
• --run: 指定运行的linters子集，可选值包括docker、python、scss、js，使用逗号分隔。--run=all等效于--run=python,js,docker,scss

集成的Linters

Dockerfile

• 工具：https://github.com/hadolint/hadolint
• 用途：检查Dockerfile的最佳实践和常见错误

Python

• 工具：https://github.com/astral-sh/ruff
• 用途：代码检查和格式化
• 配置要求：需在项目的pyproject.toml中添加：

  toml
  [tool.ruff]
      extend = "/presets/ruff.toml"
  

SCSS

• 工具：prettier
• 用途：SCSS代码格式化

JavaScript

• 工具：prettier
• 用途：JavaScript代码格式化

所有工具均已配置Divio团队采用的默认规则，确保代码风格一致性。