⬅️ Back to Table of Contents

📄 getWatchProgramsForProjects

📊 Analysis Summary

Metric	Count
🔧 Functions	9
📦 Imports	10
📊 Variables & Constants	7

📚 Table of Contents

• Imports
• Variables & Constants
• Functions

🛠️ File Location:

📂 packages/typescript-estree/src/create-program/getWatchProgramsForProjects.ts

📦 Imports

Name	Source
debug	debug
fs	node:fs
ParseSettings	../parseSettings
CanonicalPath	./shared
WatchCompilerHostOfConfigFile	./WatchCompilerHostOfConfigFile
getCodeText	../source-files
canonicalDirname	./shared
createDefaultCompilerOptionsFromExtra	./shared
createHash	./shared
getCanonicalFileName	./shared

---

Variables & Constants

Name	Type	Kind	Value	Exported
knownWatchProgramMap	Map<CanonicalPath, ts.WatchOfConfigFi...	const	new Map< CanonicalPath, ts.WatchOfConfigFile<ts.BuilderProgram> >()	✗
fileWatchCallbackTrackingMap	Map<CanonicalPath, Set<ts.FileWatcher...	const	new Map< CanonicalPath, Set<ts.FileWatcherCallback> >()	✗
folderWatchCallbackTrackingMap	Map<CanonicalPath, Set<ts.FileWatcher...	const	new Map< CanonicalPath, Set<ts.FileWatcherCallback> >()	✗
programFileListCache	Map<CanonicalPath, Set<CanonicalPath>>	const	new Map<CanonicalPath, Set<CanonicalPath>>()	✗
tsconfigLastModifiedTimesta...	Map<CanonicalPath, number>	const	new Map<CanonicalPath, number>()	✗
parsedFilesSeenHash	Map<CanonicalPath, string>	const	new Map<CanonicalPath, string>()	✗
currentLintOperationState	{ code: string \| ts.SourceFile; file...	const	{ code: '', filePath: '' as CanonicalPath, }	✗

---

Functions

clearWatchCaches(): void

Clear all of the parser caches. This should only be used in testing to ensure the parser is clean between tests.

Raw JSDoc

/**
 * Clear all of the parser caches.
 * This should only be used in testing to ensure the parser is clean between tests.
 */

Calls:

• knownWatchProgramMap.clear
• fileWatchCallbackTrackingMap.clear
• folderWatchCallbackTrackingMap.clear
• parsedFilesSeenHash.clear
• programFileListCache.clear
• tsconfigLastModifiedTimestampCache.clear

Code

export function clearWatchCaches(): void {
  knownWatchProgramMap.clear();
  fileWatchCallbackTrackingMap.clear();
  folderWatchCallbackTrackingMap.clear();
  parsedFilesSeenHash.clear();
  programFileListCache.clear();
  tsconfigLastModifiedTimestampCache.clear();
}

getWatchProgramsForProjects(parseSettings: ParseSettings): ts.Program[]

Calculate project environments using options provided by consumer and paths from config

Parameters:

• parseSettings any: Internal settings for parsing the file

Returns: undefined The programs corresponding to the supplied tsconfig paths

Raw JSDoc

/**
 * Calculate project environments using options provided by consumer and paths from config
 * @param parseSettings Internal settings for parsing the file
 * @returns The programs corresponding to the supplied tsconfig paths
 */

Calls:

• getCanonicalFileName (from ./shared)
• fileWatchCallbackTrackingMap.get
• createHash (from ./shared)
• getCodeText (from ../source-files)
• parsedFilesSeenHash.get
• fileWatchCallbacks.forEach
• cb
• knownWatchProgramMap.entries
• currentProjectsFromSettings.has
• programFileListCache.get
• existingWatch.getProgram().getProgram
• updateCachedFileList
• fileList.has
• log
• updatedProgram.getTypeChecker
• knownWatchProgramMap.get
• maybeInvalidateProgram
• results.push
• createWatchProgram
• knownWatchProgramMap.set
• programWatch.getProgram().getProgram
• program.getTypeChecker

Internal Comments:

// preserve reference to code and file being linted (x4)
// Update file version if necessary (x2)
/*
   * before we go into the process of attempting to find and update every program
   * see if we know of a program that contains this file
   */
// the current parser run doesn't specify this tsconfig in parserOptions.project
// so we don't want to consider it for caching purposes.
//
// if we did consider it we might return a program for a project
// that wasn't specified in the current parser run (which is obv bad!).
// sets parent pointers in source files (x12)
/*
   * We don't know of a program that contains the file, this means that either:
   * - the required program hasn't been created yet, or
   * - the file is new/renamed, and the program hasn't been updated.
   */
// cache and check the file list (x4)
// we can return early because we know this program contains the file (x2)

Code

export function getWatchProgramsForProjects(
  parseSettings: ParseSettings,
): ts.Program[] {
  const filePath = getCanonicalFileName(parseSettings.filePath);
  const results = [];

  // preserve reference to code and file being linted
  currentLintOperationState.code = parseSettings.code;
  currentLintOperationState.filePath = filePath;

  // Update file version if necessary
  const fileWatchCallbacks = fileWatchCallbackTrackingMap.get(filePath);
  const codeHash = createHash(getCodeText(parseSettings.code));
  if (
    parsedFilesSeenHash.get(filePath) !== codeHash &&
    fileWatchCallbacks &&
    fileWatchCallbacks.size > 0
  ) {
    fileWatchCallbacks.forEach(cb =>
      cb(filePath, ts.FileWatcherEventKind.Changed),
    );
  }

  const currentProjectsFromSettings = new Map(parseSettings.projects);

  /*
   * before we go into the process of attempting to find and update every program
   * see if we know of a program that contains this file
   */
  for (const [tsconfigPath, existingWatch] of knownWatchProgramMap.entries()) {
    if (!currentProjectsFromSettings.has(tsconfigPath)) {
      // the current parser run doesn't specify this tsconfig in parserOptions.project
      // so we don't want to consider it for caching purposes.
      //
      // if we did consider it we might return a program for a project
      // that wasn't specified in the current parser run (which is obv bad!).
      continue;
    }
    let fileList = programFileListCache.get(tsconfigPath);
    let updatedProgram: ts.Program | null = null;
    if (!fileList) {
      updatedProgram = existingWatch.getProgram().getProgram();
      fileList = updateCachedFileList(tsconfigPath, updatedProgram);
    }

    if (fileList.has(filePath)) {
      log('Found existing program for file. %s', filePath);

      updatedProgram ??= existingWatch.getProgram().getProgram();
      // sets parent pointers in source files
      updatedProgram.getTypeChecker();

      return [updatedProgram];
    }
  }
  log(
    'File did not belong to any existing programs, moving to create/update. %s',
    filePath,
  );

  /*
   * We don't know of a program that contains the file, this means that either:
   * - the required program hasn't been created yet, or
   * - the file is new/renamed, and the program hasn't been updated.
   */
  for (const tsconfigPath of parseSettings.projects) {
    const existingWatch = knownWatchProgramMap.get(tsconfigPath[0]);

    if (existingWatch) {
      const updatedProgram = maybeInvalidateProgram(
        existingWatch,
        filePath,
        tsconfigPath[0],
      );
      if (!updatedProgram) {
        continue;
      }

      // sets parent pointers in source files
      updatedProgram.getTypeChecker();

      // cache and check the file list
      const fileList = updateCachedFileList(tsconfigPath[0], updatedProgram);
      if (fileList.has(filePath)) {
        log('Found updated program for file. %s', filePath);
        // we can return early because we know this program contains the file
        return [updatedProgram];
      }

      results.push(updatedProgram);
      continue;
    }

    const programWatch = createWatchProgram(tsconfigPath[1], parseSettings);
    knownWatchProgramMap.set(tsconfigPath[0], programWatch);

    const program = programWatch.getProgram().getProgram();
    // sets parent pointers in source files
    program.getTypeChecker();

    // cache and check the file list
    const fileList = updateCachedFileList(tsconfigPath[0], program);
    if (fileList.has(filePath)) {
      log('Found program for file. %s', filePath);
      // we can return early because we know this program contains the file
      return [program];
    }

    results.push(program);
  }

  return results;
}

saveWatchCallback(trackingMap: Map<string, Set<ts.FileWatcherCallback>>): (fileName: string, callback: ts.FileWatcherCallback) => ts.…

Parameters:

• trackingMap Map<string, Set<ts.FileWatcherCallback>>

Returns: (fileName: string, callback: ts.FileWatcherCallback) => ts.FileWatcher

Calls:

• getCanonicalFileName (from ./shared)
• complex_call_2125
• trackingMap.get
• trackingMap.set
• watchers.add
• watchers.delete

Code

function saveWatchCallback(
  trackingMap: Map<string, Set<ts.FileWatcherCallback>>,
) {
  return (
    fileName: string,
    callback: ts.FileWatcherCallback,
  ): ts.FileWatcher => {
    const normalizedFileName = getCanonicalFileName(fileName);
    const watchers = ((): Set<ts.FileWatcherCallback> => {
      let watchers = trackingMap.get(normalizedFileName);
      if (!watchers) {
        watchers = new Set();
        trackingMap.set(normalizedFileName, watchers);
      }
      return watchers;
    })();
    watchers.add(callback);

    return {
      close: (): void => {
        watchers.delete(callback);
      },
    };
  };
}

diagnosticReporter(diagnostic: ts.Diagnostic): void

Appropriately report issues found when reading a config file

Parameters:

• diagnostic any: The diagnostic raised when creating a program

Raw JSDoc

/**
 * Appropriately report issues found when reading a config file
 * @param diagnostic The diagnostic raised when creating a program
 */

Calls:

• ts.flattenDiagnosticMessageText

Code

function diagnosticReporter(diagnostic: ts.Diagnostic): void {
  throw new Error(
    ts.flattenDiagnosticMessageText(diagnostic.messageText, ts.sys.newLine),
  );
}

updateCachedFileList(tsconfigPath: CanonicalPath, program: ts.Program): Set<CanonicalPath>

Parameters:

• tsconfigPath CanonicalPath
• program ts.Program

Returns: Set<CanonicalPath>

Calls:

• program.getRootFileNames().map
• getCanonicalFileName (from ./shared)
• programFileListCache.set

Code

function updateCachedFileList(
  tsconfigPath: CanonicalPath,
  program: ts.Program,
): Set<CanonicalPath> {
  const fileList = new Set(
    program.getRootFileNames().map(f => getCanonicalFileName(f)),
  );
  programFileListCache.set(tsconfigPath, fileList);
  return fileList;
}

createWatchProgram(tsconfigPath: string, parseSettings: ParseSettings): ts.WatchOfConfigFile<ts.BuilderProgram>

Parameters:

• tsconfigPath string
• parseSettings ParseSettings

Returns: ts.WatchOfConfigFile<ts.BuilderProgram>

Calls:

• log
• ts.createWatchCompilerHost
• createDefaultCompilerOptionsFromExtra (from ./shared)
• getCanonicalFileName (from ./shared)
• getCodeText (from ../source-files)
• oldReadFile
• parsedFilesSeenHash.set
• createHash (from ./shared)
• program .getConfigFileParsingDiagnostics() .filter
• diagnosticReporter
• saveWatchCallback
• oldReadDirectory
• oldOnDirectoryStructureHostCreate
• parseSettings.extraFileExtensions.map
• ts.createWatchProgram

Internal Comments:

// create compiler host (x2)
// TODO: file issue on TypeScript to suggest making optional?
// eslint-disable-next-line @typescript-eslint/no-empty-function
/*reportWatchStatus*/
// ensure readFile reads the code being linted instead of the copy on disk (x2)
// ensure process reports error on failure instead of exiting process immediately (x4)
// ensure process doesn't emit programs (x4)
// report error if there are any errors in the config file (x2)
/*
   * From the CLI, the file watchers won't matter, as the files will be parsed once and then forgotten.
   * When running from an IDE, these watchers will let us tell typescript about changes.
   *
   * ESLint IDE plugins will send us unfinished file content as the user types (before it's saved to disk).
   * We use the file watchers to tell typescript about this latest file content.
   *
   * When files are created (or renamed), we won't know about them because we have no filesystem watchers attached.
   * We use the folder watchers to tell typescript it needs to go and find new files in the project folders.
   */ (x4)
// allow files with custom extensions to be included in program (uses internal ts api) (x2)
// This works only on 3.9 (x4)
// Since we don't want to asynchronously update program we want to disable timeout methods (x4)
// So any changes in the program will be delayed and updated when getProgram is called on watch (x4)

Code

function createWatchProgram(
  tsconfigPath: string,
  parseSettings: ParseSettings,
): ts.WatchOfConfigFile<ts.BuilderProgram> {
  log('Creating watch program for %s.', tsconfigPath);

  // create compiler host
  const watchCompilerHost = ts.createWatchCompilerHost(
    tsconfigPath,
    createDefaultCompilerOptionsFromExtra(parseSettings),
    ts.sys,
    ts.createAbstractBuilder,
    diagnosticReporter,
    // TODO: file issue on TypeScript to suggest making optional?
    // eslint-disable-next-line @typescript-eslint/no-empty-function
    /*reportWatchStatus*/ () => {},
  ) as WatchCompilerHostOfConfigFile<ts.BuilderProgram>;
  watchCompilerHost.jsDocParsingMode = parseSettings.jsDocParsingMode;

  // ensure readFile reads the code being linted instead of the copy on disk
  const oldReadFile = watchCompilerHost.readFile;
  watchCompilerHost.readFile = (filePathIn, encoding): string | undefined => {
    const filePath = getCanonicalFileName(filePathIn);
    const fileContent =
      filePath === currentLintOperationState.filePath
        ? getCodeText(currentLintOperationState.code)
        : oldReadFile(filePath, encoding);
    if (fileContent != null) {
      parsedFilesSeenHash.set(filePath, createHash(fileContent));
    }
    return fileContent;
  };

  // ensure process reports error on failure instead of exiting process immediately
  watchCompilerHost.onUnRecoverableConfigFileDiagnostic = diagnosticReporter;

  // ensure process doesn't emit programs
  watchCompilerHost.afterProgramCreate = (program): void => {
    // report error if there are any errors in the config file
    const configFileDiagnostics = program
      .getConfigFileParsingDiagnostics()
      .filter(
        diag =>
          diag.category === ts.DiagnosticCategory.Error && diag.code !== 18003,
      );
    if (configFileDiagnostics.length > 0) {
      diagnosticReporter(configFileDiagnostics[0]);
    }
  };

  /*
   * From the CLI, the file watchers won't matter, as the files will be parsed once and then forgotten.
   * When running from an IDE, these watchers will let us tell typescript about changes.
   *
   * ESLint IDE plugins will send us unfinished file content as the user types (before it's saved to disk).
   * We use the file watchers to tell typescript about this latest file content.
   *
   * When files are created (or renamed), we won't know about them because we have no filesystem watchers attached.
   * We use the folder watchers to tell typescript it needs to go and find new files in the project folders.
   */
  watchCompilerHost.watchFile = saveWatchCallback(fileWatchCallbackTrackingMap);
  watchCompilerHost.watchDirectory = saveWatchCallback(
    folderWatchCallbackTrackingMap,
  );

  // allow files with custom extensions to be included in program (uses internal ts api)
  const oldOnDirectoryStructureHostCreate =
    watchCompilerHost.onCachedDirectoryStructureHostCreate;
  watchCompilerHost.onCachedDirectoryStructureHostCreate = (host): void => {
    const oldReadDirectory = host.readDirectory;
    host.readDirectory = (
      path,
      extensions,
      exclude,
      include,
      depth,
    ): string[] =>
      oldReadDirectory(
        path,
        !extensions
          ? undefined
          : [...extensions, ...parseSettings.extraFileExtensions],
        exclude,
        include,
        depth,
      );
    oldOnDirectoryStructureHostCreate(host);
  };
  // This works only on 3.9
  watchCompilerHost.extraFileExtensions = parseSettings.extraFileExtensions.map(
    extension => ({
      extension,
      isMixedContent: true,
      scriptKind: ts.ScriptKind.Deferred,
    }),
  );
  watchCompilerHost.trace = log;

  // Since we don't want to asynchronously update program we want to disable timeout methods
  // So any changes in the program will be delayed and updated when getProgram is called on watch
  watchCompilerHost.setTimeout = undefined;
  watchCompilerHost.clearTimeout = undefined;
  return ts.createWatchProgram(watchCompilerHost);
}

hasTSConfigChanged(tsconfigPath: CanonicalPath): boolean

Parameters:

• tsconfigPath CanonicalPath

Returns: boolean

Calls:

• fs.statSync
• tsconfigLastModifiedTimestampCache.get
• tsconfigLastModifiedTimestampCache.set
• Math.abs

Code

function hasTSConfigChanged(tsconfigPath: CanonicalPath): boolean {
  const stat = fs.statSync(tsconfigPath);
  const lastModifiedAt = stat.mtimeMs;
  const cachedLastModifiedAt =
    tsconfigLastModifiedTimestampCache.get(tsconfigPath);

  tsconfigLastModifiedTimestampCache.set(tsconfigPath, lastModifiedAt);

  if (cachedLastModifiedAt == null) {
    return false;
  }

  return Math.abs(cachedLastModifiedAt - lastModifiedAt) > Number.EPSILON;
}

maybeInvalidateProgram(existingWatch: ts.WatchOfConfigFile<ts.BuilderProgram>, filePath: CanonicalPath, tsconfigPath: CanonicalPath): ts.Program | null

Parameters:

• existingWatch ts.WatchOfConfigFile<ts.BuilderProgram>
• filePath CanonicalPath
• tsconfigPath CanonicalPath

Returns: ts.Program | null

Calls:

• existingWatch.getProgram().getProgram
• hasTSConfigChanged
• log
• fileWatchCallbackTrackingMap .get(tsconfigPath)! .forEach
• cb
• programFileListCache.delete
• updatedProgram.getSourceFile
• canonicalDirname (from ./shared)
• folderWatchCallbackTrackingMap.get
• updatedProgram.getRootFileNames
• rootFilenames.find
• fs.existsSync
• fileWatchCallbackTrackingMap.get
• getCanonicalFileName (from ./shared)
• fileWatchCallbacks.forEach

Internal Comments:

/*
   * By calling watchProgram.getProgram(), it will trigger a resync of the program based on
   * whatever new file content we've given it from our input.
   */ (x2)
// In case this change causes problems in larger real world codebases
// Provide an escape hatch so people don't _have_ to revert to an older version
/*
     * If the stat of the tsconfig has changed, that could mean the include/exclude/files lists has changed
     * We need to make sure typescript knows this so it can update appropriately
     */ (x3)
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion (x7)
// tsconfig change means that the file list more than likely changed, so clear the cache (x4)
/*
   * Missing source file means our program's folder structure might be out of date.
   * So we need to tell typescript it needs to update the correct folder.
   */ (x3)
// Find the correct directory callback by climbing the folder tree (x2)
/*
     * No callback means the paths don't matchup - so no point returning any program
     * this will signal to the caller to skip this program
     */ (x3)
// directory update means that the file list more than likely changed, so clear the cache (x4)
// force the immediate resync (x3)
/*
   * At this point we're in one of two states:
   * - The file isn't supposed to be in this program due to exclusions
   * - The file is new, and was renamed from an old, included filename
   *
   * For the latter case, we need to tell typescript that the old filename is now deleted
   */ (x3)
// use find because we only need to "delete" one file to cause typescript to do a full resync (x2)
// There are no deleted files, so it must be the former case of the file not belonging to this program
// shouldn't happen, but just in case (x3)
// deleted files means that the file list _has_ changed, so clear the cache (x4)

Code

function maybeInvalidateProgram(
  existingWatch: ts.WatchOfConfigFile<ts.BuilderProgram>,
  filePath: CanonicalPath,
  tsconfigPath: CanonicalPath,
): ts.Program | null {
  /*
   * By calling watchProgram.getProgram(), it will trigger a resync of the program based on
   * whatever new file content we've given it from our input.
   */
  let updatedProgram = existingWatch.getProgram().getProgram();

  // In case this change causes problems in larger real world codebases
  // Provide an escape hatch so people don't _have_ to revert to an older version
  if (process.env.TSESTREE_NO_INVALIDATION === 'true') {
    return updatedProgram;
  }

  if (hasTSConfigChanged(tsconfigPath)) {
    /*
     * If the stat of the tsconfig has changed, that could mean the include/exclude/files lists has changed
     * We need to make sure typescript knows this so it can update appropriately
     */
    log('tsconfig has changed - triggering program update. %s', tsconfigPath);
    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
    fileWatchCallbackTrackingMap
      .get(tsconfigPath)!
      .forEach(cb => cb(tsconfigPath, ts.FileWatcherEventKind.Changed));

    // tsconfig change means that the file list more than likely changed, so clear the cache
    programFileListCache.delete(tsconfigPath);
  }

  let sourceFile = updatedProgram.getSourceFile(filePath);
  if (sourceFile) {
    return updatedProgram;
  }
  /*
   * Missing source file means our program's folder structure might be out of date.
   * So we need to tell typescript it needs to update the correct folder.
   */
  log('File was not found in program - triggering folder update. %s', filePath);

  // Find the correct directory callback by climbing the folder tree
  const currentDir = canonicalDirname(filePath);
  let current: CanonicalPath | null = null;
  let next = currentDir;
  let hasCallback = false;
  while (current !== next) {
    current = next;
    const folderWatchCallbacks = folderWatchCallbackTrackingMap.get(current);
    if (folderWatchCallbacks) {
      for (const cb of folderWatchCallbacks) {
        if (currentDir !== current) {
          cb(currentDir, ts.FileWatcherEventKind.Changed);
        }
        cb(current, ts.FileWatcherEventKind.Changed);
      }
      hasCallback = true;
    }

    next = canonicalDirname(current);
  }
  if (!hasCallback) {
    /*
     * No callback means the paths don't matchup - so no point returning any program
     * this will signal to the caller to skip this program
     */
    log('No callback found for file, not part of this program. %s', filePath);
    return null;
  }

  // directory update means that the file list more than likely changed, so clear the cache
  programFileListCache.delete(tsconfigPath);

  // force the immediate resync
  updatedProgram = existingWatch.getProgram().getProgram();
  sourceFile = updatedProgram.getSourceFile(filePath);
  if (sourceFile) {
    return updatedProgram;
  }

  /*
   * At this point we're in one of two states:
   * - The file isn't supposed to be in this program due to exclusions
   * - The file is new, and was renamed from an old, included filename
   *
   * For the latter case, we need to tell typescript that the old filename is now deleted
   */
  log(
    'File was still not found in program after directory update - checking file deletions. %s',
    filePath,
  );

  const rootFilenames = updatedProgram.getRootFileNames();
  // use find because we only need to "delete" one file to cause typescript to do a full resync
  const deletedFile = rootFilenames.find(file => !fs.existsSync(file));
  if (!deletedFile) {
    // There are no deleted files, so it must be the former case of the file not belonging to this program
    return null;
  }

  const fileWatchCallbacks = fileWatchCallbackTrackingMap.get(
    getCanonicalFileName(deletedFile),
  );
  if (!fileWatchCallbacks) {
    // shouldn't happen, but just in case
    log('Could not find watch callbacks for root file. %s', deletedFile);
    return updatedProgram;
  }

  log('Marking file as deleted. %s', deletedFile);
  fileWatchCallbacks.forEach(cb =>
    cb(deletedFile, ts.FileWatcherEventKind.Deleted),
  );

  // deleted files means that the file list _has_ changed, so clear the cache
  programFileListCache.delete(tsconfigPath);

  updatedProgram = existingWatch.getProgram().getProgram();
  sourceFile = updatedProgram.getSourceFile(filePath);
  if (sourceFile) {
    return updatedProgram;
  }

  log(
    'File was still not found in program after deletion check, assuming it is not part of this program. %s',
    filePath,
  );
  return null;
}

Internal helpers

Declared inside another function in this file.

close(): void

Returns: void

Calls:

• watchers.delete

Code

(): void => {
        watchers.delete(callback);
      }

---

Generated by Syntax Scribe