Permalink
Fetching contributors…
Cannot retrieve contributors at this time
68 lines (55 sloc) 2.02 KB
/**
* @fileoverview Require or disallow Unicode BOM
* @author Andrew Johnston <https://github.com/ehjay>
*/
"use strict";
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
module.exports = {
meta: {
docs: {
description: "require or disallow Unicode byte order mark (BOM)",
category: "Stylistic Issues",
recommended: false,
url: "https://eslint.org/docs/rules/unicode-bom"
},
fixable: "whitespace",
schema: [
{
enum: ["always", "never"]
}
]
},
create(context) {
//--------------------------------------------------------------------------
// Public
//--------------------------------------------------------------------------
return {
Program: function checkUnicodeBOM(node) {
const sourceCode = context.getSourceCode(),
location = { column: 0, line: 1 },
requireBOM = context.options[0] || "never";
if (!sourceCode.hasBOM && (requireBOM === "always")) {
context.report({
node,
loc: location,
message: "Expected Unicode BOM (Byte Order Mark).",
fix(fixer) {
return fixer.insertTextBeforeRange([0, 1], "\uFEFF");
}
});
} else if (sourceCode.hasBOM && (requireBOM === "never")) {
context.report({
node,
loc: location,
message: "Unexpected Unicode BOM (Byte Order Mark).",
fix(fixer) {
return fixer.removeRange([-1, 0]);
}
});
}
}
};
}
};