meiliangwhut / dockfmt

Dockerfile format and parser.

dockfmt

Dockerfile format.

This is a work in progress so calm yourself if you want to file 80 bajillion issues.

Usage

Help output

$ dockfmt -h
NAME:
   dockfmt - Dockerfile format.

USAGE:
   dockfmt [global options] command [command options] [arguments...]

VERSION:
   v0.2.0

AUTHOR(S):
   @jfrazelle <[e-mail]>

COMMANDS:
     base         list the base image used in Dockerfile(s)
     dump         dump parsed Dockerfile(s)
     format, fmt  format the Dockerfile(s)
     maintainer   list the maintainer for Dockerfile(s)
     help, h      Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --debug, -D    run in debug mode
   --help, -h     show help
   --version, -v  print the version

Format

help output

$ dockfmt fmt -h
NAME:
   dockfmt format - format the Dockerfile(s)

USAGE:
   dockfmt format [command options] [arguments...]

OPTIONS:
   --diff, -d   display diffs instead of rewriting files
   --list, -l   list files whose formatting differs from dockfmt's
   --write, -w  write result to (source) file instead of stdout

get a diff

$ dockfmt format -d htop/Dockerfile
diff htop/Dockerfile dockfmt/htop/Dockerfile
--- /tmp/dockfmt143910590	2016-09-19 15:59:22.612250710 -0700
+++ /tmp/dockfmt412224773	2016-09-19 15:59:22.612250710 -0700
@@ -4,10 +4,11 @@
 # 	--pid host \
 # 	jess/htop
 #
-FROM alpine:latest
-MAINTAINER Jessie Frazelle <[e-mail]>
+
+FROM	alpine:latest
+MAINTAINER	Jessie Frazelle <[e-mail]>

-RUN apk --no-cache add \
+RUN	apk add --no-cache \
 	htop

-CMD [ "htop" ]
+CMD	["htop"]

list multiple files with different output

$ dockfmt fmt -l */Dockerfile */*/Dockerfile
ab/Dockerfile
afterthedeadline/Dockerfile
android-tools/Dockerfile
ansible/Dockerfile
apt-file/Dockerfile
atom/Dockerfile
audacity/Dockerfile
awscli/Dockerfile
beeswithmachineguns/Dockerfile
buttslock/Dockerfile
camlistore/Dockerfile
cathode/Dockerfile
...

Base image inspection

$ dockfmt base */Dockerfile */*/Dockerfile
BASE                          COUNT
debian:stretch                50
alpine:latest                 30
debian:sid                    28
ubuntu:16.04                  12
alpine:edge                   7
python:2-alpine               3
ruby:alpine                   2
java:7-alpine                 2
r.j3ss.co/wine                1
kalilinux/kali-linux-docker   1
haskell                       1
mhart/alpine-node:5           1
r.j3ss.co/cpuminer            1
opensuse                      1
java:8-alpine                 1
golang:latest                 1

Maintainer inspection

$ dockfmt maintainer */Dockerfile */*/Dockerfile
MAINTAINER                                      COUNT
Jessie Frazelle <[e-mail]>                113
Christian Koep <[e-mail]>      11
Justin Garrison <[e-mail]>   2
Daniel Romero <[e-mail]>             1
Cris G [e-mail]                         1