ESLint 样式

外观

@stylistic/js/

linebreak-style ​

当与许多人一起开发时，每个人都使用不同的编辑器、VCS 应用程序和操作系统，可能会出现由上述任何一个写入不同的行尾（尤其是在一起使用 SourceTree 的 Windows 和 Mac 版本时）。

Windows 操作系统中使用的换行符（新行）通常是回车符 (CR) 后跟换行符 (LF)，使其成为回车换行符 (CRLF)，而 Linux 和 Unix 使用简单的换行符 (LF)。相应的控制序列是 "\n"（对于 LF）和 "\r\n"（对于 CRLF）。

许多版本控制系统（如 git 和 subversion）可以自动确保正确的结尾。但是，为了涵盖所有意外情况，您可以激活此规则。

规则详细信息 ​

此规则强制执行一致的行尾，独立于您的代码库中使用的操作系统、VCS 或编辑器。

选项 ​

此规则有一个字符串选项

  • "unix"（默认）强制使用 Unix 行尾：\n 用于 LF。
  • "windows" 强制使用 Windows 行尾：\r\n 用于 CRLF。

unix ​

使用默认 "unix" 选项时，此规则的不正确代码示例

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

var a = 'a'; // \r\n
不正确

使用默认 "unix" 选项时，此规则的正确代码示例

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

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

windows ​

使用 "windows" 选项时，此规则的错误代码示例

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



var a = 'a'; // \n
不正确

使用 "windows" 选项时，此规则的正确代码示例

js
/*eslint @stylistic/js/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
正确

在版本控制系统中使用此规则 ​

版本控制系统有时对换行符有特殊行为。为了方便开发人员从不同平台贡献代码，您可能需要配置您的 VCS 以适当处理换行符。

例如，git 在 Windows 系统上的默认行为是在检出文件时将 LF 换行符转换为 CRLF，但在提交更改时将换行符存储为 LF。如果将 linebreak-style 规则配置为 "unix" 设置，这将导致该规则报告错误，因为 ESLint 看到的文件将具有 CRLF 换行符。如果您使用 git，您可能需要在您的 .gitattributes 文件 中添加一行以防止 git 转换 .js 文件中的换行符

txt
*.js text eol=lf

何时不使用它 ​

如果您不关心代码中是否存在不同的行尾，那么您可以安全地关闭此规则。

兼容性 ​