jordanevans/linter

linter-docker 镜像文档

概述

linter-docker是一个预安装了多种代码检查工具（Linters）的Docker镜像，旨在提供便捷的代码质量检测环境，帮助开发团队快速进行代码风格验证和潜在问题识别，无需在本地环境单独配置各类检查工具。

核心功能与特性

• 多工具集成：预安装多种主流编程语言的代码检查工具（如ESLint、Pylint、RuboCop、StyleLint等）
• 即开即用：无需手动安装和配置依赖，拉取镜像后可直接使用
• 环境隔离：通过容器化方式提供独立的代码检查环境，避免本地环境冲突
• 轻量级设计：基于精简基础镜像构建，平衡功能与资源占用

使用场景

• 本地开发环境中的代码质量快速检查
• 集成到CI/CD流程，作为代码提交或合并前的自动化检查环节
• 团队协作中统一代码风格标准，确保代码一致性
• 临时代码审查或第三方项目代码质量评估

使用方法

基本使用（Docker Run）

bash
# 检查当前目录下的代码（以JavaScript项目为例，使用ESLint）
docker run --rm -v $(pwd):/app linter-docker eslint /app

# 检查Python项目（使用Pylint）
docker run --rm -v $(pwd):/app linter-docker pylint /app

Docker Compose 配置示例

yaml
version: '3'
services:
  linter:
    image: linter-docker
    volumes:
      - ./your-project:/app
    command: eslint /app  # 根据项目类型替换检查命令

支持的主要检查工具

• JavaScript/TypeScript: ESLint
• Python: Pylint, Flake8
• Ruby: RuboCop
• CSS/SCSS: StyleLint
• Java: Checkstyle
• Go: Golint

自定义配置

可通过挂载本地配置文件覆盖默认检查规则：

bash
# 挂载本地ESLint配置文件
docker run --rm -v $(pwd):/app -v $(pwd)/.eslintrc.js:/root/.eslintrc.js linter-docker eslint /app

注意事项

• 确保挂载的项目目录有适当的读写权限
• 根据项目类型选择对应的检查工具命令
• 部分工具可能需要项目依赖（如npm包），需提前在本地项目中安装