How to disable formatting for Dockerfile?

[zulhfreelancer]

Hi,

I've been using this extension for a while and I like it. But for Dockerfile, I prefer not to enable the auto formatting.

How to disable it?

Thanks.

[foxundermoon]

"shellformat.effectLanguages": [
            "shellscript",
-            "dockerfile",
            "dotenv",
            "hosts",
            "jvmoptions",
            "ignore",
            "gitignore",
            "properties",
            "spring-boot-properties",
            "azcli"
          ]

[Eisbrenner]

Hi,

I, too, liked to disable the formatting for Dockerfiles since it removes \ at the end of lines, which breaks the files.

However, since I had format-on-save enabled, I needed to add

"[dockerfile]": {
    "editor.formatOnSave": false,
},
"shellformat.effectLanguages": [
    "shellscript",
    // ... excluding dockerfile
]

having either of those excluded from the settings would result in auto formatting of Dockerfiles.

[foxundermoon]

@Eisbrenner Maybe it was formatted by another plugin. You can check out docker related plugins.

[joemaller]

@foxundermoon Dropped backslashes in Dockerfiles seems to be happening upstream in shfmt. My Dockerfiles weren't formatting (because of Prettier?) until I explicitly enabled shell-format in settings.json with this:

    "[dockerfile]": {
        "editor.defaultFormatter": "foxundermoon.shell-format"
    }

After that, my Dockerfiles formatted, but all multi-line commands broke. Output from this extension (obviously?) is identical to output from shfmt.

Input

RUN yum -y -q update \
        && yum install -q -y zip

output

RUN yum -y -q update &&
	yum install -q -y zip

[joemaller]

Followup: This should be a known issue and was already mentioned here in #29 which referenced mvdan/sh#424

[texastoland]

@foxundermoon Your extension shouldn't manually format files. formatOnSave happens automatically when you register as a formatter. Could you please remove the following lines:

vs-shell-format/src/extension.ts

Lines 43 to 51 in 9af1d95

	const formatOnSave = vscode.workspace.getConfiguration().get(formatOnSaveConfig);
	if (formatOnSave) {
	vscode.workspace.onWillSaveTextDocument((event: vscode.TextDocumentWillSaveEvent) => {
	// Only on explicit save
	if (event.reason === 1 && isAllowedTextDocument(event.document)) {
	vscode.commands.executeCommand(formatDocumentCommand);
	}
	});
	}

can you submit a pr?

[bernardolm]

"shellformat.effectLanguages": [
            "shellscript",
-            "dockerfile",
            "dotenv",
            "hosts",
            "jvmoptions",
            "ignore",
            "gitignore",
            "properties",
            "spring-boot-properties",
            "azcli"
          ]

Doesn't work for me. I also want to disable this weird Dockerfile formatter.

[JounQin]

binaryNextLine is auto enabled in prettier-plugin-sh, you can use it if you are using prettier.

[bduffany]

@foxundermoon It looks like the manual formatting behavior mentioned in #62 (comment) is still in the code in master?

vs-shell-format/src/extension.ts

Lines 43 to 51 in 95bf6a6

	const formatOnSave = vscode.workspace.getConfiguration().get(formatOnSaveConfig);
	if (formatOnSave) {
	vscode.workspace.onWillSaveTextDocument((event: vscode.TextDocumentWillSaveEvent) => {
	// Only on explicit save
	if (event.reason === 1 && isAllowedTextDocument(event.document)) {
	vscode.commands.executeCommand(formatDocumentCommand);
	}
	});
	}

If I understand @texastoland's comment correctly, this code is causing the extension to ignore the user's editor.formatOnSave preference for the dockerfile language mode, which should be enough to disable the formatter. Folks shouldn't also need to remove dockerfile from shellformat.effectLanguages.

[Re-st]

I happened to have same issue. After some struggles I evaded the problem by installing Docker extension and setting dockerfile default formatter to the one given there.

[rucoder]

I managed to fix it adding following to my settings.json

    "[dockerfile]": {
        "editor.defaultFormatter": "foxundermoon.shell-format"
    },
   "shellformat.flag": "-bn"

[JounQin]

I think the solution should be well documented. Or it should be enabled by default for Dockerfile even better.

[Pointotech]

This extension should not be attempting to format Dockefiles, since it clearly isn't able to do so correctly and it doesn't seem to be the goal of this extension.

There should not be extra configuration required to avoid breaking files which this extension doesn't support.