trim_trailing_whitespace = false not working

Question

trim_trailing_whitespace = false not working

jibbers42 opened this issue 7 years ago · 40 comments

jibbers42 commented 7 years ago

I have a question that is specific to this extension; thus, inappropriate for the main EditorConfig issue tracker.
I tried running code --disable-extensions and the issue did NOT present itself.

Delete the following condition if it doesn't apply to your case:

If the extension is not picking up the expected configuration for a file:

I tried npm install editorconfig -g and ran editorconfig [file-in-question] and the configuration was what I expected. If not, please file on the editorconfig-core-js issue tracker.

Issue

	Visual Studio Code	editorconfig-vscode
Version	`1.12.2`	`0.9.3`

Root `.editorconfig` File

# Editor configuration, see http://editorconfig.org
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
max_line_length = off
trim_trailing_whitespace = false

Are there any other relevant .editorconfig files in your project? No

Visual Studio Code Setting	Default	User	Workspace
`editor.insertSpaces`	`true`	`____`	`____`
`editor.tabSize`	`4`	`2`	`_`
`editor.trimAutoWhitespace`	`true`	`____`	`____`
`files.autoSave`	`"off"`	`"___"`	`"___"`
`files.insertFinalNewline`	`false`	`true`	`_____`
`files.trimTrailingWhitespace`	`false`	`true`	`_____`

File opened

./README.md

Expected behavior

trim_trailing_whitespace = false

Actual behavior

trim_trailing_whitespace = true

Additional comments or steps to reproduce

When I add 2 spaces to the end of a line to create a markdown line break and then save the file, the trailing spaces are removed.
OS: Ubuntu 17.04

Answer 1 · 2017-06-01T11:45:00.000Z

Same here, OS: macOS Sierra

Answer 2 · 2017-06-01T18:03:56.000Z

same here, on both Win10 & Win7, latest VSCode (not Insiders) & latest EditorConfig plugin

Answer 3 · 2017-07-14T19:17:02.000Z

