eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
51 lines (50 loc) • 2.01 kB
JavaScript
;
/*
* SonarQube JavaScript Plugin
* Copyright (C) 2011-2025 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the Sonar Source-Available License for more details.
*
* You should have received a copy of the Sonar Source-Available License
* along with this program; if not, see https://sonarsource.com/license/ssal/
*/
// https://sonarsource.github.io/rspec/#/rspec/S124/javascript
Object.defineProperty(exports, "__esModule", { value: true });
exports.rule = void 0;
const index_js_1 = require("../helpers/index.js");
const meta_js_1 = require("./meta.js");
exports.rule = {
meta: (0, index_js_1.generateMeta)(meta_js_1.meta, { schema: meta_js_1.schema }),
create(context) {
const options = context.options[0] || {};
const flags = options.flags || '';
const cleanedFlags = 'gimusy'
.split('')
.filter(c => flags.includes(c))
.join('');
const pattern = options.regularExpression
? new RegExp(options.regularExpression, cleanedFlags)
: undefined;
const message = options.message || 'The regular expression matches this comment.';
return {
'Program:exit': () => {
context.sourceCode.getAllComments().forEach(comment => {
const rawTextTrimmed = comment.value.trim();
if (pattern?.test(rawTextTrimmed)) {
context.report({
message,
loc: comment.loc,
});
}
});
},
};
},
};