feat(typescript-estree): add debug logs for useProgramFromProjectService (typescript-eslint#8426)

JoshuaKGoldberg · web-flow · commit 8431d9d396ee · 2024-02-23T07:50:15.000-05:00
* feat(typescript-estree): add debug logs for useProgramFromProjectService

* Added a bit more around filePathMatchedBy

* Update packages/typescript-estree/src/useProgramFromProjectService.ts
diff --git a/packages/typescript-estree/src/useProgramFromProjectService.ts b/packages/typescript-estree/src/useProgramFromProjectService.ts
@@ -1,3 +1,4 @@
+import debug from 'debug';
 import { minimatch } from 'minimatch';
 
 import { createProjectProgram } from './create-program/createProjectProgram';
@@ -9,12 +10,17 @@ import {
 } from './create-program/shared';
 import type { MutableParseSettings } from './parseSettings';
 
+const log = debug(
+  'typescript-eslint:typescript-estree:useProgramFromProjectService',
+);
+
 export function useProgramFromProjectService(
   { allowDefaultProjectForFiles, service }: ProjectServiceSettings,
   parseSettings: Readonly<MutableParseSettings>,
   hasFullTypeInformation: boolean,
 ): ASTAndDefiniteProgram | undefined {
   const filePath = getCanonicalFileName(parseSettings.filePath);
+  log('Opening project service file for: %s', filePath);
 
   const opened = service.openClientFile(
     ensureAbsolutePath(filePath, service.host.getCurrentDirectory()),
@@ -23,7 +29,14 @@ export function useProgramFromProjectService(
     parseSettings.tsconfigRootDir,
   );
 
+  log('Opened project service file: %o', opened);
+
   if (hasFullTypeInformation) {
+    log(
+      'Project service type information enabled; checking for file path match on: %o',
+      allowDefaultProjectForFiles,
+    );
+
     if (opened.configFileName) {
       if (filePathMatchedBy(filePath, allowDefaultProjectForFiles)) {
         throw new Error(
@@ -37,16 +50,21 @@ export function useProgramFromProjectService(
     }
   }
 
+  log('Retrieving script info and then program for: %s', filePath);
+
   const scriptInfo = service.getScriptInfo(filePath);
   const program = service
     .getDefaultProjectForFile(scriptInfo!.fileName, true)!
     .getLanguageService(/*ensureSynchronized*/ true)
     .getProgram();
 
   if (!program) {
+    log('Could not find project service program for: %s', filePath);
     return undefined;
   }
 
+  log('Found project service program for: %s', filePath);
+
   return createProjectProgram(parseSettings, [program]);
 }
 
