/
no-warning-comments.js
174 lines (149 loc) · 6.13 KB
/
no-warning-comments.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/**
* @fileoverview Rule that warns about used warning comments
* @author Alexander Schmidt <https://github.com/lxanders>
*/
"use strict";
const escapeRegExp = require("escape-string-regexp");
const astUtils = require("./utils/ast-utils");
const CHAR_LIMIT = 40;
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
docs: {
description: "Disallow specified warning terms in comments",
recommended: false,
url: "https://eslint.org/docs/rules/no-warning-comments"
},
schema: [
{
type: "object",
properties: {
terms: {
type: "array",
items: {
type: "string"
}
},
location: {
enum: ["start", "anywhere"]
}
},
additionalProperties: false
}
],
messages: {
unexpectedComment: "Unexpected '{{matchedTerm}}' comment: '{{comment}}'."
}
},
create(context) {
const sourceCode = context.getSourceCode(),
configuration = context.options[0] || {},
warningTerms = configuration.terms || ["todo", "fixme", "xxx"],
location = configuration.location || "start",
selfConfigRegEx = /\bno-warning-comments\b/u;
/**
* Convert a warning term into a RegExp which will match a comment containing that whole word in the specified
* location ("start" or "anywhere"). If the term starts or ends with non word characters, then the match will not
* require word boundaries on that side.
* @param {string} term A term to convert to a RegExp
* @returns {RegExp} The term converted to a RegExp
*/
function convertToRegExp(term) {
const escaped = escapeRegExp(term);
/*
* When matching at the start, ignore leading whitespace, and
* there's no need to worry about word boundaries.
*
* These expressions for the prefix and suffix are designed as follows:
* ^ handles any terms at the beginning of a line
* e.g. terms ["TODO"] matches `//TODO something`
* $ handles any terms at the end of a line
* e.g. terms ["TODO"] matches `// something TODO`
* \s* handles optional leading spaces (for "start" location only)
* e.g. terms ["TODO"] matches `// TODO something`
* \W handles terms preceded/followed by non-word characters, especially where there's no word boundary.
* e.g. terms: ["!TODO", "TODO!"] matches `// !!!TODO blah` or `// TODO!!! blah`
* \b handles terms preceded/followed by word boundary
* e.g. terms: ["!FIX", "FIX!"] matches `// FIX!something` or `// something!FIX`
* terms: ["FIX"] matches `// FIX!` or `// !FIX`, but not `// fixed or affix`
*/
const prefix = location === "start" ? "(?:^\\s*)" : "(?:^|\\b|\\W)";
const suffix = "(?:\\b|\\W|$)";
const flags = "iu"; // Case-insenstive with Unicode case folding.
/*
* For location "start" the regex should be
* /(?:^\s*)ESCAPED_TERM(?:\b|\W|$)/iu.
*
* For location "anywhere" the regex should be:
* /(?:^|\b|\W)ESCAPED_TERM(?:\b|\W|$)/iu
*
*/
return new RegExp(`${prefix}${escaped}${suffix}`, flags);
}
const warningRegExps = warningTerms.map(convertToRegExp);
/**
* Checks the specified comment for matches of the configured warning terms and returns the matches.
* @param {string} comment The comment which is checked.
* @returns {Array} All matched warning terms for this comment.
*/
function commentContainsWarningTerm(comment) {
const matches = [];
warningRegExps.forEach((regex, index) => {
if (regex.test(comment)) {
matches.push(warningTerms[index]);
}
});
return matches;
}
/**
* Checks the specified node for matching warning comments and reports them.
* @param {ASTNode} node The AST node being checked.
* @returns {void} undefined.
*/
function checkComment(node) {
const comment = node.value;
if (
astUtils.isDirectiveComment(node) &&
selfConfigRegEx.test(comment)
) {
return;
}
const matches = commentContainsWarningTerm(comment);
matches.forEach(matchedTerm => {
let commentToDisplay = "";
let truncated = false;
for (const c of comment.trim().split(/\s+/u)) {
const tmp = commentToDisplay
? `${commentToDisplay} ${c}`
: c;
if (tmp.length <= CHAR_LIMIT) {
commentToDisplay = tmp;
} else {
truncated = true;
break;
}
}
context.report({
node,
messageId: "unexpectedComment",
data: {
matchedTerm,
comment: `${commentToDisplay}${truncated ? "..." : ""}`
}
});
});
}
return {
Program() {
const comments = sourceCode.getAllComments();
comments
.filter(token => token.type !== "Shebang")
.forEach(checkComment);
}
};
}
};