Table of contents

\n\n\n\n\n- [About](#about)\n - [Features](#features)\n- [Usage](#usage)\n - [Local - Linux & macOS](#local---linux--macos)\n - [Local - Windows](#local---windows)\n - [GitLabCI](#gitlabci)\n - [CircleCI](#circleci)\n - [GitHub Actions](#github-actions)\n- [Configuration](#configuration)\n- [Included linters](#included-linters)\n - [All files](#all-files)\n - [General configs](#general-configs)\n - [Package manager files](#package-manager-files)\n - [Dry runners](#dry-runners)\n - [Validators](#validators)\n - [CI/CD services](#cicd-services)\n - [Makefiles](#makefiles)\n - [Dockerfiles](#dockerfiles)\n - [XML, HTML, SVG](#xml-html-svg)\n - [Documentation (Markdown, Plain Text)](#documentation-markdown-plain-text)\n - [Shell script files](#shell-script-files)\n - [Python](#python)\n- [Development](#development)\n - [Prepare you system](#prepare-you-system)\n - [Build & Run](#build--run)\n- [License](#license)\n- [Alternatives](#alternatives)\n\n\n\n\n

\n\n## About\n\nThe main purpose of _AZLint_ is to bundle as many linters as possible into a single Docker image\nand provide convenient CLI interface for calling them in bulk.\n\nI see it as a complement to\n[SuperLinter](https://github.com/github/super-linter) and\n[MegaLinter](https://github.com/nvuillam/mega-linter).\nThese meta-linters are awesome, but are missing some features of _AZLint_.\n\nAll that said, AZLint is mostly for my personal usage.\nHowever feel free to use it and report any found issues 😉.\n\n### Features\n\n- 📦 Includes 48 linters\n- 🛠️ Supports **autofix** mode (only for 9 linters though)\n- 🐳 Distributed as a Docker image (both `x64`/`arm64` available)\n- 💯 Reports all found problems\n- 🏎️ Runs linters in parallel\n- 🌈 Clear, colored output\n\n## Usage\n\n![azlint demo](./docs/demo.gif)\n\n**NOTE:** In this chapter, we will use `:latest` tag.\nIt is recommended to replace `:latest` with a specific `version` when you use it.\n\nGo to dockerhub's [tags](https://hub.docker.com/r/matejkosiarcik/azlint/tags?page=1&ordering=last_updated)\nto see all available tags or go to github's [releases](https://github.com/matejkosiarcik/azlint/releases)\nfor all project versions.\n\n### Local - Linux & macOS\n\nTo **lint** files in current directory:\n\n```sh\ndocker run -itv \"${PWD}:/project:ro\" matejkosiarcik/azlint:latest lint\n```\n\nTo **format** files in current directory:\n\n```sh\ndocker run -itv \"${PWD}:/project\" matejkosiarcik/azlint:latest fmt\n```\n\nWhen in doubt, print help:\n\n```sh\n$ docker run matejkosiarcik/azlint:latest --help\nUsage: azlint [options…] [dir]\n\nCommands:\n azlint lint - Lint project (default)\n azlint fmt - Format project (autofix)\n\nPositionals:\n dir Path to project directory [string] [default: \".\"]\n\nOptions:\n -h, --help Show usage [boolean]\n -V, --version Show version [boolean]\n -v, --verbose Verbose logging (stackable, max: -vvv) [count]\n -q, --quiet Less logging [boolean]\n --only-changed Analyze only changed files (requires project to be a git directory) [boolean]\n -n, --dry-run Dry run [boolean]\n --color Colored output [string] [choices: \"auto\", \"never\", \"always\"] [default: \"auto\"]\n```\n\n### Local - Windows\n\nRefer to _Linux & macOS_ examples above, just swap `${PWD}` to `%cd%`, for example:\n\n```bat\ndocker run -itv \"%cd%:/project:ro\" matejkosiarcik/azlint:latest lint\n```\n\n### GitLabCI\n\n```yaml\nazlint:\n image: matejkosiarcik/azlint:latest\n script:\n - lint\n```\n\n### CircleCI\n\n```yaml\nversion: 2.1\n\nworkflows:\n version: 2\n workflow:\n jobs:\n - azlint\n\njobs:\n azlint:\n docker:\n - image: matejkosiarcik/azlint:latest\n steps:\n - checkout\n - run: lint\n```\n\n### GitHub Actions\n\n```yaml\nname: AZLint\n\npermissions: read-all\n\non:\n push:\n branches:\n - main\n pull_request:\n\njobs:\n azlint:\n name: AZLint\n runs-on: ubuntu-latest\n container:\n image: matejkosiarcik/azlint:latest\n options: --user root\n steps:\n - name: Checkout\n uses: actions/checkout@v3\n with:\n fetch-depth: 0 # Full git history is needed to get a proper list of changed files\n\n - name: Run AZLint\n run: lint\n```\n\n## Configuration\n\nAZLint is configured by environment variables with `AZLINT_` prefix.\n\n\nAZLint looks for config files in following places by default: `[git-root]/` and `[git-root]/.config/`.\nYou can specify a custom config directory with: `AZLINT_CONFIG_DIR=some/config/directory`\n(note: _path_ value is relative to `[git-root]`).\n\nAZLint will find config files and pass them to linters automatically.\nIf you want to specify a custom config file for a specific linter, set `AZLINT_FOO_CONFIG_FILE=some/path/file.json`\n(note 1: replace `FOO` with specific linter's name;\nnote 2: file path is relative to specified config directory).\n\nYou can turn off linters/formatters by specifying environment variable `VALIDATE_FOO=false`\n(note: replace `FOO` with specific linter's name).\n\nA note about linter names, if a linter is named `foo-bar`,\nthen you need to specify environment variable named `FOO_BAR`\n(so capitalized and underscores instead of dashes).\n\nWhen using `--only-changed`, AZLint compares current `HEAD` with the project's default Git branch (usually `master` or `main`).\nYou may set `AZLINT_DEFAULT_BASE_BRANCH` to set a different comparison base.\nIf the Git base or comparison cannot be determined, then AZLint falls back to linting all files, rather than risk skipping committed changes.\n\n## Included linters\n\n\n\n\n### All files\n\n| tool | links | disable | files | `fmt` support |\n|-----------------------------|----------------------------------------------------------------------------------------------------------------------------|---------------------------------|-------|---------------|\n| editorconfig-checker | [GitHub](https://github.com/editorconfig-checker/editorconfig-checker)
[docs](https://editorconfig-checker.github.io) | `VALIDATE_EDITORCONFIG_CHECKER` | `*` | ❌ |\n| eclint | [GitHub](https://github.com/jednano/eclint) | `VALIDATE_ECLINT` | `*` | ❌ |\n| Git check-ignore \\[custom\\] | - | `VALIDATE_GITIGNORE` | `*` | ✅ |\n| jscpd | [GitHub](https://github.com/kucherenko/jscpd) | `VALIDATE_JSCPD` | `*` | ❌ |\n\n### General configs\n\n| tool | links | disable | files | `fmt` support |\n|--------------------|----------------------------------------------------------------------------------------------------------|---------------------|-------------------------|---------------|\n| dotenv-linter | [GitHub](https://github.com/dotenv-linter/dotenv-linter)
[docs](https://dotenv-linter.github.io) | `VALIDATE_DOTENV` | `*.env` | ❌ |\n| jsonlint | [GitHub](https://github.com/prantlf/jsonlint)
[try-online](https://prantlf.github.io/jsonlint) | `VALIDATE_JSONLINT` | `*.json` | ❌* |\n| prettier | [GitHub](https://github.com/prettier/prettier)
[docs](https://prettier.io) | `VALIDATE_PRETTIER` | `*.{json,yml,css,html}` | ✅ |\n| stoml | [GitHub](https://github.com/freshautomations/stoml) | `VALIDATE_STOML` | `*.{cfg,ini,toml}` | ❌ |\n| tomljson (go-toml) | [GitHub](https://github.com/pelletier/go-toml) | `VALIDATE_TOMLJSON` | `*.toml` | ❌ |\n| yamllint | [GitHub](https://github.com/adrienverge/yamllint)
[docs](https://yamllint.readthedocs.io/en/stable) | `VALIDATE_YAMLLINT` | `*.{yml,yaml}` | ❌ |\n\n_Jsonlint*_ - Formatting conflicts with prettier, so it is turned off.\n\n### Package manager files\n\n#### Dry runners\n\nThese tools are not real \"linters\".\nThese tools are vanilla package managers, which we invoke with a `dry-run` flag to only _attempt_ to install dependencies without actually installing them.\nThis verifies the given config files are actually working in that respective package manager.\n\n| tool | links | disable | files | `fmt` support |\n|------------------|----------------------------------------------------------------------------------------------------------------------|-----------------------------|--------------------------------------|---------------|\n| brew-bundle | [GitHub](https://github.com/Homebrew/homebrew-bundle)
[manpage](https://docs.brew.sh/Manpage#bundle-subcommand) | `VALIDATE_BREW_BUNDLE` | `Brewfile` | ❌ |\n| composer-install | [docs](https://getcomposer.org) | `VALIDATE_COMPOSER_INSTALL` | `composer.json` | ❌ |\n| pip-install | [docs](https://pip.pypa.io/en/stable/cli/pip_install) | `VALIDATE_PIP_INSTALL` | `requirements.txt` | ❌ |\n| npm-install | [docs](https://docs.npmjs.com/cli/v9/commands/npm-install) | `VALIDATE_NPM_INSTALL` | `package.json` | ❌ |\n| npm-ci | [docs](https://docs.npmjs.com/cli/v9/commands/npm-ci) | `VALIDATE_NPM_CI` | `package.json` & `package-lock.json` | ❌ |\n\n#### Validators\n\nExtra validators for package-manager files.\nThese check additional rules, which are recommended, but not required for the config files to be valid.\n\n| tool | links | disable | files | `fmt` support |\n|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|-----------------|---------------|\n| composer-normalize | [GitHub](https://github.com/ergebnis/composer-normalize)
[blogpost](https://localheinz.com/articles/2018/01/15/normalizing-composer.json) | `VALIDATE_COMPOSER_NORMALIZE` | `composer.json` | ✅ |\n| composer-validate | [docs](https://getcomposer.org/doc/03-cli.md#validate) | `VALIDATE_COMPOSER_VALIDATE` | `composer.json` | ❌ |\n| package-json-validator | [GitHub](https://github.com/gorillamania/package.json-validator) | `VALIDATE_PACKAGE_JSON` | `package.json` | ❌ |\n\n### CI/CD services\n\n| tool | links | disable | files | `fmt` support |\n|--------------------|-------------------------------------------------------------------------------------------------|------------------------------|------------------------|---------------|\n| CircleCI CLI lint | [docs](https://cli.circleci.com)
[GitHub](https://github.com/CircleCI-Public/circleci-cli) | `VALIDATE_CIRCLECI_VALIDATE` | `.circleci/config.yml` | ❌ |\n| gitlab-ci-lint | [GitHub](https://github.com/BuBuaBu/gitlab-ci-lint) | `VALIDATE_GITLABCI_LINT` | `.gitlab-ci.yml` | ❌ |\n| gitlab-ci-validate | [GitHub](https://github.com/pradel/gitlab-ci-validate) | `VALIDATE_GITLABCI_VALIDATE` | `.gitlab-ci.yml` | ❌ |\n\n### Makefiles\n\n| tool | links | disable | files | `fmt` support |\n|-----------|----------------------------------------------------------------------------------------------------|----------------------|-----------------|---------------|\n| checkmake | [GitHub](https://github.com/mrtazz/checkmake) | `VALIDATE_CHECKMAKE` | `Makefile` etc. | ❌ |\n| BSD Make | [manpage](https://man.netbsd.org/make.1) | `VALIDATE_BMAKE` | `Makefile` etc. | ❌ |\n| GNU Make | [docs](https://www.gnu.org/software/make)
[manpage](https://www.gnu.org/software/make/manual) | `VALIDATE_GMAKE` | `Makefile` etc. | ❌ |\n\n### Dockerfiles\n\n| tool | links | disable | files | `fmt` support |\n|----------------|-------------------------------------------------------------------------------------------------------|---------------------------|-------------------|---------------|\n| dockerfilelint | [GitHub](https://github.com/replicatedhq/dockerfilelint)
[try-online](https://www.fromlatest.io) | `VALIDATE_DOCKERFILELINT` | `Dockerfile` etc. | ❌ |\n| hadolint | [GitHub](https://github.com/hadolint/hadolint) | `VALIDATE_HADOLINT` | `Dockerfile` etc. | ❌ |\n\n### XML, HTML, SVG\n\n| tool | links | disable | files | `fmt` support |\n|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|----------------|---------------|\n| HTMLHint | [GitHub](https://github.com/HTMLHint/HTMLHint) | `VALIDATE_HTMLHINT` | `*.{html,htm}` | ❌ |\n| htmllint | [GitHub](https://github.com/htmllint/htmllint) | `VALIDATE_HTMLLINT` | `*.{html,htm}` | ❌ |\n| SVGLint | [GitHub](https://github.com/birjolaxew/svglint) | `VALIDATE_SVGLINT` | `*.svg` | ❌ |\n| xmllint | [GitLab](https://gitlab.gnome.org/GNOME/libxml2)
[docs](http://www.xmlsoft.org)
[manpage](https://gnome.pages.gitlab.gnome.org/libxml2/xmllint.html) | `VALIDATE_XMLLINT` | `*.xml` | ✅ |\n\n### Documentation (Markdown, Plain Text)\n\n| tool | links | disable | files | `fmt` support |\n|---------------------|--------------------------------------------------------|--------------------------------|--------------|---------------|\n| markdown-link-check | [GitHub](https://github.com/tcort/markdown-link-check) | `VALIDATE_MARKDOWN_LINK_CHECK` | `*.md` | ❌ |\n| markdownlint | [GitHub](https://github.com/DavidAnson/markdownlint) | `VALIDATE_MARKDOWNLINT` | `*.md` | ✅ |\n| markdownlint (mdl) | [GitHub](https://github.com/markdownlint/markdownlint) | `VALIDATE_MDL` | `*.md` | ❌ |\n| proselint | [GitHub](https://github.com/amperser/proselint) | `VALIDATE_PROSELINT` | `*.{md,txt}` | ❌ |\n\n### Shell script files\n\n| tool | links | disable | files | `fmt` support |\n|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|-------------|---------------|\n| bashate | [GitHub](https://github.com/openstack/bashate)
[opendev](https://opendev.org/openstack/bashate)
[docs](https://docs.openstack.org/bashate/latest) | `VALIDATE_BASHATE` | `*.sh` etc. | ❌ |\n| bats-core | [GitHub](https://github.com/bats-core/bats-core)
[docs](https://bats-core.readthedocs.io/en/stable) | `VALIDATE_BATS` | `*.bats` | ❌ |\n| shellcheck | [GitHub](https://github.com/koalaman/shellcheck)
[wiki](https://github.com/koalaman/shellcheck/wiki)
[try-online](https://www.shellcheck.net) | `VALIDATE_SHELLCHECK` | `*.sh` etc. | ❌ |\n| shellharden | [GitHub](https://github.com/anordal/shellharden) | `VALIDATE_SHELLHARDEN` | `*.sh` etc. | ❌ |\n| shfmt | [GitHub](https://github.com/mvdan/sh)
[go pkg](https://pkg.go.dev/mvdan.cc/sh/v3) | `VALIDATE_SHFMT` | `*.sh` etc. | ✅ |\n| hush | [GitHub](https://github.com/hush-shell/hush)
[docs](https://hush-shell.github.io) | `VALIDATE_HUSH` | `*.hush` | ❌ |\n| Custom dry runner | - | `VALIDATE_SHELL_DRY_RUN` | `*.sh` etc. | ❌ |\n\nThe following shells are checked in custom dry runner:\n\n| tool | links | linter ID | files | `fmt` support |\n|-------------------------------------|------------------------------------------|-------------------|--------------|---------------|\n| Linux port of OpenBSD's ksh (loksh) | [GitHub](https://github.com/dimkr/loksh) | `LOKSH` - `loksh` | `*.{sh,ksh}` | ❌ |\n| Portable OpenBSD ksh (oksh) | [GitHub](https://github.com/ibara/oksh) | `OKSH` - `oksh` | `*.{sh,ksh}` | ❌ |\n\n### Python\n\n| tool | links | disable | files | `fmt` support |\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|--------|---------------|\n| autopep8 | [GitHub](https://github.com/hhatto/autopep8)
[pypi](https://pypi.org/project/autopep8) | `VALIDATE_AUTOPEP8` | `*.py` | ❌* |\n| black | [GitHub](https://github.com/psf/black)
[docs](https://black.readthedocs.io/en/stable)
[pypi](https://pypi.org/project/black) | `VALIDATE_BLACK` | `*.py` | ✅ |\n| flake8 | [GitHub](https://github.com/PyCQA/flake8)
[docs](https://flake8.pycqa.org/en/latest)
[pypi](https://pypi.org/project/flake8) | `VALIDATE_FLAKE8` | `*.py` | ❌ |\n| isort | [GitHub](https://github.com/PyCQA/isort)
[docs](https://pycqa.github.io/isort)
[pypi](https://pypi.org/project/isort) | `VALIDATE_ISORT` | `*.py` | ✅ |\n| pycodestyle | [GitHub](https://github.com/PyCQA/pycodestyle)
[docs](https://pycodestyle.pycqa.org/en/latest)
[pypi](https://pypi.org/project/pycodestyle) | `VALIDATE_PYCODESTYLE` | `*.py` | ❌ |\n| pylint | [GitHub](https://github.com/PyCQA/pylint)
[docs](https://pylint.readthedocs.io/en/latest)
[pypi](https://pypi.org/project/pylint) | `VALIDATE_PYLINT` | `*.py` | ❌ |\n| mypy | [GitHub](https://github.com/python/mypy)
[docs](https://www.mypy-lang.org)
[pypi](https://pypi.org/project/mypy) | `VALIDATE_MYPY` | `*.py` | ❌ |\n\n_Autopep8*_ - Formatting conflicts with black, so it is turned off.\n\n\n\n\n## Development\n\n### Prepare you system\n\nIn order to develop on this project, first install required system packages.\n\n- If you are on macOS and have [Homebrew](https://brew.sh) available,\n just run `brew bundle install` in project's root directory.\n This will install all packages from `Brewfile` (learn more about [Homebrew Bundle](https://github.com/Homebrew/homebrew-bundle)).\n- If you are on Debian/Ubuntu Linux, check out `.circleci/config.yml` -> job _native-build_ for `apt-get` instructions.\n- If you are on Windows, you need to find and install packages yourself - check out [Chocolatey](https://chocolatey.org).\n\nNote: Also make sure you have Docker installed.\n\nNow run `make bootstrap` to install local project dependencies.\n\n### Build & Run\n\nTo run project locally:\n\n```sh\nnpm --prefix cli run azlint:fmt && npm --prefix cli run azlint:lint\n```\n\nTo build and run project in Docker:\n\n```sh\nmake build run\n```\n\n## License\n\nThis project is licensed under the MIT License,\nsee [LICENSE.txt](LICENSE.txt) for full license details.\n\n## Alternatives\n\n- [super-linter](https://github.com/github/super-linter)\n- [mega-linter](https://github.com/nvuillam/mega-linter)\n- [git-lint](https://github.com/sk-/git-lint) (deprecated)\n","has_starred","hub_user","immutable_tags_settings",{"_201":11,"_202":203},"enabled","rules",[204],".*","is_automated","permissions",{"_208":21,"_209":11,"_210":11},"read","write","admin","user","storage_size",279810783551,"isOrg","reponame","tag","sha256:c60ce2383243fe5abf9965d5673f545f28d6c1a70d083653311d9560e23a0b1f","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","showSbxLogoOverride","showSbxAgenticPlatformBadge","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_27":28,"_153":-7,"_151":-7,"_152":-7,"_29":227,"_35":217,"_231":-7,"_232":11},{"_31":32,"_33":34,"_35":36,"_37":38,"_39":40,"_41":228,"_67":68,"_69":34,"_70":71,"_72":73,"_74":75,"_76":77,"_78":50,"_79":68,"_80":60,"_81":21},[229,230],{"_44":45,"_35":46,"_47":48,"_49":50,"_51":52,"_53":54,"_55":48,"_56":-5,"_57":58,"_59":60,"_61":-5},{"_44":63,"_35":64,"_47":48,"_49":65,"_51":66,"_53":54,"_55":48,"_56":-5,"_57":38,"_59":60,"_61":-5},"imageWithLayers","hasPermissionToViewRepoSettings","actionData","errors"]

matejkosiarcik/azlint:edge