blob: bb1946bba7e77d5409ecd86eeab5b5ed16558cb7 [file] [log] [blame]
'use strict';
const report = require('../../utils/report');
const ruleMessages = require('../../utils/ruleMessages');
const validateOptions = require('../../utils/validateOptions');
const { isRegExp, isString } = require('../../utils/validateTypes');
const ruleName = 'comment-pattern';
const messages = ruleMessages(ruleName, {
expected: (pattern) => `Expected comment to match pattern "${pattern}"`,
});
/** @type {import('stylelint').Rule} */
const rule = (primary) => {
return (root, result) => {
const validOptions = validateOptions(result, ruleName, {
actual: primary,
possible: [isRegExp, isString],
});
if (!validOptions) {
return;
}
const normalizedPattern = isString(primary) ? new RegExp(primary) : primary;
root.walkComments((comment) => {
const text = comment.text;
if (normalizedPattern.test(text)) {
return;
}
report({
message: messages.expected(primary),
node: comment,
result,
ruleName,
});
});
};
};
rule.ruleName = ruleName;
rule.messages = messages;
module.exports = rule;