Permalink
Cannot retrieve contributors at this time
78 lines (74 sloc)
2.55 KB
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
codeql-action/node_modules/eslint-plugin-eslint-comments/lib/rules/require-description.js
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* @author Yosuke Ota <https://github.com/ota-meshi> | |
* See LICENSE file in root directory for full license. | |
*/ | |
"use strict" | |
const utils = require("../internal/utils") | |
module.exports = { | |
meta: { | |
docs: { | |
description: | |
"require include descriptions in ESLint directive-comments", | |
category: "Stylistic Issues", | |
recommended: false, | |
url: | |
"https://mysticatea.github.io/eslint-plugin-eslint-comments/rules/require-description.html", | |
}, | |
fixable: null, | |
schema: [ | |
{ | |
type: "object", | |
properties: { | |
ignore: { | |
type: "array", | |
items: { | |
enum: [ | |
"eslint", | |
"eslint-disable", | |
"eslint-disable-line", | |
"eslint-disable-next-line", | |
"eslint-enable", | |
"eslint-env", | |
"exported", | |
"global", | |
"globals", | |
], | |
}, | |
additionalItems: false, | |
uniqueItems: true, | |
}, | |
}, | |
additionalProperties: false, | |
}, | |
], | |
type: "suggestion", | |
}, | |
create(context) { | |
const sourceCode = context.getSourceCode() | |
const ignores = new Set( | |
(context.options[0] && context.options[0].ignore) || [] | |
) | |
return { | |
Program() { | |
for (const comment of sourceCode.getAllComments()) { | |
const directiveComment = utils.parseDirectiveComment( | |
comment | |
) | |
if (directiveComment == null) { | |
continue | |
} | |
if (ignores.has(directiveComment.kind)) { | |
continue | |
} | |
if (!directiveComment.description) { | |
context.report({ | |
loc: utils.toForceLocation(comment.loc), | |
message: | |
"Unexpected undescribed directive comment. Include descriptions to explain why the comment is necessary.", | |
}) | |
} | |
} | |
}, | |
} | |
}, | |
} |