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" 选项时，错误代码示例

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

var a = 'a'; // \r\n

1
2
3
4

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

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

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

1
2
3
4
5
6
7
8
9

windows

使用 "windows" 选项时，错误代码示例

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

var a = 'a'; // \n

1
2
3
4

使用 "windows" 选项时，正确代码示例

/*eslint linebreak-style: ["error", "windows"]*/ // \r\n
// \r\n
var a = 'a', // \r\n
    b = 'b'; // \r\n
// \r\n
function foo(params) { // \r\n
    // do stuff \r\n
} // \r\n

1
2
3
4
5
6
7
8
9

将此规则与版本控制系统一起使用

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

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

*.js text eol=lf
1

何时不使用它

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

兼容性

• JSCS: validateLineBreaks

版本

此规则在 ESLint v0.21.0 中引入。

资源

• 规则来源
• 测试来源