flywheel/lint repository overview

⁠flywheel/lint

NOTE: This image is deprecated and pending removal. Please use tools/img/qa-ci⁠ as a drop-in replacement.

Dockerized linting, style checks and formatting for both development and CI.

⁠Usage

This image is used within the test:flywheel-lint pre-commit hook and CI job in tools/etc/qa-ci⁠.

To run the image directly on any project folder:

docker run --rm -tv $(pwd):/src flywheel/lint

⁠Included tools

• black⁠
• hadolint⁠
• jsonlint⁠
• markdownlint⁠
• pydocstyle⁠
• safety⁠
• shellcheck⁠
• yamllint⁠

⁠Configuration

Arguments passed to the linters can be extended (or overridden) using environment variables, which are read from a .env file at the project root if present. For example, to ignore an error in shellcheck, add the following to your .env:

# add an extra exclude, leaving any default args intact
SHELLCHECK_EXTRA="--exclude=SC2061"

The default arguments passed to the tools are recommended to be kept as-is, but can also be overridden by using the _ARGS envvars (instead of _EXTRA):

# override the default google convention (see defaults below)
PYDOCSTYLE_ARGS="--convention=pep257"

Finally, the individual tools may support loading further custom settings from a default config location if it exists at the project root:

If not present, the following config files are auto-injected:

• .markdownlint.json⁠
• .yamllint.yml⁠

⁠Development

• Run pre-commit install
• Add new tools in the Dockerfile⁠
• Add new hooks to lint/hooks.yml⁠

⁠Publishing

Images are published to dockerhub⁠ on every successful CI build.

⁠License

⁠Repository

flywheel-io/tools/img/lint⁠