prefer-regexp-exec.ts

import {
  AST_NODE_TYPES,
  TSESTree,
} from '@typescript-eslint/experimental-utils';
import * as tsutils from 'tsutils';
import * as ts from 'typescript';
import {
  createRule,
  getParserServices,
  getStaticValue,
  getTypeName,
  getWrappingFixer,
} from '../util';

enum ArgumentType {
  Both,
  Other,
  RegExp,
  String,
}

export default createRule({
  name: 'prefer-regexp-exec',
  defaultOptions: [],

  meta: {
    type: 'suggestion',
    fixable: 'code',
    docs: {
      description:
        'Enforce that `RegExp#exec` is used instead of `String#match` if no global flag is provided',
      category: 'Best Practices',
      recommended: 'error',
      requiresTypeChecking: true,
    },
    messages: {
      regExpExecOverStringMatch: 'Use the `RegExp#exec()` method instead.',
    },
    schema: [],
  },

  create(context) {
    const globalScope = context.getScope();
    const parserServices = getParserServices(context);
    const typeChecker = parserServices.program.getTypeChecker();
    const sourceCode = context.getSourceCode();

    /**
     * Check if a given node type is a string.
     * @param node The node type to check.
     */
    function isStringType(type: ts.Type): boolean {
      return getTypeName(typeChecker, type) === 'string';
    }

    /**
     * Check if a given node type is a RegExp.
     * @param node The node type to check.
     */
    function isRegExpType(type: ts.Type): boolean {
      return getTypeName(typeChecker, type) === 'RegExp';
    }

    function collectArgumentTypes(types: ts.Type[]): ArgumentType {
      let result = ArgumentType.Other;

      for (const type of types) {
        if (isRegExpType(type)) {
          if (result === ArgumentType.Other) {
            result = ArgumentType.RegExp;
          } else if (result === ArgumentType.String) {
            result = ArgumentType.Both;
          }
        } else if (isStringType(type)) {
          if (result === ArgumentType.Other) {
            result = ArgumentType.String;
          } else if (result === ArgumentType.RegExp) {
            result = ArgumentType.Both;
          }
        }
      }

      return result;
    }

    return {
      "CallExpression[arguments.length=1] > MemberExpression.callee[property.name='match'][computed=false]"(
        memberNode: TSESTree.MemberExpression,
      ): void {
        const objectNode = memberNode.object;
        const callNode = memberNode.parent as TSESTree.CallExpression;
        const argumentNode = callNode.arguments[0];
        const argumentValue = getStaticValue(argumentNode, globalScope);

        if (
          !isStringType(
            typeChecker.getTypeAtLocation(
              parserServices.esTreeNodeToTSNodeMap.get(objectNode),
            ),
          )
        ) {
          return;
        }

        // Don't report regular expressions with global flag.
        if (
          argumentValue &&
          argumentValue.value instanceof RegExp &&
          argumentValue.value.flags.includes('g')
        ) {
          return;
        }

        if (
          argumentNode.type === AST_NODE_TYPES.Literal &&
          typeof argumentNode.value == 'string'
        ) {
          const regExp = RegExp(argumentNode.value);
          return context.report({
            node: memberNode.property,
            messageId: 'regExpExecOverStringMatch',
            fix: getWrappingFixer({
              sourceCode,
              node: callNode,
              innerNode: [objectNode],
              wrap: objectCode => `${regExp.toString()}.exec(${objectCode})`,
            }),
          });
        }

        const argumentType = typeChecker.getTypeAtLocation(
          parserServices.esTreeNodeToTSNodeMap.get(argumentNode),
        );
        const argumentTypes = collectArgumentTypes(
          tsutils.unionTypeParts(argumentType),
        );
        switch (argumentTypes) {
          case ArgumentType.Both:
          case ArgumentType.Other:
            return context.report({
              node: memberNode.property,
              messageId: 'regExpExecOverStringMatch',
            });

          case ArgumentType.RegExp:
            return context.report({
              node: memberNode.property,
              messageId: 'regExpExecOverStringMatch',
              fix: getWrappingFixer({
                sourceCode,
                node: callNode,
                innerNode: [objectNode, argumentNode],
                wrap: (objectCode, argumentCode) =>
                  `${argumentCode}.exec(${objectCode})`,
              }),
            });

          case ArgumentType.String:
            return context.report({
              node: memberNode.property,
              messageId: 'regExpExecOverStringMatch',
              fix: getWrappingFixer({
                sourceCode,
                node: callNode,
                innerNode: [objectNode, argumentNode],
                wrap: (objectCode, argumentCode) =>
                  `RegExp(${argumentCode}).exec(${objectCode})`,
              }),
            });
        }
      },
    };
  },
});