eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
81 lines (80 loc) • 3.81 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/S2999/javascript
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.rule = void 0;
const typescript_1 = __importDefault(require("typescript"));
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 considerJSDoc = !!context.options[0]?.considerJSDoc;
const services = context.sourceCode.parserServices;
if (!(0, index_js_1.isRequiredParserServices)(services)) {
return {};
}
return {
'NewExpression[callee.type!="ThisExpression"]': (node) => {
const { callee } = node;
const type = (0, index_js_1.getTypeFromTreeNode)(callee, services);
const signature = (0, index_js_1.getSignatureFromCallee)(node, services);
if (!isInstantiable(type, signature, considerJSDoc) && !isAny(type)) {
const functionToken = context.sourceCode.getFirstToken(node, token => token.type === 'Keyword' && token.value === 'function');
const newToken = context.sourceCode.getFirstToken(node, token => token.type === 'Keyword' && token.value === 'new');
const text = isFunction(type) ? 'this function' : context.sourceCode.getText(callee);
const loc = callee.type === 'FunctionExpression' ? functionToken.loc : callee.loc;
(0, index_js_1.report)(context, {
message: `Replace ${text} with a constructor function.`,
loc,
}, [(0, index_js_1.toSecondaryLocation)(newToken)]);
}
},
};
},
};
function isInstantiable(type, signature, considerJSDoc) {
return (isClass(type) ||
isModule(type) ||
isConstructor(type, signature, considerJSDoc) ||
(type.isUnionOrIntersection() &&
type.types.some(tp => isInstantiable(tp, signature, considerJSDoc))));
}
function isClass(type) {
return (type.symbol &&
((type.symbol.flags & typescript_1.default.SymbolFlags.Class) !== 0 ||
(type.symbol.flags & typescript_1.default.SymbolFlags.Type) !== 0));
}
function isModule(type) {
return type.symbol && (type.symbol.flags & typescript_1.default.SymbolFlags.Module) !== 0;
}
function isFunction(type) {
return type.symbol && (type.symbol.flags & typescript_1.default.SymbolFlags.Function) !== 0;
}
function isConstructor(type, signature, considerJSDoc) {
return isFunction(type) && (!considerJSDoc || hasJSDocAnnotation(signature));
}
function hasJSDocAnnotation(signature) {
return signature?.getJsDocTags().some(tag => ['constructor', 'class'].includes(tag.name));
}
function isAny(type) {
return type.flags === typescript_1.default.TypeFlags.Any;
}