Found the workaround of removing `"files.trimTrailingWhitespace" from user/workspace settings. This way the extension seem to work properly.

Answer 4 · 2017-07-14T21:18:32.000Z

i like my editor to trim whitespace.
the only problem i have is with markdown files, where whitespace at the end is used for a newline.
to workaround the problem i added this in vscode settings.json

    "files.trimTrailingWhitespace": true,
    "[markdown]": {
        "files.trimTrailingWhitespace": false
    }

Answer 5 · 2017-11-18T10:53:48.000Z

files.trimTrailingWhitespace could do with a debounce setting to allow a bit of thinking time when typing. Often I find the trailing whitespace is trimmed before I finish typing a line.

Answer 6 · 2017-11-27T22:06:23.000Z

^^^ +1 this. It is so effing annoying

Answer 7 · 2018-02-04T12:42:29.000Z

I guess that to truly fix this someone will have to request an option to override files.trimTrailingWhitespace per TextEditor. Something like adding it as a new property to TextEditorOptions.

A pluasible fix for this, without changing VS Code, can be for this extension to offer its own trim trailing whitespace setting, that will apply when the value in editorconfig is unset and request from the user to unset or offer to automatically unset the VS Code setting for the user.

P.S. Wouldn't the same happen with insert_final_newline and files.insertFinalNewline and files.trimFinalNewlines?

Answer 8 · 2018-03-13T14:47:13.000Z

@S2- Your proposed solution does not work in the latest VSCode. (1.21.0)

So this plugin doesn't set the setting correctly then. Any idea on when this will be fixed?

Answer 9 · 2018-03-13T16:01:14.000Z

@dietergeerts still works for me on Version 1.21.0
Commit 9a199d77c82fcb82f39c68bb33c614af01c111ba
Date 2018-03-07T11:04:09.969Z
Shell 1.7.9
Renderer 58.0.3029.110
Node 7.9.0
Architecture x64

Answer 10 · 2018-03-13T16:50:48.000Z

@pjsvis that's a great idea. You should submit that to vscode issues.

@S2- your solution sounds like a good fix for this, considering the user settings overrides the EditorConfig setting.

Everyone else, I think a good fix here would be to add the following to your workspace settings to undo the user setting:

    "files.trimTrailingWhitespace": false,

You're basically telling the editor, "Don't worry about trimming trailing whitespace on this project, because I have an EditorConfig configuration that takes care of that."

For all other projects w/o an EditorConfig configuration, your user setting will still apply!

What do you think?

Answer 11 · 2018-03-19T10:25:23.000Z

@S2- nope, it's not:

editorconfig plugin enabled
editorconfig file:

root = true

[*]
charset = utf-8
indent_style = space
indent_size = 4
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[{*.html,*.hbs,*.json,*.yml}]
indent_size = 2

[{*.md}]
trim_trailing_whitespace = false

workspace settings:

{
    "html.format.wrapAttributes": "force-aligned",
}

user settings:

{

}

VSCode removes trailing whitespaces from .md files

Even with these workspace settings:

{
    "files.trimTrailingWhitespace": false,
    "html.format.wrapAttributes": "force-aligned",
}

And with these workspace settings:

{
  "files.trimTrailingWhitespace": true,
    "[markdown]": {
        "files.trimTrailingWhitespace": false
    },
  "html.format.wrapAttributes": "force-aligned",
}

THE only solution right now is to not use this editorconfig plugin and add all the settings from it to the workspace settings:

{
  // Settings to mimic `.editorconfig` as the plugin has bugs on trim trailing whitespace, 
  // see https://github.com/editorconfig/editorconfig-vscode/issues/153
  "files.encoding": "utf8",
  "editor.insertSpaces": true,
  "editor.tabSize": 4,
  "editor.detectIndentation": false,
  "files.eol": "\n",
  "files.insertFinalNewline": true,
  "files.trimTrailingWhitespace": true,
  "[javascript]": {
    "editor.tabSize": 2,    
  },
  "[handlebars]": {
    "editor.tabSize": 2,    
  },
  "[json]": {
    "editor.tabSize": 2,    
  },
  "[yaml]": {
    "editor.tabSize": 2,    
  },
  "[markdown]": {
    "editor.tabSize": 2,
    "files.trimTrailingWhitespace": false
  },

  // Other project settings
  "html.format.wrapAttributes": "force-aligned",
}

Answer 12 · 2018-03-19T19:18:47.000Z

@dietergeerts try:

[*.md]
trim_trailing_whitespace = false

Answer 13 · 2018-06-07T06:29:42.000Z

@jedmao , why should that matter? [{*.md}] and [*.md] should be the same.

Answer 14 · 2018-06-07T16:15:56.000Z

I 100% agree, but the tests don't cover this scenario, so it's not exactly a supported feature. The {} braces are for multiple matches, so there's really no reason to use them unless you're trying to target multiple files or extensions like:

[{*.md,*.yml}]

☝️ that works. You know what also works?

[{*.md,}]

So you can either add this scenario to the tests or just use [{*.md,}] or [*.md] for now. Up to you!

Answer 15 · 2018-11-11T18:02:45.000Z

If the code was programmed correctly, it should not matter if the singular or plural version was used, as that's a feature of editorconfig….

Answer 16 · 2018-11-11T19:16:12.000Z

This is not an issue with this extension, but with the core and the tests written against it.

Answer 17 · 2018-12-10T06:53:20.000Z

My similar case is:

Please fill-in this template.

I have a question that is specific to this extension; thus, inappropriate for the main EditorConfig issue tracker.
I tried running code --disable-extensions and the issue did NOT present itself.

Issue

	Visual Studio Code	editorconfig-vscode
Version	`1.29.1`	`0.12.5`

Root `.editorconfig` File

root = true

[*]
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
indent_style = space

[.editorconfig]
insert_final_newline = true

[*.ps1]
end_of_line = crlf
charset = utf-8-bom
indent_size = 4
insert_final_newline = true

[*.py]
indent_size = 4
insert_final_newline = true

[R*[ab]/file_install_key.txt]
insert_final_newline = false

[*.yml]
indent_size = 2
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false
insert_final_newline = true

Are there any other relevant .editorconfig files in your project? No

Visual Studio Code Setting	Default	User	Workspace
`editor.insertSpaces`	`true`	`true`	`____`
`editor.tabSize`	`4`	`4`	`_`
`editor.trimAutoWhitespace`	`true`	`true`	`____`
`files.autoSave`	`"off"`	`"off"`	`"___"`
`files.insertFinalNewline`	`false`	`true`	`_____`
`files.trimTrailingWhitespace`	`false`	`true`	`_____`

File opened

./README.md

Expected behavior

trim_trailing_whitespace = false

Actual behavior

trim_trailing_whitespace = true

Additional comments or steps to reproduce

Answer 18 · 2018-12-11T18:16:04.000Z

If the code was programmed correctly, it should not matter if the singular or plural version was used, as that's a feature of editorconfig….

@dietergeerts it's actually not a feature of EditorConfig. Show me the test that matches that scenario.

@tats-u this appears to be a weird vscode issue in their order of operations, if you will. They are allowing user settings to trump plugin settings. As such, I strongly suggest you short circuit that operation with an md-specific vscode rule until they change the order of operations (if that ever even happens).

{
    "files.trimTrailingWhitespace": true,
    "[markdown]": {
        "editor.wordWrap": "on",
        "editor.quickSuggestions": false,
        "files.trimTrailingWhitespace": false
    }
}

You should probably put ☝️ in your user settings anyway, for projects that don't have an .editorconfig file.

Answer 19 · 2018-12-11T20:03:46.000Z

@jedmao
In terms of files.trimTrailingWhiteSpace, I've already found and applied it.

Answer 20 · 2018-12-11T20:35:34.000Z

@tats-u do you need any more help then?

Answer 21 · 2018-12-12T00:45:45.000Z

@jedmao No, I'm just waiting for the fix of this issue.

Answer 22 · 2018-12-12T00:49:42.000Z

You might be waiting a couple years for vscode to fix it on their end. In the meantime, does my solution above solve your immediate needs?

Answer 23 · 2018-12-12T01:14:54.000Z

@jedmao Yes, I'm not bothered by this bug now.

Answer 24 · 2018-12-18T15:34:08.000Z

@jedmao , the docs state that you can have multiple file extensions, and that you can use the , …. A test not being there doesn't mean it's not supported..... (though every feature should be supported though)

Answer 25 · 2018-12-18T20:24:13.000Z

@dietergeerts I never said you can't use a ,. The issue is using the {} without also using a ,.

Answer 26 · 2018-12-19T09:18:52.000Z

@dietergeerts your issue has nothing to do with this extension, specifically. In fact, it's not even related to editorconfig-core-js. I'm not sure where you're getting the idea that this is a feature of EditorConfig. Please direct me to the documentation that states this feature or request a new EditorConfig feature here.

That said, I'm 100% positive that what you're asking for isn't covered by the core tests, so if that's an issue for you, feel free to file it here.

EditorConfig is an interesting project, because it's really just a specification for which many languages have a core implementation. Those different language implementations are verified all by a common suite of core tests. If the tests pass, the language-specific core is verified as an official core. Editor-specific plugins/extensions use these cores to power their features.

Specification -> Tests -> Core -> Plugin

Many times, issues are reported at the plugin level, when they should be reported at a higher level of the core, the tests or even the specification itself.

Does this clear things up?

Answer 27 · 2018-12-21T08:15:30.000Z

Do you really belive this issue is not due to this extension? If so, why don't you send an issue to VSCode itself? If you have already sent one, paste the URL of it.

Answer 28 · 2018-12-21T14:14:26.000Z

I also wonder why JetBrains can get it right then... It's not because it would not be like 'officially' supported that this plugin can't make that work. Plugins always should keep different scenarios in mind and make sure they work in a lot of scenarios, even the not so default ones...

Answer 29 · 2018-12-21T16:40:12.000Z

@dietergeerts JetBrains are a commercial enterprise and IntelliJ is a (paid) product, unlike these.

I think that's why VSCode doesn't allow extensions to overwrite configurations like files.trimAutoWhiteSpace to false.

Answer 30 · 2018-12-21T22:02:48.000Z

I don't believe vscode is doing this on purpose. There are three EditorConfig settings that execute on the workspace.onWillSaveTextDocument event.

SetEndOfLine()
TrimTrailingWhitespace()
InsertFinalNewline()

They do their respective jobs correctly, but it doesn't matter, because vscode then executes the built-in save operation, which takes into account the workspace and user settings. In this case, that means they trim trailing whitespace after EditorConfig is done not trimming the whitespace.

I don't think it matters if this is a pre-save operation or a post-save operation, because once that whitespace is gone, it's gone. EditorConfig isn't going to add it back. So the issue that remains is that we need a way to short-circuit the built-in save operation to defer to the EditorConfig settings instead of only consulting workspace / user settings.

This is another reason why EditorConfig being built-in to the editor (as it is in other editors) makes a lot of sense.

Unless there are some new APIs that allow us to do this, by all means, point me in the right direction. As for the last time I looked into this, there wasn't really a solution. I don't think it's a vscode bug per se, but it could be a good new feature request to ask for a way to short-circuit the built-in save operation somehow.

Answer 31 · 2018-12-25T09:43:46.000Z

Do you really belive this issue is not due to this extension? If so, why don't you send an issue to VSCode itself? If you have already sent one, paste the URL of it.

microsoft/vscode#65663

Answer 32 · 2018-12-25T09:59:54.000Z

@jedmao Thank you for your cooperation. Hmm, the API of Code is too limited...

Answer 33 · 2018-12-26T04:57:04.000Z

@tats-u to be fair, the vscode API is limited for good reasons. It would be a wild mess if extension authors could all be messing with built-in save operations. They have to be smart about how they expose APIs to these internals and I think they've done that for the most part. Our job is to make them aware of this particular issue and maybe, if the stars align, EditorConfig support can be baked into vscode. Wouldn't that be nice!

Answer 34 · 2019-06-27T15:50:13.000Z

some update? can be closed? some ultimate and definitive fix for this issue?

Answer 35 · 2019-10-10T07:30:14.000Z

@clystian there is nothing actionable on this issue until microsoft/vscode#65663 is addressed. Please follow that issue for now.

Answer 36 · 2021-02-24T10:45:54.000Z

For those landing here on this thread and suffering from the same issue on a daily basis: hereʼs my habit-changing workaround I survive with:

In VS Code / Codium open the Preview tab of the given markup file currently edited.
Once your trailing spaces are added, open/switch over to the Preview tab. Now the markdown gets saved but in a different way as Ctrl+S would do. For some strange reasons, this time trailing spaces remain.

Pro tip: if the markup file gets edited frequently (I use it for not down scratch notes), then pinning both the editor and preview tabs ensures that a quick Ctrl+1 and Ctrl+2 then Ctrl+1 again sequence saves the file as desired.

Answer 37 · 2021-08-04T13:13:12.000Z

After disabling and deselecting as many extensions & settings as concerned the issue of visual studio code removing my spaces, but with no positive results, I found out that the issue was with this one simple selection Auto Save deselecting that is what worked for me. (Files -> Auto Save)

Answer 38 · 2022-06-01T10:07:03.000Z

For me, just disable files.trimTrailingWhitespace in vscode settings, and then give control to .editorconfig.

now markdown doesn't trim trailing whitespace, but other files will

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

Answer 39 · 2024-02-15T05:55:09.000Z

This extension made my VSCode 100% useless because it was removing trailing white-spaces on save for html files regardless of any settings.
Pointless git diffs anywhere and no way to proceed.

Didn't even know the culprit till I saw https://stackoverflow.com/a/64422911/5195033.

Answer 40 · 2024-05-29T09:03:41.000Z

@Anutrix

This extension made my VSCode 100% useless because it was removing trailing white-spaces on save for html files regardless of any settings. Pointless git diffs anywhere and no way to proceed.

Didn't even know the culprit till I saw https://stackoverflow.com/a/64422911/5195033.

I would say that the actual problem is that your colleagues are leaving random whitespace everywhere. If you enforced the same settings for everyone (which is what the purpose of this extension is) the problem would resolve itself for good.

Issue

Root .editorconfig File

File opened

Expected behavior

Actual behavior

Additional comments or steps to reproduce

Issue

Root .editorconfig File

File opened

Expected behavior

Actual behavior

Additional comments or steps to reproduce

Root `.editorconfig` File

Root `.editorconfig` File