Eslint linebreak style error windows

Enforce consistent 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).

Many versioning systems (like git and subversion) can automatically ensure the correct ending. However to cover all contingencies, you can activate this rule.

Rule Details

This rule enforces consistent line endings independent of operating system, VCS, or editor used across your codebase.

Options

This rule has a string option:

• "unix" (default) enforces the usage of Unix line endings: \n for LF.
• "windows" enforces the usage of Windows line endings: \r\n for CRLF.

unix

Examples of incorrect code for this rule with the default "unix" option:

Examples of correct code for this rule with the default "unix" option:

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

var a = 'a', // \n
    b = 'b'; // \n
// \n
function foo(params) { // \n
    // do stuff \n
}// \n

windows

Examples of incorrect code for this rule with the "windows" option:

Examples of correct code for this rule with the "windows" option:

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

var a = 'a', // \r\n
    b = 'b'; // \r\n
// \r\n
function foo(params) { // \r\n
    // do stuff \r\n
} // \r\n

Using this rule with version control systems

Version control systems sometimes have special behavior for linebreaks. To make it easy for developers to contribute to your codebase from different platforms, you may want to configure your VCS to handle linebreaks appropriately.

For example, the default behavior of git on Windows systems is to convert LF linebreaks to CRLF when checking out files, but to store the linebreaks as LF when committing a change. This will cause the linebreak-style rule to report errors if configured with the "unix" setting, because the files that ESLint sees will have CRLF linebreaks. If you use git, you may want to add a line to your .gitattributes file to prevent git from converting linebreaks in .js files:

*.js text eol=lf

When Not To Use It

If you aren’t concerned about having different line endings within your code, then you can safely turn this rule off.

Compatibility

• JSCS: validateLineBreaks

Version

This rule was introduced in ESLint v0.21.0.

Resources

• Rule source
• Tests source

Правило ESLint linebreak-style обеспечивает единообразный стиль разрыва строки. Это может быть полезно для команд, которые хотят гарантировать, что весь их код отформатирован единообразным образом, независимо от операционной системы, в которой он разрабатывается.

У правила есть два варианта:

• unix (default): принудительное использование окончаний строк Unix: \n для LF.

• windows : принудительное использование окончаний строк Windows: \r\n для CRLF.

Чтобы настроить правило, вы можете добавить в файл .eslintrc.js следующее:

{
  "rules": {
    "linebreak-style": ["error", "unix"]
  }
}

Это приведет к тому, что ESLint сообщит об ошибке, если обнаружит окончания строк, не соответствующие указанному стилю.

Вы также можете полностью отключить правило, установив для него значение false . Например:

{
  "rules": {
    "linebreak-style": "off"
  }
}

Почему так важно иметь единый стиль переноса строк?

Есть несколько причин, по которым важно иметь последовательный стиль разрыва строки:

• Это делает код более читабельным. Когда все строки в базе кода отформатированы одинаково, разработчикам легче читать и понимать код.
• Это снижает риск ошибок. Когда разработчики используют разные стили разрыва строк, это может привести к таким ошибкам, как проблемы различий и конфликты слияний.
• Это улучшает согласованность кодовой базы. Последовательный стиль разрыва строк делает кодовую базу более отточенной и профессиональной.

Как исправить ошибки стиля разрыва строки в ESLint

Если ESLint сообщает об ошибке стиля разрыва строки, ее можно исправить, изменив окончание строки в соответствии с указанным стилем. Вы можете сделать это с помощью текстового редактора или инструмента command-line, такого как sed или awk .

Например, если вы используете стиль разрыва строки Unix и ESLint сообщает об ошибке в следующей строке:

function myFunction() {
  // Эта строка имеет окончание строки Windows.
  console.log("Hello, world!");
}

Вы можете исправить ошибку, изменив строку, заканчивающуюся на \n , с помощью текстового редактора или инструмента command-line. Например, чтобы использовать sed для изменения окончания строки, вы должны выполнить следующую команду:

sed -i 's/\r//' myFunction.js

Это заменит все окончания строк CRLF в файле myFunction.js на окончания строк LF.

После устранения ошибки стиля разрыва строки вы можете снова запустить ESLint, чтобы убедиться, что ошибка устранена.

Чтобы отключить правило linebreak-style ESLint, вы можете отредактировать файл .eslintrc .

Если вы используете конфигурацию JavaScript ESLint, вы можете добавить в файл .eslintrc.js следующее:

module.exports = {
  rules: {
    'linebreak-style': 'off',
  },
};

Если вы используете конфигурацию JSON ESLint, вы можете добавить в файл .eslintrc или .eslintrc.json следующее:

{
  "rules": {
    "linebreak-style": "off"
  }
}

После внесения этих изменений сохраните файл .eslintrc и перезапустите редактор кода или сервер разработки.

Note

Отключать правило linebreak-style ESLint не рекомендуется, так как это может привести к несогласованным окончаниям строк в вашей кодовой базе. Это может затруднить сотрудничество с другими разработчиками, а также привести к ошибкам в некотором программном обеспечении.

Если у вас возникли проблемы с правилом linebreak-style ESLint, лучше попытаться устранить основную проблему, например настроить систему контроля версий на использование правильных окончаний строк.