schaefj/linter

代码检查工具集合镜像文档

镜像概述和主要用途

本Docker镜像集成了多种功能的代码检查工具（linter）可执行文件，旨在为开发过程提供便捷的代码质量检查解决方案。支持对多种类型文件进行规范性和语法检查，适用于本地开发环境及CI/CD流程中的自动化代码质量控制。

核心功能和特性

• 多工具集成：包含多种常用代码检查工具，如：
  • yamllint（YAML文件语法及格式检查）
  • tflint（Terraform配置文件检查）
  • shfmt（Shell脚本格式化与检查）
  • stylelint（CSS/SCSS等样式文件检查）
  • eslint（JavaScript/TypeScript代码检查）等

使用场景和适用范围

• 本地开发环境中，对代码进行实时规范性检查，确保提交前代码质量
• CI/CD流程（如GitLab CI、GitHub Actions等）中的自动化代码质量检测环节，作为测试阶段的一部分

详细的使用方法和配置说明

前置条件

将以下文件复制到Git仓库的基础目录：

1. https://github.com/joesuf4/home/blob/wsl/linter.rc
2. https://github.com/joesuf4/home/blob/wsl/linter.sh

可选配置

1. 将 git commit -a ... 工作流替换为 gac 别名
2. 安装 pre-commit 钩子

shell
alias gac='git add -u && git commit'
./linter.sh install

GitLab CI 集成示例

以下是在GitLab CI中集成该镜像的配置示例：

yaml
linter:
  variables:
    DOCKER_TLS_CERTDIR: /certs  # Docker TLS证书目录
  image: docker:20.10.16  # 使用的Docker镜像版本
  services:
    - docker:20.10.16-dind  # Docker-in-Docker服务
  stage: test  # 所属CI阶段
  allow_failure: true  # 允许任务失败
  script:
    - "LANG=en_US.UTF-8 docker run -t --rm -v $(pwd):/src:ro schaefj/linter"  # 运行linter容器，挂载当前目录为只读卷

本地使用方法

在本地环境中，可通过以下命令运行镜像进行代码检查：

shell
docker run -t --rm -v $(pwd):/src:ro schaefj/linter

• -t：分配伪终端，确保输出正常显示
• --rm：容器退出后自动删除
• -v $(pwd):/src:ro：将当前工作目录以只读方式挂载到容器的/src目录，供linter检查代码