matejkosiarcik/azlint repository overview

⁠AZLint

Project links:

• GitHub: https://github.com/matejkosiarcik/azlint⁠
• DockerHub: https://hub.docker.com/r/matejkosiarcik/azlint⁠

Platform	Latest version
GitHub
DockerHub

⁠About

The main purpose of AZLint is to bundle as many linters as possible into a single docker image and provide convenient CLI interface for calling them in bulk.

I see it as a complement to SuperLinter⁠ and MegaLinter⁠. These meta-linters are awesome, but are missing some features of AZLint.

All that said, AZLint is mostly for my personal usage. However feel free to use it and report any found issues 😉.

⁠Features

• 📦 Includes 48 linters
• 🛠️ Supports autofix mode (only for 9 linters though)
• 🐳 Distributed as a docker image (both x64/arm64 available)
• 💯 Reports all found problems
• 🏎️ Runs linters in parallel
• 🌈 Clear, colored output

⁠Usage

NOTE: In this chapter, we will use :latest tag. It is recommended to replace :latest with a specific version when you use it.

Go to dockerhub's tags⁠ to see all available tags or go to github's releases⁠ for all project versions.

⁠Local - Linux & macOS

To lint files in current directory:

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

To format files in current directory:

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

When in doubt, print help:

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

Commands:
  azlint lint  Lint project (default)
  azlint fmt   Format project (autofix)

Positionals:
  dir  Path to project directory  [string] [default: "."]

Options:
  -h, --help          Show usage  [boolean]
  -V, --version       Show version  [boolean]
  -v, --verbose       Verbose logging (stackable, max: -vvv)  [count]
  -q, --quiet         Less logging  [boolean]
      --only-changed  Analyze only changed files (requires project to be a git directory)  [boolean]
  -n, --dry-run       Dry run  [boolean]
      --color         Colored output  [string] [choices: "auto", "never", "always"] [default: "auto"]

⁠Local - Windows

Refer to Linux & macOS examples above, just swap $PWD to %cd%, for example:

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

⁠GitLabCI

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

⁠CircleCI

version: 2.1

workflows:
  version: 2
  workflow:
    jobs:
      - azlint

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

⁠GitHub Actions

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: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 0 # Full git history is needed to get a proper list of changed files

      - name: Run AZLint
        run: lint

⁠Configuration

AZLint is configured by environment variables with AZLINT_ prefix.

AZLint looks for config files in following places by default: [git-root]/ and [git-root]/.config/. You can specify a custom config directory with: AZLINT_CONFIG_DIR=some/config/directory (note: path value is relative to [git-root]).

AZLint will find config files and pass them to linters automatically. If you want to specify a custom config file for a specific linter, set AZLINT_FOO_CONFIG_FILE=some/path/file.json (note 1: replace FOO with specific linter's name; note 2: file path is relative to specified config directory).

You can turn of linters/formatters by specifying environment variable AZLINT_FOO=false (note: replace FOO with specific linter's name).

A note about linter names, if a linter is named foo-bar, then you need to specify environment variable named FOO_BAR (so capitalized and underscores instead of dashes).

⁠Included linters

⁠All files

⁠General configs

Jsonlint* - Formatting conflicts with prettier, so it is turned off.

⁠Package manager files

⁠Dry runners

These tools are not real "linters". These tools are vanilla package managers, which we invoke with a dry-run flag to only attempt to install dependencies without actually installing them. This verifies the given config files are actually working in that respective package manager.

⁠Validators

Extra validators for package-manager files. These check additional rules, which are recommended, but not required for the config files to be valid.

⁠CI/CD services

⁠Makefiles

⁠Dockerfiles

⁠XML, HTML, SVG

⁠Documentation (Markdown, Plain Text)

⁠Shell script files

The following shells are checked in custom dry runner:

⁠Python

Autopep8* - Formatting conflicts with black, so it is turned off.

⁠Development

⁠Prepare you system

In order to develop on this project, first install required system packages.

• If you are on macOS and have Homebrew⁠ available, just run brew bundle install in project's root directory. This will install all packages from Brewfile (learn more about Homebrew Bundle⁠).
• If you are on Debian/Ubuntu Linux, check out .circleci/config.yml -> job native-build for apt-get instructions.
• If you are on Windows, you need to find and install packages yourself - check out Chocolatey⁠.

Note: Also make sure you have Docker installed.

Now run make bootstrap to install local project dependencies.

⁠Build & Run

To run project locally:

npm run azlint:fmt && npm run azlint:lint

To build and run project in docker:

make build run

⁠License

This project is licensed under the MIT License, see LICENSE.txt⁠ for full license details.

⁠Alternatives

• super-linter⁠
• mega-linter⁠
• git-lint⁠ (deprecated)