eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
112 lines (111 loc) • 4.64 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/S4782/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, { hasSuggestions: true }, true),
create(context) {
if (!(0, index_js_1.isRequiredParserServices)(context.sourceCode.parserServices)) {
return {};
}
const compilerOptions = context.sourceCode.parserServices.program.getCompilerOptions();
if (compilerOptions.exactOptionalPropertyTypes) {
return {};
}
function checkProperty(node) {
const tsNode = node;
const optionalToken = context.sourceCode.getFirstToken(node, token => token.value === '?');
if (!tsNode.optional || !optionalToken) {
return;
}
const typeNode = getUndefinedTypeAnnotation(tsNode.typeAnnotation);
if (typeNode) {
const suggest = getQuickFixSuggestions(context, optionalToken, typeNode);
(0, index_js_1.report)(context, {
message: "Consider removing 'undefined' type or '?' specifier, one of them is redundant.",
loc: optionalToken.loc,
suggest,
}, [(0, index_js_1.toSecondaryLocation)(typeNode)]);
}
}
return {
'PropertyDefinition, TSPropertySignature': (node) => checkProperty(node),
};
},
};
function getUndefinedTypeAnnotation(tsTypeAnnotation) {
if (tsTypeAnnotation) {
return getUndefinedTypeNode(tsTypeAnnotation.typeAnnotation);
}
return undefined;
}
function getUndefinedTypeNode(typeNode) {
if (typeNode.type === 'TSUndefinedKeyword') {
return typeNode;
}
else if (typeNode.type === 'TSUnionType') {
return typeNode.types.map(getUndefinedTypeNode).find(tpe => tpe !== undefined);
}
return undefined;
}
function getQuickFixSuggestions(context, optionalToken, undefinedType) {
const suggestions = [
{
desc: 'Remove "?" operator',
fix: fixer => fixer.remove(optionalToken),
},
];
if (undefinedType.parent?.type === 'TSUnionType') {
suggestions.push(getUndefinedRemovalSuggestion(context, undefinedType));
}
return suggestions;
}
function getUndefinedRemovalSuggestion(context, undefinedType) {
return {
desc: 'Remove "undefined" type annotation',
fix: fixer => {
const fixes = [];
const unionType = undefinedType.parent;
if (unionType.types.length === 2) {
const unionTypeNode = unionType;
const otherType = unionType.types[0] === undefinedType ? unionType.types[1] : unionType.types[0];
const otherTypeText = context.sourceCode.getText(otherType);
fixes.push(fixer.replaceText(unionTypeNode, otherTypeText));
const tokenBefore = context.sourceCode.getTokenBefore(unionTypeNode);
const tokenAfter = context.sourceCode.getTokenAfter(unionTypeNode);
if (tokenBefore?.value === '(' && tokenAfter?.value === ')') {
fixes.push(fixer.remove(tokenBefore));
fixes.push(fixer.remove(tokenAfter));
}
}
else {
const index = unionType.types.indexOf(undefinedType);
if (index === 0) {
fixes.push(fixer.removeRange([undefinedType.range[0], unionType.types[1].range[0]]));
}
else {
fixes.push(fixer.removeRange([unionType.types[index - 1].range[1], undefinedType.range[1]]));
}
}
return fixes;
},
};
}