Trailing whitespace often exists after editing lines of code, deleting trailing words and so forth. This VSCode extension tracks lines that have changed during the editing session and removes trailing tabs and spaces from them they no longer have an active cursor.
The intent is to strike a balance between trimming lines vs churning diffs with unnecessary whitespace changes. By only trimming trailing whitespace from lines that have already been edited in some other way, this extension can help reduce the chance of some avoidable bugs getting released into production.
There are 3 key reasons to avoid unnecessary whitespace changes:
- They can create unnecessary merge conflicts. That represents work for someone, wastes time, and can feel annoying.
- Merge conflicts due to unnecessary whitespace changes can make it easy to overlook critical changes hidden within the sea of whitespace changes. It's easy to assume the entire conflict is just whitespace changes and make an arbitrary decision how to resolve it, especially when feeling annoyed about it. I've personally observed many instances where critical regressions were introduced by the combination of overly aggressive trimming of trailing whitespace and inattentive conflict resolution.
- Making unnecessary whitespace changes can create distracting diffs, interfere with per-line change annotations, and so on.
Just install the extension and it will automatically track edited lines and trim trailing whitespace.
A clickable status bar item toggles the trimming mode between enabled or paused on a per-file basis. It can be handy for those times when for whatever reason you need to preserve (or add!) trailing whitespace on edited lines.
There's a autotrim.pauseFile command in case you want to add a keybinding for toggling the trimming mode.
MarkDown files get a little bit of special treatment: lines ending in exactly two spaces are alone, since two spaces is the same as <br> in MarkDown.
autotrim.statusBar shows a status bar item that can be clicked to toggle pausing the trimming mode on a per-file basis.
autotrim.highlightTrailing shows highlighting for trailing whitespace.
autotrim.highlightTrailingEvenWhileEditing highlights trailing whitespace even for lines being editing (normally it's hidden while a line is being edited, since it'll get trimmed).
autotrim.backgroundColor sets the background color for the highlighting (CSS style string).
autotrim.borderColor sets the border color for the highlighting (CSS style string).
autotrim.borderWidth sets the border width for the highlighting (CSS style string).
autotrim.borderRadius sets the border radius for the highlighting (CSS style string).
autotrim.ignoreScheme is string containing a list of schemes for which trimming and highlighting are disabled, separated by spaces (by default the 'output' scheme is disabled to avoid interfering with the Output pane).
autotrim.ignoreSyntax is string containing a list of language Ids for which trimming and highlighting are disabled, separated by spaces.
autotrim.loglevel setting is for debugging purposes; you can ignore it.
- Due to how VSCode sends document change notifications, when inserting or deleting lines the line immediately adjacent to the edit may also get trimmed. It should be possible to detect and compensate in those cases, but the special cases have to be very accurately and precisely defined (and Undo might be extra challenging to make work exactly right).
This extension is forked from nathanridley.autotrim v1.0.6, which trimmed trailing whitespace from any line the cursor visited. The extension hadn't been updated in about 4 years, and I wanted to only trim trailing whitespace from lines changed by the user. Starting from the vscode-autotrim extension, I ended up mostly rewriting it, but the underlying data structures are still essentially the same.
This extension also includes some concepts and code lifted from shardulm94.trailing-spaces. That extension does live highlighting but trims only on save, and I prefer live trimming after finished editing a line, so the internal approach is significantly different.