eslint-plugin-sonarjs
Version:
190 lines (189 loc) • 7.46 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/S8959/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 ast_js_1 = require("../helpers/ast.js");
const cypress_js_1 = require("../helpers/testing/cypress.js");
const generate_meta_js_1 = require("../helpers/generate-meta.js");
const module_js_1 = require("../helpers/module.js");
const quickfix_js_1 = require("../helpers/quickfix.js");
const test_file_pattern_js_1 = require("../helpers/test-file-pattern.js");
const meta = __importStar(require("./generated-meta.js"));
const TESTING_LIBRARY_MODULES = [
'@testing-library/dom',
'@testing-library/react',
'@testing-library/vue',
'@testing-library/angular',
'@testing-library/svelte',
'@testing-library/preact',
];
const TESTING_LIBRARY_DEBUG_COMMANDS = [
'screen.debug',
'screen.logTestingPlaygroundURL',
'render.debug',
'prettyDOM',
'logRoles',
];
exports.rule = {
meta: (0, generate_meta_js_1.generateMeta)(meta, {
messages: {
removeDebugCommand: 'Remove this debug command from the test.',
},
fixable: 'code',
}),
create(context) {
if (!(0, test_file_pattern_js_1.isTestRelatedFile)(context.filename, context.settings?.testFileExtensions)) {
return {};
}
return {
CallExpression(node) {
const call = node;
if ((0, ast_js_1.isMethodCall)(call)) {
if (isUiTestDebugCommand(context, call)) {
reportDebugCommand(context, call, call.callee.property);
}
}
else if (isTestingLibraryDebugCommand(context, call)) {
reportDebugCommand(context, call, call.callee);
}
},
};
},
};
function isUiTestDebugCommand(context, call) {
const { callee } = call;
const { object, property } = callee;
switch (property.name) {
case 'pause':
return (0, cypress_js_1.chainStartsWithCy)(object) || (0, ast_js_1.isIdentifier)(object, 'page');
case 'debug':
return isTestingLibraryDebugCommand(context, call) || (0, cypress_js_1.chainStartsWithCy)(object);
case 'logTestingPlaygroundURL':
return isTestingLibraryDebugCommand(context, call);
default:
return false;
}
}
function isTestingLibraryDebugCommand(context, call) {
// getFullyQualifiedName intentionally resolves imports in the current file only.
// Custom test-utils wrappers that re-export Testing Library symbols are not resolved here.
const fqn = (0, module_js_1.getFullyQualifiedName)(context, call.callee);
if (!fqn) {
return false;
}
return TESTING_LIBRARY_MODULES.some(module => {
const prefix = `${module.replace('/', '.')}.`;
return (fqn.startsWith(prefix) &&
TESTING_LIBRARY_DEBUG_COMMANDS.some(command => fqn.endsWith(`.${command}`)));
});
}
function reportDebugCommand(context, call, reportNode) {
context.report({
node: reportNode,
messageId: 'removeDebugCommand',
fix: fixer => removeDebugCommand(context, call, fixer),
});
}
/**
* Removes the whole statement only for root debug calls used as standalone statements, e.g.
* `cy.pause();`, `await page.pause();`, `screen.debug();`, or `prettyDOM(el);`. For Cypress chains, only the `.pause()`/`.debug()`
* link is spliced out, e.g. `cy.get('x').debug().click();` -> `cy.get('x').click();` and
* `cy.get('x').pause();` -> `cy.get('x');`.
*/
function removeDebugCommand(context, call, fixer) {
const statement = unwrapToStatementExpression(call);
if (call.callee.type === 'MemberExpression') {
if (isRootDebugReceiver(call.callee.object) && (0, ast_js_1.hasParent)(statement)) {
const { parent } = statement;
if (parent.type === 'ExpressionStatement' && parent.expression === statement) {
return (0, quickfix_js_1.removeNodeWithLeadingWhitespaces)(context, parent, fixer);
}
}
const objectRange = call.callee.object.range;
const callRange = call.range;
if (!objectRange || !callRange) {
return null;
}
return fixer.removeRange([objectRange[1], callRange[1]]);
}
else if ((0, ast_js_1.hasParent)(statement)) {
const { parent } = statement;
if (parent.type === 'ExpressionStatement' && parent.expression === statement) {
return (0, quickfix_js_1.removeNodeWithLeadingWhitespaces)(context, parent, fixer);
}
}
return null;
}
function unwrapToStatementExpression(node) {
let current = node;
while ((0, ast_js_1.hasParent)(current)) {
const { parent } = current;
if ((parent.type === 'ChainExpression' && parent.expression === current) ||
(parent.type === 'AwaitExpression' && parent.argument === current)) {
current = parent;
}
else {
break;
}
}
return current;
}
function isRootDebugReceiver(node) {
return (0, ast_js_1.isIdentifier)(unwrapChainExpression(node), 'cy', 'page', 'screen');
}
function unwrapChainExpression(node) {
let current = node;
while (current.type === 'ChainExpression') {
current = current.expression;
}
return current;
}