feat(typescript-estree): skip isTTY version check if user passes `l…

…oggerFn` on unsupported TypeScript version warning (#7739)
typescript-eslint · Nov 11, 2023 · 9656e13 · 9656e13
1 parent be2777c
commit 9656e13
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 21 deletions.
diff --git a/packages/typescript-estree/src/parseSettings/createParseSettings.ts b/packages/typescript-estree/src/parseSettings/createParseSettings.ts
@@ -33,6 +33,7 @@ export function createParseSettings(
     typeof options.tsconfigRootDir === 'string'
       ? options.tsconfigRootDir
       : process.cwd();
+  const passedLoggerFn = typeof options.loggerFn === 'function';
   const parseSettings: MutableParseSettings = {
     allowInvalidAST: options.allowInvalidAST === true,
     code,
@@ -135,7 +136,7 @@ export function createParseSettings(
     });
   }
 
-  warnAboutTSVersion(parseSettings);
+  warnAboutTSVersion(parseSettings, passedLoggerFn);
 
   return parseSettings;
 }

diff --git a/packages/typescript-estree/src/parseSettings/warnAboutTSVersion.ts b/packages/typescript-estree/src/parseSettings/warnAboutTSVersion.ts
@@ -23,23 +23,31 @@ const isRunningSupportedTypeScriptVersion = semver.satisfies(
 
 let warnedAboutTSVersion = false;
 
-export function warnAboutTSVersion(parseSettings: ParseSettings): void {
-  if (!isRunningSupportedTypeScriptVersion && !warnedAboutTSVersion) {
-    const isTTY =
-      typeof process === 'undefined' ? false : process.stdout?.isTTY;
-    if (isTTY) {
-      const border = '=============';
-      const versionWarning = [
-        border,
-        'WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree.',
-        'You may find that it works just fine, or you may not.',
-        `SUPPORTED TYPESCRIPT VERSIONS: ${SUPPORTED_TYPESCRIPT_VERSIONS}`,
-        `YOUR TYPESCRIPT VERSION: ${ACTIVE_TYPESCRIPT_VERSION}`,
-        'Please only submit bug reports when using the officially supported version.',
-        border,
-      ];
-      parseSettings.log(versionWarning.join('\n\n'));
-    }
-    warnedAboutTSVersion = true;
+export function warnAboutTSVersion(
+  parseSettings: ParseSettings,
+  passedLoggerFn: boolean,
+): void {
+  if (isRunningSupportedTypeScriptVersion || warnedAboutTSVersion) {
+    return;
   }
+
+  if (
+    passedLoggerFn ||
+    (typeof process === 'undefined' ? false : process.stdout?.isTTY)
+  ) {
+    const border = '=============';
+    const versionWarning = [
+      border,
+      'WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree.',
+      'You may find that it works just fine, or you may not.',
+      `SUPPORTED TYPESCRIPT VERSIONS: ${SUPPORTED_TYPESCRIPT_VERSIONS}`,
+      `YOUR TYPESCRIPT VERSION: ${ACTIVE_TYPESCRIPT_VERSION}`,
+      'Please only submit bug reports when using the officially supported version.',
+      border,
+    ].join('\n\n');
+
+    parseSettings.log(versionWarning);
+  }
+
+  warnedAboutTSVersion = true;
 }
diff --git a/packages/typescript-estree/tests/lib/warn-on-unsupported-ts.test.ts b/packages/typescript-estree/tests/lib/warn-on-unsupported-ts.test.ts
@@ -1,12 +1,18 @@
 import semver from 'semver';
 
-import * as parser from '../../src/parser';
+import type * as Parser from '../../src/parser';
 
 jest.mock('semver');
 
 const resetIsTTY = process.stdout.isTTY;
 
 describe('Warn on unsupported TypeScript version', () => {
+  let parser: typeof Parser;
+
+  beforeEach(async () => {
+    // @ts-expect-error -- We don't support ESM imports of local code yet.
+    parser = await import('../../src/parser');
+  });
   afterEach(() => {
     jest.resetModules();
     jest.resetAllMocks();
@@ -26,7 +32,18 @@ describe('Warn on unsupported TypeScript version', () => {
     );
   });
 
-  it('should not warn the user when the user is running on a non TTY process', () => {
+  it('should warn the user if they are running on a non TTY process and a custom loggerFn was passed', () => {
+    (semver.satisfies as jest.Mock).mockReturnValue(false);
+    const loggerFn = jest.fn();
+    process.stdout.isTTY = false;
+
+    parser.parse('', {
+      loggerFn,
+    });
+    expect(loggerFn).toHaveBeenCalled();
+  });
+
+  it('should not warn the user if they are running on a non TTY process and a custom loggerFn was not passed', () => {
     (semver.satisfies as jest.Mock).mockReturnValue(false);
     jest.spyOn(console, 'log').mockImplementation();
     process.stdout.isTTY = false;