AZLint

全方位代码检查工具（Lint everything From A to Z）

项目链接：

• GitHub: <[***]>
• DockerHub: <[***]>

目录

• 概述
  • 核心特性
• 使用方法
  • 本地 - Linux & macOS
  • 本地 - Windows
  • GitLabCI
  • CircleCI
  • GitHub Actions
• 配置说明
• 包含的检查工具
  • 所有文件
  • 通用配置文件
  • 包管理器文件
    • 模拟安装工具
    • 验证工具
  • CI/CD服务配置
  • Makefile文件
  • Dockerfile文件
  • XML, HTML, SVG文件
  • 文档文件（Markdown、纯文本）
  • Shell脚本文件
  • Python文件

概述

AZLint的主要目的是将尽可能多的代码检查工具（linters）捆绑到单个Docker镜像中，并提供便捷的命令行接口（CLI）实现批量调用。

它可作为SuperLinter和MegaLinter的补充工具。这些元检查工具非常出色，但AZLint具备它们缺失的部分特性。

需要说明的是，AZLint最初主要用于个人使用，但欢迎大家使用并报告发现的问题 😉。

核心特性

• 📦 集成48种代码检查工具
• 🛠️ 支持自动修复模式（目前9种工具支持）
• 🐳 提供Docker镜像（支持x64/arm64架构）
• 💯 报告所有发现的问题
• 🏎️ 并行运行检查工具
• 🌈 清晰的彩色输出

使用方法

!azlint演示

注意：本章示例使用:latest标签。实际使用时建议将:latest替换为具体版本号。

可在DockerHub的标签页查看所有可用标签，或在GitHub的发布页查看所有项目版本。

本地 - Linux & macOS

检查当前目录文件：

sh
docker run -itv "$PWD:/project:ro" matejkosiarcik/azlint:latest lint

格式化当前目录文件：

sh
docker run -itv "$PWD:/project" matejkosiarcik/azlint:latest fmt

查看帮助信息：

sh
$ docker run matejkosiarcik/azlint:latest --help
Usage: azlint <command> [options…] [dir]

Commands:
  azlint lint  检查项目（默认命令）
  azlint fmt   格式化项目（自动修复）

位置参数:
  dir  项目目录路径  [字符串] [默认值: "."]

选项:
  -h, --help          显示帮助信息  [布尔值]
  -V, --version       显示版本信息  [布尔值]
  -v, --verbose       详细日志（可叠加，最多-vvv）  [计数]
  -q, --quiet         减少日志输出  [布尔值]
      --only-changed  仅分析变更文件（要求项目为Git仓库）  [布尔值]
  -n, --dry-run       模拟运行  [布尔值]
      --color         彩色输出  [字符串] [可选值: "auto", "never", "always"] [默认值: "auto"]

本地 - Windows

参考上述Linux & macOS示例，将$PWD替换为%cd%即可，例如：

bat
docker run -itv "%cd%:/project:ro" matejkosiarcik/azlint:latest lint

GitLabCI

yaml
azlint:
  image: matejkosiarcik/azlint:latest
  script:
    - lint

CircleCI

yaml
version: 2.1

workflows:
  version: 2
  workflow:
    jobs:
      - azlint

jobs:
  azlint:
    docker:
      - image: matejkosiarcik/azlint:latest
    steps:
      - checkout
      - run: lint

GitHub Actions

yaml
name: AZLint

permissions: read-all

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  azlint:
    name: AZLint
    runs-on: ubuntu-latest
    container:
      image: matejkosiarcik/azlint:latest
      options: --user root
    steps:
      - name: 检出代码
        uses: actions/checkout@v3
        with:
          fetch-depth: 0 # 需要完整Git历史以获取正确的变更文件列表

      - name: 运行AZLint
        run: lint

配置说明

AZLint通过带AZLINT_前缀的环境变量进行配置。

AZLint默认在以下位置查找配置文件：[git-root]/和[git-root]/.config/。可通过AZLINT_CONFIG_DIR=some/config/directory指定自定义配置目录（注意：路径相对于[git-root]）。

AZLint会自动查找配置文件并传递给检查工具。如需为特定检查工具指定自定义配置文件，可设置AZLINT_FOO_CONFIG_FILE=some/path/file.json（注意1：将FOO替换为具体检查工具名称；注意2：文件路径相对于指定的配置目录）。

可通过设置环境变量AZLINT_FOO=false禁用特定检查工具或格式化工具（注意：将FOO替换为具体检查工具名称）。

关于检查工具名称的说明：若检查工具名为foo-bar，对应的环境变量需命名为FOO_BAR（即大写并将连字符替换为下划线）。

包含的检查工具

所有文件

通用配置文件

Jsonlint - 格式化功能与prettier冲突，因此已禁用。

包管理器文件

模拟安装工具

这些工具并非真正的"检查工具"，而是原生包管理器，通过dry-run标志仅尝试安装依赖而不实际安装，用于验证配置文件在对应包管理器中的可用性。

验证工具

包管理器文件的额外验证工具，检查推荐但非必需的配置规则。

CI/CD服务配置

Makefile文件

Dockerfile文件

XML, HTML, SVG文件

文档文件（Markdown、纯文本）