eslint-plugin-sonarjs/cjs/S8967/rule.js

SonarJS rules for ESLint

"use strict";
/*
 * 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/S8967/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 expect_call_chain_js_1 = require("../helpers/expect-call-chain.js");
const generate_meta_js_1 = require("../helpers/generate-meta.js");
const module_js_1 = require("../helpers/module.js");
const meta = __importStar(require("./generated-meta.js"));
const messages = {
    removeInterpolation: 'Remove this interpolation from the inline snapshot.',
};
const JEST_MODULES = ['jest', '@jest/globals'];
const VITEST_MODULES = ['vitest'];
const INLINE_SNAPSHOT_MATCHERS = new Set([
    'toMatchInlineSnapshot',
    'toThrowErrorMatchingInlineSnapshot',
]);
const ALLOWED_EXPECT_MODIFIERS = new Set(['not', 'resolves', 'rejects']);
exports.rule = {
    meta: (0, generate_meta_js_1.generateMeta)(meta, { messages }),
    create(context) {
        const frameworks = {
            jest: (0, module_js_1.importsOrDependsOnModule)(context, JEST_MODULES, ['jest']),
            vitest: (0, module_js_1.importsOrDependsOnModule)(context, VITEST_MODULES, VITEST_MODULES),
        };
        if (!frameworks.jest && !frameworks.vitest) {
            return {};
        }
        return {
            CallExpression(node) {
                if (node.type !== 'CallExpression') {
                    return;
                }
                const snapshot = getInterpolatedInlineSnapshot(context, node, frameworks);
                if (snapshot) {
                    context.report({
                        node: snapshot,
                        messageId: 'removeInterpolation',
                    });
                }
            },
        };
    },
};
function getInterpolatedInlineSnapshot(context, call, frameworks) {
    if (!(0, ast_js_1.isMethodCall)(call) || !INLINE_SNAPSHOT_MATCHERS.has(call.callee.property.name)) {
        return null;
    }
    if (!isBuiltInInlineSnapshotAssertion(context, call, frameworks)) {
        return null;
    }
    const snapshot = call.arguments.at(-1);
    return snapshot?.type === 'TemplateLiteral' && snapshot.expressions.length > 0 ? snapshot : null;
}
function isBuiltInInlineSnapshotAssertion(context, call, frameworks) {
    const root = (0, expect_call_chain_js_1.getRootCall)(call);
    if (root === null || !isExpectCall(context, root, frameworks)) {
        return false;
    }
    const { segments, complete } = (0, expect_call_chain_js_1.collectCallChain)(call);
    if (!complete) {
        return false;
    }
    const chain = segments.map(segment => segment.name);
    if ((0, ast_js_1.isMethodCall)(root) && root.callee.property.name === 'expect') {
        chain.pop();
    }
    return (chain.length > 0 &&
        INLINE_SNAPSHOT_MATCHERS.has(chain[0]) &&
        chain.slice(1).every(segment => ALLOWED_EXPECT_MODIFIERS.has(segment)));
}
function isExpectCall(context, call, frameworks) {
    const fqn = (0, module_js_1.getFullyQualifiedName)(context, call.callee);
    if (fqn) {
        return fqn === '@jest.globals.expect' || fqn === 'vitest.expect';
    }
    return ((frameworks.jest || frameworks.vitest) &&
        (0, ast_js_1.isIdentifier)(call.callee, 'expect') &&
        isGlobalExpect(context, call.callee));
}
function isGlobalExpect(context, node) {
    const variable = (0, ast_js_1.getVariableFromName)(context, node.name, node);
    return !variable || variable.defs.length === 0;
}