eslint-plugin-sonarjs
Version:
182 lines (181 loc) • 6.73 kB
JavaScript
;
/*
* SonarQube JavaScript Plugin
* Copyright (C) SonarSource Sàrl
* mailto:info AT sonarsource DOT com
*
* You can redistribute and/or modify this program under the terms of
* the Sonar Source-Available License Version 1, as published by SonarSource Sàrl.
*
* 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/S2970/javascript
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.rule = void 0;
const generate_meta_js_1 = require("../helpers/generate-meta.js");
const ast_js_1 = require("../helpers/ast.js");
const meta = __importStar(require("./generated-meta.js"));
const matchers_js_1 = require("./matchers.js");
exports.rule = {
meta: (0, generate_meta_js_1.generateMeta)(meta),
create(context) {
return {
ExpressionStatement(node) {
const expr = unwrapAwait(node.expression);
reportIncompleteMemberAssertion(context, expr);
reportIncompleteExpectCall(context, expr);
},
};
},
};
function unwrapAwait(expr) {
return expr.type === 'AwaitExpression' ? expr.argument : expr;
}
function reportIncompleteMemberAssertion(context, expr) {
if (expr.type !== 'MemberExpression') {
return;
}
const { property } = expr;
if (isExpectStaticMethod(expr) && (0, ast_js_1.isIdentifier)(property)) {
context.report({
node: property,
message: `Complete this assertion; '${property.name}' doesn't assert anything by itself.`,
});
return;
}
if (!isTestAssertion(expr)) {
return;
}
if ((0, ast_js_1.isIdentifier)(property, ...matchers_js_1.assertionFunctions) &&
!((0, ast_js_1.isIdentifier)(property, 'rejects') && isExpectAssertion(expr.object))) {
context.report({
node: property,
message: `Call this '${property.name}' assertion.`,
});
}
else if ((0, ast_js_1.isIdentifier)(property, ...matchers_js_1.gettersOrModifiers)) {
context.report({
node: property,
message: `Complete this assertion; '${property.name}' doesn't assert anything by itself.`,
});
}
}
function reportIncompleteExpectCall(context, expr) {
if (isExpectCall(expr)) {
context.report({
node: expr.callee,
message: `Complete this assertion; '${expr.callee.name}' doesn't assert anything by itself.`,
});
return;
}
if (expr.type !== 'CallExpression' ||
expr.callee.type !== 'MemberExpression' ||
!isExpectStaticMethod(expr.callee)) {
return;
}
const { property } = expr.callee;
if ((0, ast_js_1.isIdentifier)(property)) {
context.report({
node: property,
message: `Complete this assertion; '${property.name}' doesn't assert anything by itself.`,
});
}
}
function isTestAssertion(node) {
const { object, property } = node;
// Chai's BDD style where 'should' extends Object.prototype https://www.chaijs.com/guide/styles/
if ((0, ast_js_1.isIdentifier)(object) && (0, ast_js_1.isIdentifier)(property, 'should')) {
return true;
}
if (isExpectCall(object) || (0, ast_js_1.isIdentifier)(object, 'assert', 'expect', 'should')) {
return true;
}
if (object.type === 'MemberExpression') {
return isTestAssertion(object);
}
if (object.type === 'CallExpression') {
if (isExpectStaticMethod(object.callee)) {
return true;
}
if (object.callee.type === 'MemberExpression') {
return isTestAssertion(object.callee);
}
}
return false;
}
function isExpectAssertion(node) {
if (isExpectCall(node) || (0, ast_js_1.isIdentifier)(node, 'expect')) {
return true;
}
if (node.type === 'MemberExpression') {
return isExpectAssertion(node.object);
}
if (node.type === 'CallExpression') {
if (isExpectStaticMethod(node.callee)) {
return true;
}
if (node.callee.type === 'MemberExpression') {
return isExpectAssertion(node.callee.object);
}
}
return false;
}
function isExpectCall(node) {
return (node.type === 'CallExpression' &&
(0, ast_js_1.isIdentifier)(node.callee, 'expect') &&
!(0, ast_js_1.isNumberLiteral)(node.arguments[0]));
}
/**
* Playwright (and Vitest) expose `soft` / `poll` as static methods on `expect`:
* `expect.soft(locator)`, `expect.poll(fn)`, `expect.soft.poll(fn)`.
* @see https://playwright.dev/docs/test-assertions
*/
function isExpectStaticMethod(node) {
if (node.type !== 'MemberExpression' || !(0, ast_js_1.isIdentifier)(node.property, ...matchers_js_1.expectStaticMethods)) {
return false;
}
if ((0, ast_js_1.isIdentifier)(node.object, 'expect')) {
return true;
}
// Nested forms such as `expect.soft.poll`
return isExpectStaticMethod(node.object);
}