webhook/node_modules/eslint-plugin-eslint-comments/lib/rules/disable-enable-pair.js
Joel Male 1ada95e04a
v2.0.0 (#12)
- Convert project to Javascript/Typescript
- Allow custom headers to be passed in (optional)
- Allow body to be optional
2020-08-26 10:52:47 +10:00

69 lines
2.1 KiB
JavaScript

/**
* @author Toru Nagashima <https://github.com/mysticatea>
* See LICENSE file in root directory for full license.
*/
"use strict"
const DisabledArea = require("../internal/disabled-area")
const utils = require("../internal/utils")
module.exports = {
meta: {
docs: {
description:
"require a `eslint-enable` comment for every `eslint-disable` comment",
category: "Best Practices",
recommended: true,
url:
"https://mysticatea.github.io/eslint-plugin-eslint-comments/rules/disable-enable-pair.html",
},
fixable: null,
schema: [
{
type: "object",
properties: {
allowWholeFile: {
type: "boolean",
},
},
additionalProperties: false,
},
],
type: "suggestion",
},
create(context) {
const allowWholeFile =
context.options[0] && context.options[0].allowWholeFile
const sourceCode = context.getSourceCode()
const disabledArea = DisabledArea.get(sourceCode)
return {
Program(node) {
if (allowWholeFile && node.body.length === 0) {
return
}
for (const area of disabledArea.areas) {
if (area.end != null) {
continue
}
if (
allowWholeFile &&
utils.lte(area.start, node.loc.start)
) {
continue
}
context.report({
loc: utils.toRuleIdLocation(area.comment, area.ruleId),
message: area.ruleId
? "Requires 'eslint-enable' directive for '{{ruleId}}'."
: "Requires 'eslint-enable' directive.",
data: area,
})
}
},
}
},
}