markstory/lint-review

Lint Review

Lint Review是一款自动化代码审查工具，专注于解决代码审查中执行编码标准的繁琐环节。它通过GitHub API运行仓库配置的lint工具，并在拉取请求中添加行注释，指出可能引入的lint错误，帮助团队保持代码风格一致性。

核心功能

• 支持多语言lint工具：覆盖Python、PHP、JavaScript、TypeScript、CSS、Ruby等多种语言的主流检查工具（如flake8、PHPCS、ESLint等）。
• GitHub PR集成：自动监听PR的打开/更新事件，触发检查并在PR中添加精准的行注释。
• 灵活配置：通过.lintrc文件自定义lint工具及规则，支持忽略特定文件或目录。
• Docker部署：所有工具通过容器执行，环境隔离性好，部署简单。
• 托管服务选项：提供Stickler CI托管版本，支持开源项目免费使用，付费版可用于私有仓库。

使用场景

• 开源项目：自动检查PR中的代码风格问题，提升社区贡献代码质量。
• 团队内部项目：统一编码标准，减少人工审查中的重复工作，提高协作效率。
• 多语言项目：一站式解决不同语言的代码检查需求，无需单独配置多个工具。

配置说明

基础依赖

• Python 2.7/3.6+
• RabbitMQ（或兼容Celery的消息队列）
• 可公开访问的主机名/IP（供GitHub webhook回调）
• 具有仓库读写权限的GitHub账号（用于发布评论）
• Docker（工具执行容器化）

Docker部署示例

1. 克隆仓库并配置环境变量：

bash
git clone git://github.com/markstory/lint-review.git
cd lint-review
cp settings.sample.py settings.py
# 编辑settings.py设置GITHUB_OAUTH_TOKEN等必要参数

2. 使用docker-compose启动服务：

bash
docker-compose up -d broker worker web

3. 注册GitHub webhook（以Docker方式为例）：

bash
docker-compose run web lintreview register <用户名> <仓库名>

.lintrc配置示例

在仓库根目录创建.lintrc文件，定义使用的工具及规则：

ini
[files]
ignore = generated/*
    vendor/*

[tools]
linters = pep8, jshint

[tool_pep8]
ignore = W2,E401

[tool_jshint]
config = path/to/jshint.json

运行服务

启动web服务（处理webhook）和Celery worker（执行lint检查）：

bash
# 非Docker方式
gunicorn -c settings.py lintreview.web:app
celery -A lintreview.tasks worker

当PR打开或更新时，工具会自动触发检查并在PR中添加注释。