whalelint

command module
v0.0.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 5, 2022 License: MIT Imports: 5 Imported by: 0

README

WhaleLint

made-with-Go

Disclaimer: this has started out as a pet-project while learning Golang.

Dockerfile linter written in Go.

It provides static analysis for Dockerfiles, identifying common mistakes and promotes best practices.

Sample output

Rules

Each Dockerfile AST element has a corresponding set of rules. Click on the picture for details.

Development

Roadmap
Feature Status
Extendable ruleset Done
CLI Done
Configurable Output Done
- JSON Done
- Colored Summary Done
Docker image Done
Rule pass NotYetStarted
- Per line NotYetStarted
- Config file NotYetStarted
Config file NotYetStarted
- Rule profiles NotYetStarted
IDE plugins/extensions InProgress
- VSCode PreviewRelease
- JetBrains PreviewRelease
Design Decisions

A collection of documents describing the thought process behind selected design decisions. Link >

Contribution Guide

Link > TODO

Docker Image

Docker imaage version DockerHub Downloads Docker image size

docker pull cremindes/whalelint:[tag]
docker run --rm -v $(pwd)/Dockerfile:/Dockerfile cremindes/whalelint:[tag] Dockerfile

Plugins

JetBrains

Version Downloads

*Note: make sure, to also install the Docker plugin in case it's not bundled with the IDE.

VSCode

Version Installs

Alternatives

Alternatives

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
ruleset
ruleset provides a set of rules and their corresponding validator functions for linting Dockerfile AST elements.
ruleset provides a set of rules and their corresponding validator functions for linting Dockerfile AST elements.
Package lsp is a partial Language Server Protocol implementation.
Package lsp is a partial Language Server Protocol implementation.
Package parser package help parse various strings into meaningful - bash commands or chains of bash commands.
Package parser package help parse various strings into meaningful - bash commands or chains of bash commands.
Package report provides different formats, i.e views on rule validation results that are printed to the provided io.Writer.
Package report provides different formats, i.e views on rule validation results that are printed to the provided io.Writer.
Package utils is collections of utility functions for the Whalelint project.
Package utils is collections of utility functions for the Whalelint project.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL