1 | 'use strict';
|
2 |
|
3 | const report = require('../../utils/report');
|
4 | const ruleMessages = require('../../utils/ruleMessages');
|
5 | const validateOptions = require('../../utils/validateOptions');
|
6 | const { isRegExp, isString } = require('../../utils/validateTypes');
|
7 |
|
8 | const ruleName = 'comment-pattern';
|
9 |
|
10 | const messages = ruleMessages(ruleName, {
|
11 | expected: (pattern) => `Expected comment to match pattern "${pattern}"`,
|
12 | });
|
13 |
|
14 | const meta = {
|
15 | url: 'https://stylelint.io/user-guide/rules/list/comment-pattern',
|
16 | };
|
17 |
|
18 |
|
19 | const rule = (primary) => {
|
20 | return (root, result) => {
|
21 | const validOptions = validateOptions(result, ruleName, {
|
22 | actual: primary,
|
23 | possible: [isRegExp, isString],
|
24 | });
|
25 |
|
26 | if (!validOptions) {
|
27 | return;
|
28 | }
|
29 |
|
30 | const normalizedPattern = isString(primary) ? new RegExp(primary) : primary;
|
31 |
|
32 | root.walkComments((comment) => {
|
33 | const text = comment.text;
|
34 |
|
35 | if (normalizedPattern.test(text)) {
|
36 | return;
|
37 | }
|
38 |
|
39 | report({
|
40 | message: messages.expected(primary),
|
41 | node: comment,
|
42 | result,
|
43 | ruleName,
|
44 | });
|
45 | });
|
46 | };
|
47 | };
|
48 |
|
49 | rule.ruleName = ruleName;
|
50 | rule.messages = messages;
|
51 | rule.meta = meta;
|
52 | module.exports = rule;
|