版本

unicode-bom

要求或禁止 Unicode 字节顺序标记 (BOM)

🔧 可修复

此规则报告的一些问题可以通过 --fix 命令行 选项自动修复。

Unicode 字节顺序标记 (BOM) 用于指定代码单元是大端还是小端。也就是说,最高有效字节还是最低有效字节先出现。UTF-8 不需要 BOM,因为当字符是单个字节时,字节顺序无关紧要。由于 UTF-8 是 Web 上的主要编码,因此我们将 "never" 设为默认选项。

规则详情

如果使用 "always" 选项,则此规则要求文件始终以 Unicode BOM 字符 U+FEFF 开头。如果使用 "never",则文件绝不能以 U+FEFF 开头。

选项

此规则有一个字符串选项

  • "always" 文件必须以 Unicode BOM 开头
  • "never"(默认)文件绝不能以 Unicode BOM 开头

always

此规则使用 "always" 选项的正确代码示例

在代码游乐场中打开
// U+FEFF at the beginning

/*eslint unicode-bom: ["error", "always"]*/

var abc;

此规则使用 "always" 选项的错误代码示例

在代码游乐场中打开
/*eslint unicode-bom: ["error", "always"]*/

var abc;

never

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

在代码游乐场中打开
/*eslint unicode-bom: ["error", "never"]*/

var abc;

此规则使用 "never" 选项的错误代码示例

在代码游乐场中打开
// U+FEFF at the beginning

/*eslint unicode-bom: ["error", "never"]*/

var abc;

何时不使用它

如果您使用一些 UTF-16 或 UTF-32 文件,并且您希望允许文件可选地以 Unicode BOM 开头,则应关闭此规则。

版本

此规则在 ESLint v2.11.0 中引入。

资源

更改语言