Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jessfraz/dockfmt
Dockerfile format and parser. Like `gofmt` but for Dockerfiles.
https://github.com/jessfraz/dockfmt
Last synced: about 1 month ago
JSON representation
Dockerfile format and parser. Like `gofmt` but for Dockerfiles.
- Host: GitHub
- URL: https://github.com/jessfraz/dockfmt
- Owner: jessfraz
- License: mit
- Created: 2016-09-19T23:22:45.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-16T17:22:04.000Z (6 months ago)
- Last Synced: 2024-01-23T09:05:35.045Z (4 months ago)
- Language: Go
- Homepage:
- Size: 7.54 MB
- Stars: 411
- Watchers: 17
- Forks: 23
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-docker - dockfmt - Dockerfile formatter and parser by [@jessfraz][jessfraz] (Docker Images / Linter)
- awesome-repositories - jessfraz/dockfmt - Dockerfile format and parser. Like `gofmt` but for Dockerfiles. (Go)
- awesome-docker-1 - dockfmt - Dockerfile formatter and parser by [@jessfraz][jessfraz] (Docker Images / Linter)
- awesome-docker - dockfmt - Dockerfile formatter and parser by [@jessfraz][jessfraz] (Docker Images / Linter)
- awesome-docker-docs - dockfmt - Dockerfile formatter and parser by [@jessfraz][jessfraz] (Docker Images / Linter)
- awesome-docker - dockfmt - Dockerfile formatter and parser by [@jessfraz][jessfraz] (Docker Images / Linter)
- awesome-docker-clone - dockfmt - Dockerfile formatter and parser by [@jessfraz][jessfraz] (Docker Images / Linter)
- awesome-docker - dockfmt - Dockerfile formatter and parser by [@jessfraz][jessfraz] (Docker Images / Linter)
- awesome-docker - dockfmt - Dockerfile formatter and parser by [@jessfraz][jessfraz] (Docker Images / Linter)
- awesome-docker - dockfmt - Dockerfile formatter and parser by [@jessfraz][jessfraz] (Docker Images / Linter)
- awesome - dockfmt - Dockerfile format and parser. Like `gofmt` but for Dockerfiles. (Go)
README
# dockfmt
[](https://github.com/jessfraz/dockfmt/actions?query=workflow%3A%22make+all%22)
[](https://github.com/jessfraz/dockfmt/actions?query=workflow%3A%22make+image%22)
[](https://godoc.org/github.com/jessfraz/dockfmt)
Dockerfile format.
**NOTE:** This is a work in progress so calm yourself if you want to file 80 bajillion
issues.
**Table of Contents**
- [Installation](#installation)
- [Binaries](#binaries)
- [Via Go](#via-go)
- [Usage](#usage)
- [Format](#format)
- [Get help](#get-help)
- [Get a diff](#get-a-diff)
- [List multiple files with different output](#list-multiple-files-with-different-output)
- [Base image inspection](#base-image-inspection)
- [Maintainer inspection](#maintainer-inspection)
- [Stage inspection](#stage-inspection)
- [Workdir inspection](#workdir-inspection)
## Installation
#### Binaries
For installation instructions from binaries please visit the [Releases Page](https://github.com/jessfraz/dockfmt/releases).
#### Via Go
```console
$ go get github.com/jessfraz/dockfmt
```
## Usage
```console
$ dockfmt -h
dockfmt - Dockerfile format.
Usage: dockfmt
Flags:
-d, --debug enable debug logging (default: false)
Commands:
base List the base image used in the Dockerfile(s).
dump Dump parsed Dockerfile(s).
fmt Format the Dockerfile(s).
maintainer List the maintainer for the Dockerfile(s).
stages List the stages in the Dockerfile.
workdir List the workdirs for the Dockerfile(s).
version Show the version information.
```
### Format
#### Get help
```console
$ dockfmt fmt -h
Usage: dockfmt fmt [OPTIONS] [DOCKERFILE...]
Format the Dockerfile(s).
Flags:
-D, --diff display diffs instead of rewriting files (default: false)
-d, --debug enable debug logging (default: false)
-l, --list list files whose formatting differs from dockfmt's (default: false)
-w, --write write result to (source) file instead of stdout (default: false)
```
#### Get a diff
```console
$ dockfmt fmt -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
+
+FROM alpine:latest
+MAINTAINER Jessie Frazelle
-RUN apk --no-cache add \
+RUN apk add --no-cache \
htop
-CMD [ "htop" ]
+CMD ["htop"]
```
#### List multiple files with different output
```console
$ 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
```console
$ 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
```console
$ dockfmt maintainer */Dockerfile */*/Dockerfile
MAINTAINER COUNT
Jessie Frazelle 113
Christian Koep 11
Justin Garrison 2
Daniel Romero 1
Cris G [email protected] 1
```
### Stage inspection
```console
$ dockfmt stages Dockerfile
STAGE INTERPOLATED
health-check false
python-deps false
stage-2 true
```
### Workdir inspection
```console
$ dockfmt workdir */Dockerfile */*/Dockerfile
WORKDIR COUNT
/srv 3
/app 1
```