golangci/golangci-lint

golangci-lint Docker镜像文档

概述与主要用途

golangci-lint是一款快速的Go代码检查工具运行器，用于对Go代码进行静态分析，提升代码质量和规范性。它通过整合多种代码检查器（linters），帮助开发者在开发过程中及时发现潜在问题、风格不一致及性能隐患。

核心功能与特性

• 快速高效：并行运行多个代码检查器，显著提升检查速度
• 缓存机制：采用缓存减少重复检查，优化二次运行效率
• 灵活配置：支持YAML格式配置文件（.golangci.yml），可自定义检查规则
• IDE集成：与主流IDE（如VS Code、GoLand等）无缝集成，提供实时反馈
• 丰富检查器：内置超过100种代码检查器，覆盖代码风格、错误检测、性能优化等多维度

使用场景与适用范围

• Go项目开发：本地开发环境中对Go代码进行实时质量检查
• CI/CD流程：集成到持续集成/部署 pipeline，确保代码提交前符合质量标准
• 团队协作：统一代码检查规则，维持团队代码风格一致性
• 开源项目：作为代码贡献规范的一部分，自动检查PR质量

使用方法与配置说明

基本使用（Docker Run）

在本地Go项目目录中运行代码检查：

bash
docker run --rm -v $(pwd):/app -w /app docker.xuanyuan.run/golangci/golangci-lint:latest golangci-lint run

• --rm：检查完成后自动删除容器
• -v $(pwd):/app：将本地项目目录挂载到容器内/app目录
• -w /app：设置工作目录为/app（项目根目录）
• golangci-lint run：执行代码检查命令（默认检查当前目录所有Go文件）

自定义配置

通过项目根目录的.golangci.yml文件自定义检查规则，容器会自动读取该配置：

yaml
# .golangci.yml 示例配置
linters:
  enable:
    - errcheck   # 检查未处理的错误
    - gofmt      # 检查代码格式化
    - golint     # 检查代码风格
  disable:
    - unused     # 禁用未使用变量检查（根据需求调整）

使用自定义配置运行：

bash
docker run --rm -v $(pwd):/app -w /app docker.xuanyuan.run/golangci/golangci-lint:latest golangci-lint run --config .golangci.yml

文档与支持

• 官方文档：完整配置及使用说明请参考 [***]
• 支持该项目：golangci-lint是免费开源项目，若您觉得有价值，可通过以下方式支持：
  • 支持golangci-lint项目
  • 感谢检查器作者