feat(utils): add parser name to thrown parser error message (#8484)

Co-authored-by: Brad Zacher <brad.zacher@gmail.com>
typescript-eslint · Mar 16, 2024 · df00134 · df00134
1 parent 883f220
commit df00134
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 22 deletions.
diff --git a/packages/utils/src/eslint-utils/getParserServices.ts b/packages/utils/src/eslint-utils/getParserServices.ts
@@ -91,14 +91,14 @@ function getParserServices(
 /* eslint-enable @typescript-eslint/unified-signatures */
 
 function throwError(parserPath: string): never {
-  throw new Error(
-    parserPathSeemsToBeTSESLint(parserPath)
-      ? ERROR_MESSAGE_REQUIRES_PARSER_SERVICES
-      : [
-          ERROR_MESSAGE_REQUIRES_PARSER_SERVICES,
-          ERROR_MESSAGE_UNKNOWN_PARSER,
-        ].join('\n'),
-  );
+  const messages = [
+    ERROR_MESSAGE_REQUIRES_PARSER_SERVICES,
+    `Parser: ${parserPath}`,
+  ];
+  if (!parserPathSeemsToBeTSESLint(parserPath)) {
+    messages.push(ERROR_MESSAGE_UNKNOWN_PARSER);
+  }
+  throw new Error(messages.join('\n'));
 }
 
 export { getParserServices };
diff --git a/packages/utils/tests/eslint-utils/getParserServices.test.ts b/packages/utils/tests/eslint-utils/getParserServices.test.ts
@@ -25,6 +25,16 @@ const createMockRuleContext = (
     ...overrides,
   }) as unknown as UnknownRuleContext;
 
+const requiresParserServicesMessageTemplate =
+  'You have used a rule which requires parserServices to be generated. You must therefore provide a value for the "parserOptions.project" property for @typescript-eslint/parser.\n' +
+  'Parser: \\S*';
+const baseErrorRegex = new RegExp(requiresParserServicesMessageTemplate);
+const unknownParserErrorRegex = new RegExp(
+  requiresParserServicesMessageTemplate +
+    '\n' +
+    'Note: detected a parser other than @typescript-eslint/parser. Make sure the parser is configured to forward "parserOptions.project" to @typescript-eslint/parser.',
+);
+
 describe('getParserServices', () => {
   it('throws a standard error when parserOptions.esTreeNodeToTSNodeMap is missing and the parser is known', () => {
     const context = createMockRuleContext({
@@ -38,9 +48,7 @@ describe('getParserServices', () => {
     });
 
     expect(() => ESLintUtils.getParserServices(context)).toThrow(
-      new Error(
-        'You have used a rule which requires parserServices to be generated. You must therefore provide a value for the "parserOptions.project" property for @typescript-eslint/parser.',
-      ),
+      baseErrorRegex,
     );
   });
 
@@ -55,12 +63,8 @@ describe('getParserServices', () => {
         },
       },
     });
-
     expect(() => ESLintUtils.getParserServices(context)).toThrow(
-      new Error(
-        'You have used a rule which requires parserServices to be generated. You must therefore provide a value for the "parserOptions.project" property for @typescript-eslint/parser.\n' +
-          'Note: detected a parser other than @typescript-eslint/parser. Make sure the parser is configured to forward "parserOptions.project" to @typescript-eslint/parser.',
-      ),
+      unknownParserErrorRegex,
     );
   });
 
@@ -76,9 +80,7 @@ describe('getParserServices', () => {
     });
 
     expect(() => ESLintUtils.getParserServices(context)).toThrow(
-      new Error(
-        'You have used a rule which requires parserServices to be generated. You must therefore provide a value for the "parserOptions.project" property for @typescript-eslint/parser.',
-      ),
+      baseErrorRegex,
     );
   });
 
@@ -94,9 +96,7 @@ describe('getParserServices', () => {
     });
 
     expect(() => ESLintUtils.getParserServices(context)).toThrow(
-      new Error(
-        'You have used a rule which requires parserServices to be generated. You must therefore provide a value for the "parserOptions.project" property for @typescript-eslint/parser.',
-      ),
+      baseErrorRegex,
     );
   });