godolint

A Dockerfile linter that helps you build best practice Docker images (inspired by Haskell Dockerfile Linter). For static analysis of AST, moby/buildkit parser is used, and lint check is done. This tool performs docker rule checks based on the parsed AST.

Dependency

• moby/buildkit/frontend/dockerfile/parser
  • The official Dockerfile parser provided by moby. Used when parsing Dockerfile.

Usage

You can run godolint locally to lint your Dockerfile.

$ godolint <Dockerfile>

Example

To check Dockerfile

$ godolint testdata/DL3000_Dockerfile
#3 DL3000 Use absolute WORKDIR. 

$ godolint testdata/DL3001_Dockerfile
#6 DL3001 For some bash commands it makes no sense running them in a Docker container like `ssh`, `vim`, `shutdown`, `service`, `ps`, `free`, `top`, `kill`, `mount`, `ifconfig`. 

Options

You can set some options:

Available options:
  --ignore RULECODE     A rule to ignore. If present, the ignore list in the
                        config file is ignored

Other Commands:
  --help        -h      Help about any command
  --version     -v      Print the version information

Example

To check Dockerfile (exclude specific rules).

$ godolint --ignore DL3000 testdata/DL3000_Dockerfile

Install

You can download binary from release page and place it in $PATH directory.

Or you can use go get

$ go get github.com/zabio3/godolint

Rules

An implemented rules. (Dockerfile lint rule provided by hadolint)

AST

Dockerfile syntax is fully described in the Dockerfile reference. Just take a look at moby/buildkit in the language-docker project to see the AST definition.

Contribution

Contributions are of course always welcome!

1. Fork zabio3/godolint (https://github.com/zabio3/godolint/fork)
2. Run go get to install dependencies
3. Create a feature branch
4. Commit your changes
5. Run test using go test ./...
6. Create a Pull Request

See CONTRIBUTING.md for details.

Build Docker Image

1. Run make docker
2. Create a new tag for that release (in this example 0.1.2): docker tag zabio3/godolint zabio3/godolint:v0.1.2
3. Push to Docker hub: docker push zabio3/godolint zabio3/godolint:v0.1.2