dprint / dprint-plugin-dockerfile

Dockerfile code formatting plugin for dprint.

dprint

Monorepo for dprint—a pluggable and configurable code formatting platform.

Links

• Overview
• Getting Started
• Playground

Plugins

• dprint-plugin-typescript - TypeScript/JavaScript code formatter.
• dprint-plugin-json - JSON/JSONC code formatter.
• dprint-plugin-markdown - Markdown code formatter.
• dprint-plugin-toml - TOML code formatter.
• dprint-plugin-jupyter - Jupyter notebook code block formatter.
• dprint-plugin-dockerfile - Dockerfile code formatter.
• dprint-plugin-biome - Biome (JS/TS) wrapper plugin.
• dprint-plugin-prettier - Prettier wrapper plugin.
• dprint-plugin-roslyn - Roslyn (C#/VB) wrapper plugin.
• dprint-plugin-ruff - Ruff (Python) wrapper plugin.
• dprint-plugin-exec - Formats code with any CLI executable.

Notes

This repo is under active early development.

1. The interface between the CLI and plugins might change often. You may need to keep updating to the latest version of both the CLI and plugins (the CLI will let you know what to do).
   • An upgrade path will be outlined in the release notes when this occurs.
2. I do a lot of this development in my spare time. Please consider sponsoring if you are a commercial company using this.

dprint-plugin-dockerfile's Issues

`dprint init`'s `includes` does not follow common Dockerfile name

Describe the bug

Dockerfiles are usually named Dockerfile, most tools will work with a file named as such by default, not .dockerfile

dprint-plugin-dockerfile version: 0.3.0

Input Code

dprint init (select at least dprint-plugin-dockerfile)

Expected Output

  "includes": ["**/Dockerfile"],

Actual Output

  "includes": ["**/.{dockerfile}"],

[Bug] Parse error caused by FROM instruction with digest

Describe the bug
When the expression FROM <image>@digest is included, a parse error occurs.
It also gives an error when I use FROM <image>:tag@digest.

dprint-plugin-dockerfile version: 0.3.0

Input Code

FROM ghcr.io/jqlang/jq@sha256:12f998e5a6f3f6916f744ba6f01549f156f624b42f7564e67ec6dd4733973146 as fetch-jq

Expected Output

FROM ghcr.io/jqlang/jq@sha256:12f998e5a6f3f6916f744ba6f01549f156f624b42f7564e67ec6dd4733973146 AS fetch-jq

Actual Output

$ dprint check Dockerfile
Error formatting /home/mogyuchi/prj/fixup-twitter-link/Dockerfile. Message: could not parse Dockerfile:  --> 1:23
  |
1 | FROM ghcr.io/jqlang/jq@sha256:12f998e5a6f3f6916f744ba6f01549f156f624b42f7564e67ec6dd4733973146 as fetch-jq␊
  |                       ^---
  |
  = expected EOI
Had 1 error(s) formatting.

RuntimeError occurs when processing empty comment line

Describe the bug

dprint-plugin-dockerfile version: 0.2.2

Input Code

#

Expected Output

#

Actual Output

The following error message is output:

Critical error formatting /path/to/Dockerfile. Cannot continue. Message: Originally panicked in dprint-plugin-dockerfile, then failed reinitialize. This may be a bug in the plugin, the dprint cli is out of date, or the plugin is out of date.
Original error: RuntimeError: unreachable
Reinitialize error: RuntimeError: unreachable
Had 1 error(s) formatting.

Doesn't work with `Dockerfile.*`

When there's a need to have multiple Dockerfiles in a single directory, it's relatively common to name them Dockerfile.*, e.g. Dockerfile.dev, Dockerfile.prod.

I've tried configuring dprint to match such files, but it doesn't seem to work:

{
  "dockerfile": {},
  "includes": [
    "**/Dockerfile",
    "**/Dockerfile.*"
  ],
  "excludes": [],
  "plugins": [
    "https://plugins.dprint.dev/dockerfile-0.3.0.wasm"
  ]
}

If I have Dockerfile and Dockerfile.prod at the root of my project, running dprint output-file-paths finds Dockerfile but not Dockerfile.prod. It doesn't even work if I explicitly add **/Dockerfile.prod to includes.

If I add **/*.Dockerfile to includes and mv Dockerfile.prod prod.Dockerfile, it does find the file, but this isn't our preferred naming convention.

dprint-plugin-dockerfile version: 0.3.0

[Feature Request] Remove extra spaces/Add missing spaces

These line:

RUN rm     -rf /usr/share/nginx/html/*
ENTRYPOINT ["nginx",     "-g" ,"daemon off;" ]

Would be formatted to this:

RUN rm -rf /usr/share/nginx/html/*
ENTRYPOINT ["nginx", "-g", "daemon off;"]

Returns `UnexpectedEOF` if the dockerfile uses JSON array syntax for the `COPY` command

Describe the bug

dprint-plugin-dockerfile version: 0.3.0
dprint version: 0.37.1

Input Code

FROM ubuntu:jammy-20230605

COPY  ["a.txt", "./"]

Expected Output

FROM ubuntu:jammy-20230605

COPY ["a.txt", "./"]

Actual Output

> dprint check
Error formatting /home/kachick/repos/dprint-plugin-dockerfile-copy-syntax-array/Dockerfile. Message: error unescaping string: UnexpectedEOF
Had 1 error(s) formatting.

Duplicate double quotes when quoting commands with double quotes in `RUN`

I noticed this issue because when I use variables in the path of a command, I sometimes enclose the command in double quotes.

Describe the bug

dprint-plugin-dockerfile version: 0.2.3

Input Code

FROM ubuntu:22.04

RUN "ls"

RUN "ls" -l

Expected Output

FROM ubuntu:22.04

RUN "ls"

RUN "ls" -l

Actual Output

dprint check:

from /path/to/Dockerfile:
1 1| FROM·ubuntu:22.04
2 2|
  3|-RUN·"ls"
3  |+RUN·""ls""
4 4|
  5|-RUN·"ls"·-l
5  |+RUN·""ls"·-l"
--
Found 1 not formatted file.

dprint fmt:

Error formatting /path/to/Dockerfile. Message: Formatting not stable. Bailed after 5 tries. This indicates a bug in the plugin where it formats the file differently each time.
Had 1 error(s) formatting.

Add preferSingleLine configuration

For ENV and LABEL. This would prefer to keep these instructions on a single line when they're able.