refactor: make getNodeIdentifierTexts avaliable to all rules

Author: RebeccaStevens

src/common/ignore-options.ts

@@ -3,32 +3,15 @@ import escapeRegExp from "escape-string-regexp";
 import type { JSONSchema4 } from "json-schema";
 import type { ReadonlyDeep } from "type-fest";
 
+import { getNodeIdentifierTexts } from "~/util/misc";
 import type { BaseOptions } from "~/util/rule";
+import { inClass, inFunctionBody, inInterface } from "~/util/tree";
 import {
-  getKeyOfValueInObjectExpression,
-  inClass,
-  inFunctionBody,
-  inInterface,
-} from "~/util/tree";
-import {
-  hasID,
-  hasKey,
   isAssignmentExpression,
-  isDefined,
   isPropertyDefinition,
-  isExpressionStatement,
-  isIdentifier,
   isMemberExpression,
   isReadonlyArray,
   isThisExpression,
-  isTSArrayType,
-  isTSIndexSignature,
-  isTSTupleType,
-  isTSTypeAnnotation,
-  isTSTypeLiteral,
-  isTSTypeReference,
-  isUnaryExpression,
-  isVariableDeclaration,
 } from "~/util/typeguard";
 
 /**
@@ -125,73 +108,6 @@ export const ignoreInterfaceOptionSchema: JSONSchema4["properties"] = {
   },
 };
 
-/**
- * Get the identifier text of the given node.
- */
-function getNodeIdentifierText(
-  node: ReadonlyDeep<TSESTree.Node> | null | undefined,
-  context: ReadonlyDeep<TSESLint.RuleContext<string, BaseOptions>>
-): string | undefined {
-  if (!isDefined(node)) {
-    return undefined;
-  }
-
-  const identifierText = isIdentifier(node)
-    ? node.name
-    : hasID(node) && isDefined(node.id)
-    ? getNodeIdentifierText(node.id, context)
-    : hasKey(node) && isDefined(node.key)
-    ? getNodeIdentifierText(node.key, context)
-    : isAssignmentExpression(node)
-    ? getNodeIdentifierText(node.left, context)
-    : isMemberExpression(node)
-    ? `${getNodeIdentifierText(node.object, context)}.${getNodeIdentifierText(
-        node.property,
-        context
-      )}`
-    : isThisExpression(node)
-    ? "this"
-    : isUnaryExpression(node)
-    ? getNodeIdentifierText(node.argument, context)
-    : isExpressionStatement(node)
-    ? context.getSourceCode().getText(node as TSESTree.Node)
-    : isTSArrayType(node) ||
-      isTSIndexSignature(node) ||
-      isTSTupleType(node) ||
-      isTSTypeAnnotation(node) ||
-      isTSTypeLiteral(node) ||
-      isTSTypeReference(node)
-    ? getNodeIdentifierText(node.parent, context)
-    : null;
-
-  if (identifierText !== null) {
-    return identifierText;
-  }
-
-  const keyInObjectExpression = getKeyOfValueInObjectExpression(node);
-  if (keyInObjectExpression !== null) {
-    return keyInObjectExpression;
-  }
-
-  return undefined;
-}
-
-/**
- * Get all the identifier texts of the given node.
- */
-function getNodeIdentifierTexts(
-  node: ReadonlyDeep<TSESTree.Node>,
-  context: ReadonlyDeep<TSESLint.RuleContext<string, BaseOptions>>
-): ReadonlyArray<string> {
-  return (
-    isVariableDeclaration(node)
-      ? node.declarations.flatMap((declarator) =>
-          getNodeIdentifierText(declarator, context)
-        )
-      : [getNodeIdentifierText(node, context)]
-  ).filter<string>((text): text is string => text !== undefined);
-}
-
 /**
  * Should the given text be allowed?
  *

src/util/misc.ts

@@ -1,7 +1,28 @@
-import type { TSESTree } from "@typescript-eslint/utils";
+import type { TSESLint, TSESTree } from "@typescript-eslint/utils";
 import { AST_NODE_TYPES } from "@typescript-eslint/utils";
 import type { ReadonlyDeep } from "type-fest";
 
+import type { BaseOptions } from "~/util/rule";
+import { getKeyOfValueInObjectExpression } from "~/util/tree";
+import {
+  hasID,
+  hasKey,
+  isAssignmentExpression,
+  isDefined,
+  isExpressionStatement,
+  isIdentifier,
+  isMemberExpression,
+  isThisExpression,
+  isTSArrayType,
+  isTSIndexSignature,
+  isTSTupleType,
+  isTSTypeAnnotation,
+  isTSTypeLiteral,
+  isTSTypeReference,
+  isUnaryExpression,
+  isVariableDeclaration,
+} from "~/util/typeguard";
+
 /**
  * Higher order function to check if the two given values are the same.
  */
@@ -21,3 +42,70 @@ export function isDirectivePrologue(
     node.expression.value.startsWith("use ")
   );
 }
+
+/**
+ * Get the identifier text of the given node.
+ */
+function getNodeIdentifierText(
+  node: ReadonlyDeep<TSESTree.Node> | null | undefined,
+  context: ReadonlyDeep<TSESLint.RuleContext<string, BaseOptions>>
+): string | undefined {
+  if (!isDefined(node)) {
+    return undefined;
+  }
+
+  const identifierText = isIdentifier(node)
+    ? node.name
+    : hasID(node) && isDefined(node.id)
+    ? getNodeIdentifierText(node.id, context)
+    : hasKey(node) && isDefined(node.key)
+    ? getNodeIdentifierText(node.key, context)
+    : isAssignmentExpression(node)
+    ? getNodeIdentifierText(node.left, context)
+    : isMemberExpression(node)
+    ? `${getNodeIdentifierText(node.object, context)}.${getNodeIdentifierText(
+        node.property,
+        context
+      )}`
+    : isThisExpression(node)
+    ? "this"
+    : isUnaryExpression(node)
+    ? getNodeIdentifierText(node.argument, context)
+    : isExpressionStatement(node)
+    ? context.getSourceCode().getText(node as TSESTree.Node)
+    : isTSArrayType(node) ||
+      isTSIndexSignature(node) ||
+      isTSTupleType(node) ||
+      isTSTypeAnnotation(node) ||
+      isTSTypeLiteral(node) ||
+      isTSTypeReference(node)
+    ? getNodeIdentifierText(node.parent, context)
+    : null;
+
+  if (identifierText !== null) {
+    return identifierText;
+  }
+
+  const keyInObjectExpression = getKeyOfValueInObjectExpression(node);
+  if (keyInObjectExpression !== null) {
+    return keyInObjectExpression;
+  }
+
+  return undefined;
+}
+
+/**
+ * Get all the identifier texts of the given node.
+ */
+export function getNodeIdentifierTexts(
+  node: ReadonlyDeep<TSESTree.Node>,
+  context: ReadonlyDeep<TSESLint.RuleContext<string, BaseOptions>>
+): ReadonlyArray<string> {
+  return (
+    isVariableDeclaration(node)
+      ? node.declarations.flatMap((declarator) =>
+          getNodeIdentifierText(declarator, context)
+        )
+      : [getNodeIdentifierText(node, context)]
+  ).filter<string>((text): text is string => text !== undefined);
+}