Expected linebreaks to be 'LF' but found 'CRLF' linebreak-style

Question

When using eslint in the gulp project i have encountered a problem with error like this
Expected linebreaks to be 'LF' but found 'CRLF' linebreak-style and I am using Windows environment for the running gulp and the entire error log is given below

 Kiran (master *) Lesson 4 $ gulp
 Using gulpfile c:\Users\Sai\Desktop\web-build-tools\4\
 gulpfile.js
 Starting 'styles'...
 Finished 'styles' after 17 ms
 Starting 'lint'...
 'lint' errored after 1.14 s
 ESLintError in plugin 'gulp-eslint'
 sage: Expected linebreaks to be 'LF' but found 'CRLF'.
 ails: fileName: c:\Users\Sai\Desktop\web-build-tools\4\js\extra.js



$>Users\Sai\Desktop\web-build-tools\4\js\extra.js
error  Expected linebreaks to be 'LF' but found 'CRLF'  linebreak-style

I have also including extra.js file as the error indicating possible mistake.

function getWindowHeight() {
    return window.innerHeight;
}

getWindowHeight();

score 331 · Accepted Answer · edited Dec 16 '22 at 17:28

Check if you have the linebreak-style rule configure as below either in your .eslintrc or in source code:

/*eslint linebreak-style: ["error", "unix"]*/

Since you're working on Windows, you may want to use this rule instead:

/*eslint linebreak-style: ["error", "windows"]*/

Refer to the documentation of linebreak-style:

When developing with a lot of people all having different editors, VCS applications and operating systems it may occur that different line endings are written by either of the mentioned (might especially happen when using the windows and mac versions of SourceTree together).

The linebreaks (new lines) used in windows operating system are usually carriage returns (CR) followed by a line feed (LF) making it a carriage return line feed (CRLF) whereas Linux and Unix use a simple line feed (LF). The corresponding control sequences are "\n" (for LF) and "\r\n" for (CRLF).

This is a rule that is automatically fixable. The --fix option on the command line automatically fixes problems reported by this rule.

