Render Line Endings

Josip Medved

|
7,116 installs
| (2) | Free
Displays LF/CR/CRLF line ending symbol and optionally extra whitespace when 'Render whitespace' is turned on.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

Render Line Endings

This extension shows end-of-line characters (CR, LF, or CRLF) when whitespace rendering is turned on. Additionally, it can mark all non-default line endings in a different color. Furthermore, it can be also configured to show trailing whitespace characters as errors.

Since extension only renders visible portion of text, it is fast even for huge documents.

Fully supports language-specific EOL settings.

Features

If whitespace rendering is turned on, you will see symbol for either LF (↓), CRLF (↵), or CR (←).

Screenshot

Works well with editor.largeFileOptimizations: false regardless of document size.

Supports rendering only selection (editor.renderWhitespace: selection).

Screenshot

Supports highligthing of non-default EOL - even with language-specific settings (code-eol.highlightNonDefault: true).

Screenshot

Supports highlighting of training whitespace (code-eol.highlightExtraWhitespace: true).

Screenshot

Extension Settings

This extension contributes the following settings (compatible with code-eol extension):

  • code-eol.newlineCharacter: Character used to display LF (line-feed) line ending (aka Linux/Mac line ending).

  • code-eol.returnCharacter: Character used to display CR (carriage-return) line ending (aka old Macintosh line ending).

  • code-eol.code-eol.crlfCharacter: Character used to display CRLF (carriage-return, line-feed) line ending (aka Windows line ending).

  • code-eol.highlightNonDefault: If true, non-default line ending will be colored as error.

  • code-eol.highlightExtraWhitespace: If true, trailing whitespace will be colored as error. Note this is only shown if renderWhitespace is turned on.

Color is taken from editorWhitespace.foreground theme color (also used by Visual Studio Code to color whitespace symbols). color for non-default line ending is taken from errorForeground theme color.

Default line ending is determined based on files.eol setting.

Default Configuration

"code-eol.newlineCharacter": "↓",
"code-eol.returnCharacter" : "←",
"code-eol.crlfCharacter"   : "↵",

Atom Style Configuration

"code-eol.newlineCharacter": "¬",
"code-eol.returnCharacter" : "¤",
"code-eol.crlfCharacter"   : "¤¬",

Mark Non-Default Line Ending

"code-eol.highlightNonDefault": true,

Mark Extra Whitespace

"code-eol.highlightExtraWhitespace": true,

Known Issues

Mixed Line Endings Are Not Supported

Visual Studio Code normalizes line endings upon load and thus this extension will only show one kind of line ending character. Currently it is not possible to have multiple different line endings (see issue 127).

CR Line Ending Is Not Supported

Visual Studio does not support CR line ending (see issue 35797). Therefore, while you can configure it, you will never see CR as a line ending.

Not Rendering Glyphs For Large Files

For performance reasons Visual Studio Code doesn't synchronize files that are over 5MB in size (see issue 27100). Therefore, no line-ending characters will be visible on large files. To avoid this you can set editor.largeFileOptimizations to false.

Slow Update For Large Files

If there is an extension that parses the whole text (e.g. other line ending visualization extension), you might see delayed line ending character updates and temporary visual artefacts. This is due to serial nature of event processing within VS Code. The only workaround is to disable other line ending extension.