no-node-access.ts

import { TSESTree, ASTUtils } from '@typescript-eslint/utils';

import { createTestingLibraryRule } from '../create-testing-library-rule';
import { ALL_RETURNING_NODES } from '../utils';

export const RULE_NAME = 'no-node-access';
export type MessageIds = 'noNodeAccess';
export type Options = [{ allowContainerFirstChild: boolean }];

export default createTestingLibraryRule<Options, MessageIds>({
  name: RULE_NAME,
  meta: {
    type: 'problem',
    docs: {
      description: 'Disallow direct Node access',
      recommendedConfig: {
        dom: false,
        angular: 'error',
        react: 'error',
        vue: 'error',
        marko: 'error',
      },
    },
    messages: {
      noNodeAccess:
        'Avoid direct Node access. Prefer using the methods from Testing Library.',
    },
    schema: [
      {
        type: 'object',
        properties: {
          allowContainerFirstChild: {
            type: 'boolean',
          },
        },
      },
    ],
  },
  defaultOptions: [
    {
      allowContainerFirstChild: false,
    },
  ],

  create(context, [{ allowContainerFirstChild = false }], helpers) {
    function showErrorForNodeAccess(node: TSESTree.MemberExpression) {
      // This rule is so aggressive that can cause tons of false positives outside test files when Aggressive Reporting
      // is enabled. Because of that, this rule will skip this mechanism and report only if some Testing Library package
      // or custom one (set in utils-module Shared Setting) is found.
      if (!helpers.isTestingLibraryImported(true)) {
        return;
      }

      if (
        ASTUtils.isIdentifier(node.property) &&
        ALL_RETURNING_NODES.includes(node.property.name)
      ) {
        if (allowContainerFirstChild && node.property.name === 'firstChild') {
          return;
        }

        context.report({
          node,
          loc: node.property.loc.start,
          messageId: 'noNodeAccess',
        });
      }
    }

    return {
      'ExpressionStatement MemberExpression': showErrorForNodeAccess,
      'VariableDeclarator MemberExpression': showErrorForNodeAccess,
    };
  },
});