But if you wish to retain CRLF line-endings in your code (as you're working on Windows) do not use the fix option.

This is more of a hack. The other answer by @The Coder is correct. You need to change the config of the project — user959690, Jul 06 '20 at 21:58
I am not sure if this solution works for multi platform developers where some developers work in Unix and some on Windows. I think this should be best handled by the version control not the IDE or Lint is a moot point. Answer by @vnxyz worked and should be accepted IMO. — MG Developer, Dec 18 '20 at 19:19

The Coder · Answer 2 · 2017-10-13T01:10:02.333

273

I found it useful (where I wanted to ignore line feeds and not change any files) to ignore them in the .eslintrc using linebreak-style as per this answer: https://stackoverflow.com/a/43008668/1129108

module.exports = {
  extends: 'google',
  quotes: [2, 'single'],
  globals: {
    SwaggerEditor: false
  },
  env: {
    browser: true
  },
  rules:{
    "linebreak-style": 0
  }
};

edited Oct 13 '17 at 01:10

answered Jun 20 '17 at 20:55

The Coder

4,981
2
29
36

3

Actually the second highest (and not selected) answer, in my case I was working in a repository where the primary people working on it were on Macs and I was code reviewing on a PC, didn't really want to change anything for that reason. – The Coder Sep 02 '20 at 05:34

score 164 · Answer 3 · edited Aug 19 '19 at 09:46

164

If you are using vscode and you are on Windows i would recommend you to click the option at the bottom-right of the window and set it to LF from CRLF. Because we should not turn off the configuration just for sake of removing errors on Windows

If you don't see LF / CLRF, then right click the status bar and select Editor End of Line.

edited Aug 19 '19 at 09:46

Geoff

583
2
7
25

answered Sep 20 '18 at 05:14

Mr_Perfect

8,254
11
35
62

10

How to set this configuration to global in one project? i have to do this for every file – Progs Jan 02 '19 at 16:21
13

The global setting in VSCode seems to be: `Settings -> Text Editor -> Files -> Eol`, set to `\n`. This appears to only apply to new files though, you'll still have to switch each existing file over manually. – V. Rubinetti May 24 '19 at 17:52

score 53 · Answer 4 · answered Dec 31 '20 at 09:33

53

Here is a really good way to manage this error. You can put the below line in .eslintrc.js file.

Based on the operating system, it will take appropriate line endings.

rules: {
        'linebreak-style': ['error', process.platform === 'win32' ? 'windows' : 'unix'],
 }

answered Dec 31 '20 at 09:33

H_H

1,460
2
15
30

This is a clever way to manage this error with team members on both Mac and Windows machines. Is there a downside that I don't see? – Scott May 18 '21 at 13:53
3

@Scott Thanks! I do not see any downside. – H_H May 19 '21 at 12:54
trying to understand why this could be less error prone of : `'linebreak-style': ['error', 'windows'], ` – Carmine Tambascia Feb 07 '22 at 18:41
@CarmineTambascia when team members work on the same repo with different machine OS(windows, Linux and Mac) then it will take appropriate line ending -https://eslint.org/docs/rules/linebreak-style#options – H_H Feb 08 '22 at 07:55
I undertood that but anyway this won't work with any CPU of 64 byte, and I don't see what add to the exception of add only "windows" and include all of them – Carmine Tambascia Feb 08 '22 at 10:29
@CarmineTambascia For any windows system, process.platform will always return win32. so, There is no issues. – H_H Feb 08 '22 at 14:13
1

Thank you. This answer worked perfectly for me. I'm in the situation where we have many devs working in Mac and Windows, and we use a .gitattributes file to have the line endings automatically converted for the native OS. – ososnilknarf Oct 12 '22 at 23:19

score 32 · Answer 5 · answered Oct 19 '19 at 03:45

32

If you want it in crlf (Windows Eol), go to File -> Preferences -> Settings. Type "end of line" in the User tab and make sure Files: Eol is set to \r\n and if you're using the Prettier extension, make sure Prettier: End of Line is set to crlf. Finally, on your eslintrc file, add this rule: 'linebreak-style': ['error', 'windows']

answered Oct 19 '19 at 03:45

Wes

1,847
1
16
30

5

Voted up for the useful photos, 10x – benshabatnoam Apr 20 '20 at 13:47
"go to File -> Preferences -> Settings" What app should this be done in? – JeffreyPia Apr 24 '20 at 21:32
Prettier setting was my issue. Thanks CLUTCHER – Christopher Marshall Aug 18 '21 at 19:40
Please note, what is an editor is in a first screenshot. – Nashev Sep 07 '21 at 14:36

score 22 · Answer 6 · answered Apr 03 '21 at 17:05

22

add to our rule in the .eslintrc file 'linebreak-style':0 in Vue js

  rules: {
    'linebreak-style':0,
  }

answered Apr 03 '21 at 17:05

Francisco Estrada

389
3
2

score 17 · Answer 7 · answered Apr 27 '21 at 20:12

17

git config core.autocrlf false

git rm --cached -r .

git reset --hard

answered Apr 27 '21 at 20:12

Hakan Yıldırım

307
2
3

4

Consider adding an explanation as to how these git commands address the problem described in the question? – JohnH Apr 27 '21 at 21:12
1

This is the one that worked for me but I have no idea what's happening – user4815162342 Mar 07 '22 at 14:31
2

@user4815162342 I'm pretty sure when you git clone it messes up with auto converting the linebreaks, and basically this turns it off – OneTuskedMario Aug 15 '22 at 11:07

vnxyz · Answer 8 · 2019-02-21T09:54:53.430

16

Just made autocrlf param in .gitconfig file false and recloned the code. It worked!

[core] autocrlf = false

edited Feb 21 '19 at 09:54

answered Feb 14 '19 at 07:28

vnxyz

386
3
10

Your fix worked for me, editing eslintrc to add linebreak-style did not work. – MG Developer Dec 18 '20 at 19:16
That may cause more issues than it solves since the autocrlf is very helpful when mixing Windows and Unix as Windows tools will add crlf and unix tools lf. – user959690 Feb 17 '21 at 23:59
For those looking for the file. On unix: `nano ~/.gitconfig` – janisch Apr 28 '22 at 09:38
1

@janisch This will change the setting on the user-level, meaning it will be applied to all projects! Most likely you'd only want to change it for a specific project, in which case you'd edit `.git/config` in the repo directory instead. – Daniel Saner Feb 08 '23 at 13:42
`autocrlf = false` didn't work for me, by the way. I manually converted all line breaks to LF, but Git would immediately convert them back to CRLF in every modified file as soon as I tried to commit. The correct setting for me to be able to keep LF was `autocrlf = input` (and no re-checkout is necessary). – Daniel Saner Feb 08 '23 at 13:50

score 15 · Answer 9 · answered Jul 09 '20 at 09:58

15

The same situation occurred when I was using VSCode with eslint. If you use VSCode,

1 - Click area that name can be both LF or CRLF where at the bottom right of the VScode.

2 - Select LF from the drop-down menu.

That's worked for me.

answered Jul 09 '20 at 09:58

Serhan C.

1,152
1
12
10

score 13 · Answer 10 · answered Nov 14 '18 at 11:17

Happen with me because I ran git config core.autocrlf true and I forgot to rever back.

After that, when I checkout/pull new code, all LF (break line in Unix) was replaced by CRLF (Break line in Windows).

I ran linter, and all error messages are Expected linebreaks to be 'LF' but found 'CRLF'

To fix the issue, I checked autocrlf value by running git config --list | grep autocrlf and I got:

core.autocrlf=true
core.autocrlf=false

I edited the global GIT config ~/.gitconfig and replaced autocrlf = true by autocrlf = false.

After that, I went to my project and do the following (assuming the code in src/ folder):

CURRENT_BRANCH=$(git branch | grep \* | cut -d ' ' -f2);
rm -rf src/*
git checkout $CURRENT_BRANCH src/

score 11 · Answer 11 · answered May 04 '19 at 07:15

11

If you are using vscode I would recommend you to click the option at the bottom-right of the window and set it to LF from CRLF..this fixed my errors

answered May 04 '19 at 07:15

Athif Shaffy

692
3
10
22

where exactly is this? – KansaiRobot May 13 '19 at 05:26

score 5 · Answer 12 · answered Nov 18 '22 at 15:53

5

In case you want to change to LF and you are using VS Code you can do it per file like so:

answered Nov 18 '22 at 15:53

Leopold Kristjansson

2,246
28
47

score 3 · Answer 13 · answered Jun 11 '19 at 12:41

3

If you are using WebStorm and you are on Windows i would recommend you to click settings/editor/code style/general tab and select "windows(\r\n) from the dropdown menu.These steps will also apply for Rider.

answered Jun 11 '19 at 12:41

binary_fm

161
1
6

crazwade · Answer 14 · 2023-03-24T03:53:26.567

3

I set linebreak-style to 0, but not working.

rules: {
    "linebreak-style": 0,
 },

so then I found out need to change every files from "CRLF" to "LF", and that take lots time.

When cloning a project, Git automatically converts LF to CRLF which causes the error.

git config --global core.autocrlf false

To avoid this automatic conversion, run “git config --global core.autocrlf false” in Git Bash before cloning the project.

edited Mar 24 '23 at 03:53

answered May 31 '22 at 01:43

crazwade

51
1
5

When cloning a project, Git automatically converts LF to CRLF which causes the error. Run "git config core.autocrlf false" in Git Bash before cloning the project will help. – crazwade Mar 24 '23 at 03:50

score 2 · Answer 15 · answered Jan 05 '22 at 14:05

2

In my case (vue.js project, created using vue-cli) the lint problem Expected linebreaks to be 'LF' but found 'CRLF' linebreak-style was related to Prettier. From version >= 2 Prettier replace all line endings with "lf": https://prettier.io/docs/en/options.html#end-of-line

Since I'm using Windows to develop I set these 3 (git, eslint, prettier) configuration to avoid line endings problems:

Git: I set git config --global core.autocrlf true
eslint: in .eslintrc.js file I configured:

      module.exports = {
      rules: {
        'linebreak-style': ['error', 'windows'],
      },
    };

prettier: And finally in prettier.config.js:

module.exports = {
    endOfLine: "crlf",
};

answered Jan 05 '22 at 14:05

matteogll

803
8
16

I believe the issue has to do more about use codebase that is been "saved" with LF rules and then indeed work on Windows that use 'CRLF'. The question is, are the above setting guarantee that once the code is pushed, is back to LF formatting? – Carmine Tambascia Feb 07 '22 at 12:44
What I meant with my previous comment is that as from another answer, in VSC is possible to toggle between LF and crlf but then that is seen as a change by git, but in reality there isn't been any or any in term of a real commit. – Carmine Tambascia Feb 07 '22 at 17:53
I have read further https://eslint.org/docs/rules/linebreak-style and this eslint exception rule is the most simple and working to avoid this error pop up in vsc in windows. Alternative is provide the .gitattributes file – Carmine Tambascia Feb 09 '22 at 07:05

score 2 · Answer 16 · answered Jul 11 '22 at 04:14

The "endOfLine": "auto" setting in .eslintrc.js and .prettierrc files worked for me.

File .eslintrc.js should have:

rules: {
    /*  ...the other code is omitted for the brevity */
    'arrow-body-style': [1, 'as-needed'],
    'import/extensions': 'off',
    'prettier/prettier': [
        'error',
        {
            semi: false,
            singleQuote: true,
            useTabs: true,
            endOfLine: 'auto', /* this setting should be included */
        },
    ],

File .prettierrc should have:

{
    "semi": false,
    "trailingComma": "all",
    "singleQuote": true,
    "useTabs": true,
    "tabWidth": 2,
    "endOfLine": "auto" /* this setting should be included */
}

score 1 · Answer 17 · answered Feb 25 '22 at 15:25

Tips: Make sure you have installed Git as the picture if not do that first. You can take other features as default, You can choose visual studio code as the default editor. helps you a lot later.

Windows Users: Uninstall Visual Studio Code then reinstalled it again and EditorConfig should work just fine.

NOTE => Uninstalling Visual Studio Code still leaves the old settings and extensions! remove Visual Studio Code on Windows completely

Uninstalled Visual Studio

This PC > Local disck (C) Users > CurrentUser > AppData > Local > Programs > Microsoft VS Code
1. Unins000.exe or Uninstall it from conrol panel
This PC > Local disck (C) Users > CurrentUser > AppData > Local > Roaming
1. Code => Folder should be delete it
This PC > Local disck (C) Users > CurrentUser >
1. .vscode => Folder should be delete it
reinstall vs code it should work now.

score 1 · Answer 18 · answered Mar 20 '22 at 19:33

1

I just want to add the easier way. On the bottom right of VScode click the LF or CRLF to toggle between them. See Photo

answered Mar 20 '22 at 19:33

user2098296

21
1

score 1 · Answer 19 · answered Jul 23 '22 at 12:35

1

for me, I fixed the issue by setting "endOfLine": "lf" in the.prettierrc file.

answered Jul 23 '22 at 12:35

AYOMIDE ADEBAYO

81
1
4

1

Your answer could be improved with additional supporting information. Please [edit] to add further details, such as citations or documentation, so that others can confirm that your answer is correct. You can find more information on how to write good answers [in the help center](/help/how-to-answer). – Community Jul 25 '22 at 11:57

score 0 · Answer 20 · answered Apr 23 '21 at 09:40

0

Try using the linter's --fix flag to resolve the issue.

eslint filePath --fix

answered Apr 23 '21 at 09:40

user8818954

1

score 0 · Answer 21 · answered Jan 10 '23 at 16:54

In my case, the LF rule was set in a file read by the maven-checkstyle-plugin in pom.xml. The ${skipCheckstyle} environment variable was not set. This way I skipped the whole check.

<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<configuration>
    <skip>${skipCheckstyle}</skip>
    <configLocation>${top.dir}/src/main/config/checkstyle/checker.xml</configLocation>

score -1 · Answer 22 · answered Apr 18 '23 at 08:51

-1

run: $ git config --global core.autocrlf false

delete repo and clone again

answered Apr 18 '23 at 08:51

ofir_aghai

3,017
1
37
43

Expected linebreaks to be 'LF' but found 'CRLF' linebreak-style

22 Answers22

Uninstalled Visual Studio

Linked