Skip to content
Permalink
9bfb9ba527
Switch branches/tags

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?
Go to file
 
 
Cannot retrieve contributors at this time
78 lines (74 sloc) 2.55 KB
/**
* @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.",
})
}
}
},
}
},
}