sonarqube/server/sonar-web/eslint-local-rules/use-jest-mocked.js

/*
 * SonarQube
 * Copyright (C) 2009-2023 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 GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * 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 GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
module.exports = {
  meta: {
    messages: {
      useJestMocked: 'Prefer using jest.mocked(func) instead of (func as jest.Mock)',
    },
  },
  create(context) {
    return {
      TSAsExpression(node) {
        if (node.typeAnnotation.typeName) {
          const { left, right } = node.typeAnnotation.typeName;
          if (left && left.name === 'jest' && right && right.name === 'Mock') {
            context.report({ node, messageId: 'useJestMocked' });
          }
        }
      },
    };
  },
};