LJH
LJH

Reputation: 8954

Visual Studio Code — Insert Newline at the End of Files

When saving a file using Visual Studio Code, a newline is not automatically added to the end of the file, causing all sorts of potential issues.

How can I append a newline automatically in Visual Studio Code?

Upvotes: 344

Views: 208115

Answers (7)

emmaakachukwu
emmaakachukwu

Reputation: 635

If you wish to apply this to just your current project, you can achieve that by creating your settings.json file in a .vscode directory in your project's root directory - PROJECT_ROOT/.vscode/settings.json

Paste in the following into the settings.json file

{
  "files.insertFinalNewline": true,
  "files.trimFinalNewlines": true
}

Henceforth, on save of a file in your project;

  • files.insertFinalNewline will add a trailing new line to the end of the file
  • files.trimFinalNewlines will trim off any extra newlines at the end of the file; making sure there's just one newline (assuming files.insertFinalNewline is set to true)

Upvotes: 5

Wojciech Bednarski
Wojciech Bednarski

Reputation: 6373

VS Code 1.76.2.

  1. CMD + Shift + P
  2. Type user settings JSON

Setting search

  1. In settings.json add
"files.insertFinalNewline": true,
"files.trimFinalNewlines": true

OR


  1. CMD + ,
  2. Type in the search settings newline

Setting search

  1. Check Insert Final Newline and Trim Final Newlines

Files settings

Upvotes: 21

Doesn't Matter
Doesn't Matter

Reputation: 21

every type of files has it's own settings so if you go to the settings you will find for example for blade: Blade: New Line then a check box to insert or not an empty line at the end of file

Upvotes: 0

Victor
Victor

Reputation: 1

I was experiencing the same issue and solved it by uninstalling a save while typing extension that I had installed.

Upvotes: -1

Telmo Dias
Telmo Dias

Reputation: 4178

While editing PHP files, something was deleting the newline at the end of the file. In my case it turned out to be the HTML format (html.format.endWithNewline), I believe because of the Emmet extension. (see attached images)

emmet settings html format "End with newline" setting

Upvotes: 3

Bruno Bronosky
Bruno Bronosky

Reputation: 70479

I have placed a screen capture below showing how to make Visual Studio Code insert a newline at the end of files. This will also serve as a useful place to link to in code reviews when saying "You need to do this and resubmit".

screen capture of settings change

Upvotes: 147

LJH
LJH

Reputation: 8954

There are two easy methods to make Visual Studio Code insert a new line at the end of files:

Method I

  1. Open Visual Studio Code and go to File (Code if using a Mac) -> Preferences -> Settings; you should now be viewing a settings page

  2. Enter 'insert final newline' in to the search bar

  3. Select the checkbox under the heading 'Files: Insert Final Newline' in the 'Workspace Settings' and/or 'User Settings' tab(s) as required

Settings Page with 'Files: Insert Final Newline' checkbox selected

Method II

  1. Open Visual Studio Code and go to File (Code if using a Mac) -> Preferences -> Settings; you should now be viewing a settings page

  2. Open the JSON settings page by clicking the {} icon at the top right of the page

  3. Enter 'files.insertFinalNewline' in to the search bar of the JSON settings page

  4. Either

    • Click on the white 'edit pen' on the left hand side of the line containing the files.insertFinalNewline JSON key and select True

    or

    • Copy the line containing the files.insertFinalNewline JSON key, paste it into the right hand side JSON file under the 'User Settings' and/or 'Workspace Settings' tab(s) as required, and set its value to true

User Settings JSON with <code>files.insertFinalNewline</code> set to <code>true</code>

Final Result

In either your User Settings or Workspace Settings JSON file, you should have a line reading "files.insertFinalNewline": true, within the provided curly braces ({ }). Additionally, in the Settings page, the checkbox under the heading 'Files: Insert Final Newline' will be selected.

Visual Studio Code will now add an empty line to the end of files when being saved, if there isn't already one.

Upvotes: 512

Related Questions