eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
76 lines (75 loc) • 2.99 kB
JavaScript
;
/*
* SonarQube JavaScript Plugin
* Copyright (C) 2011-2024 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 GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* 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 GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
// https://sonarsource.github.io/rspec/#/rspec/S1135/javascript
Object.defineProperty(exports, "__esModule", { value: true });
exports.reportPatternInComment = exports.rule = void 0;
const helpers_1 = require("../helpers");
const meta_1 = require("./meta");
const todoPattern = 'todo';
const letterPattern = /[\p{Letter}]/u;
exports.rule = {
meta: (0, helpers_1.generateMeta)(meta_1.meta, {
messages: {
completeTODO: 'Complete the task associated to this "TODO" comment.',
},
}),
create(context) {
return {
'Program:exit': () => {
reportPatternInComment(context, todoPattern, 'completeTODO');
},
};
},
};
function reportPatternInComment(context, pattern, messageId) {
const sourceCode = context.sourceCode;
sourceCode.getAllComments().forEach(comment => {
const rawText = comment.value.toLowerCase();
if (rawText.includes(pattern)) {
const lines = rawText.split(/\r\n?|\n/);
for (let i = 0; i < lines.length; i++) {
const index = lines[i].indexOf(pattern);
if (index >= 0 && !isLetterAround(lines[i], index, pattern)) {
context.report({
messageId,
loc: getPatternPosition(i, index, comment, pattern),
});
}
}
}
});
}
exports.reportPatternInComment = reportPatternInComment;
function isLetterAround(line, start, pattern) {
const end = start + pattern.length;
const pre = start > 0 && letterPattern.test(line.charAt(start - 1));
const post = end <= line.length - 1 && letterPattern.test(line.charAt(end));
return pre || post;
}
function getPatternPosition(lineIdx, index, comment, pattern) {
const line = comment.loc.start.line + lineIdx;
const columnStart = lineIdx === 0 ? comment.loc.start.column + 2 : 0;
const patternStart = columnStart + index;
return {
start: { line, column: patternStart },
end: { line, column: patternStart + pattern.length },
};
}