fix(eslint-plugin-formatjs): rm hard dep on @typescript-eslint/typescript-estree, fix #666

Author: Long Ho

packages/eslint-plugin-formatjs/src/util.ts

@@ -1,4 +1,4 @@
-import {TSESTree, AST_NODE_TYPES} from '@typescript-eslint/typescript-estree';
+import {TSESTree} from '@typescript-eslint/typescript-estree';
 import {Scope} from 'eslint';
 
 export interface MessageDescriptor {
@@ -14,7 +14,7 @@ export interface MessageDescriptorNodeInfo {
 }
 
 function isStringLiteral(node: TSESTree.Node): node is TSESTree.StringLiteral {
-  return node.type === AST_NODE_TYPES.Literal && typeof node.value === 'string';
+  return node.type === "Literal" && typeof node.value === 'string';
 }
 
 function findReferenceImport(
@@ -28,22 +28,22 @@ function findReferenceImport(
 
 function isIntlFormatMessageCall(node: TSESTree.Node) {
   return (
-    node.type === AST_NODE_TYPES.CallExpression &&
-    node.callee.type === AST_NODE_TYPES.MemberExpression &&
-    node.callee.object.type === AST_NODE_TYPES.Identifier &&
+    node.type === "CallExpression" &&
+    node.callee.type === "MemberExpression" &&
+    node.callee.object.type === "Identifier" &&
     node.callee.object.name === 'intl' &&
-    node.callee.property.type === AST_NODE_TYPES.Identifier &&
+    node.callee.property.type === "Identifier" &&
     node.callee.property.name === 'formatMessage' &&
     node.arguments.length >= 1 &&
-    node.arguments[0].type === AST_NODE_TYPES.ObjectExpression
+    node.arguments[0].type === "ObjectExpression"
   );
 }
 
 function isSingleMessageDescriptorDeclaration(
   id: TSESTree.LeftHandSideExpression,
   importedVars: Scope.Variable[]
 ) {
-  if (id.type !== AST_NODE_TYPES.Identifier) {
+  if (id.type !== "Identifier") {
     return false;
   }
   const importedVar = findReferenceImport(id, importedVars);
@@ -56,7 +56,7 @@ function isMultipleMessageDescriptorDeclaration(
   id: TSESTree.LeftHandSideExpression,
   importedVars: Scope.Variable[]
 ) {
-  if (id.type !== AST_NODE_TYPES.Identifier) {
+  if (id.type !== "Identifier") {
     return false;
   }
   const importedVar = findReferenceImport(id, importedVars);
@@ -69,7 +69,7 @@ function isMultipleMessageDescriptorDeclaration(
 function extractMessageDescriptor(
   node?: TSESTree.Expression
 ): MessageDescriptorNodeInfo | undefined {
-  if (!node || node.type !== AST_NODE_TYPES.ObjectExpression) {
+  if (!node || node.type !== "ObjectExpression") {
     return;
   }
   const result: MessageDescriptorNodeInfo = {
@@ -79,8 +79,8 @@ function extractMessageDescriptor(
   };
   for (const prop of node.properties) {
     if (
-      prop.type !== AST_NODE_TYPES.Property ||
-      prop.key.type !== AST_NODE_TYPES.Identifier
+      prop.type !== "Property" ||
+      prop.key.type !== "Identifier"
     ) {
       continue;
     }
@@ -118,8 +118,8 @@ function extractMessageDescriptorFromJSXElement(
   };
   for (const prop of node.attributes) {
     if (
-      prop.type !== AST_NODE_TYPES.JSXAttribute ||
-      prop.name.type !== AST_NODE_TYPES.JSXIdentifier
+      prop.type !== "JSXAttribute" ||
+      prop.name.type !== "JSXIdentifier"
     ) {
       continue;
     }
@@ -128,7 +128,7 @@ function extractMessageDescriptorFromJSXElement(
       case 'defaultMessage':
         result.messageNode = prop.value;
         if (
-          prop.value?.type === AST_NODE_TYPES.Literal &&
+          prop.value?.type === "Literal" &&
           typeof prop.value.value === 'string'
         ) {
           result.message.defaultMessage = prop.value.value;
@@ -137,24 +137,24 @@ function extractMessageDescriptorFromJSXElement(
       case 'description':
         result.descriptionNode = prop.value;
         if (
-          prop.value?.type === AST_NODE_TYPES.Literal &&
+          prop.value?.type === "Literal" &&
           typeof prop.value.value === 'string'
         ) {
           result.message.description = prop.value.value;
         }
         break;
       case 'id':
         if (
-          prop.value?.type === AST_NODE_TYPES.Literal &&
+          prop.value?.type === "Literal" &&
           typeof prop.value.value === 'string'
         ) {
           result.message.id = prop.value.value;
         }
         break;
       case 'values':
         if (
-          prop.value?.type === AST_NODE_TYPES.JSXExpressionContainer &&
-          prop.value.expression.type === AST_NODE_TYPES.ObjectExpression
+          prop.value?.type === "JSXExpressionContainer" &&
+          prop.value.expression.type === "ObjectExpression"
         ) {
           values = prop.value.expression;
         }
@@ -170,18 +170,18 @@ function extractMessageDescriptorFromJSXElement(
 function extractMessageDescriptors(node?: TSESTree.Expression) {
   if (
     !node ||
-    node.type !== AST_NODE_TYPES.ObjectExpression ||
+    node.type !== "ObjectExpression" ||
     !node.properties.length
   ) {
     return [];
   }
   const msgs = [];
   for (const prop of node.properties) {
-    if (prop.type !== AST_NODE_TYPES.Property) {
+    if (prop.type !== "Property") {
       continue;
     }
     const msg = prop.value;
-    if (msg.type !== AST_NODE_TYPES.ObjectExpression) {
+    if (msg.type !== "ObjectExpression") {
       continue;
     }
     const nodeInfo = extractMessageDescriptor(msg);
@@ -197,7 +197,7 @@ export function extractMessages(
   importedMacroVars: Scope.Variable[],
   excludeMessageDeclCalls = false
 ): Array<[MessageDescriptorNodeInfo, TSESTree.Expression | undefined]> {
-  if (node.type === AST_NODE_TYPES.CallExpression) {
+  if (node.type === "CallExpression") {
     const expr = node;
     const fnId = expr.callee;
     if (
@@ -219,9 +219,9 @@ export function extractMessages(
       ]);
     }
   } else if (
-    node.type === AST_NODE_TYPES.JSXOpeningElement &&
+    node.type === "JSXOpeningElement" &&
     node.name &&
-    node.name.type === AST_NODE_TYPES.JSXIdentifier &&
+    node.name.type === "JSXIdentifier" &&
     node.name.name === 'FormattedMessage'
   ) {
     const msgDescriptorNodeInfo = extractMessageDescriptorFromJSXElement(node);

packages/eslint-plugin-formatjs/tsconfig.json

@@ -7,17 +7,15 @@
         "module": "commonjs",
         "noUnusedLocals": true,
         "sourceMap": true,
+        "preserveConstEnums": false,
         "types": [
             "eslint",
-            "estree",
-            "estree-jsx",
             "babel__core",
             "babel__generator",
             "babel__template",
             "babel__traverse",
             "benchmark",
             "chai",
-            "estree",
             "fs-extra",
             "istanbul-lib-coverage",
             "istanbul-lib-report",