⬅️ Back to Table of Contents

📄 useProvidedPrograms

📊 Analysis Summary

Metric	Count
🔧 Functions	2
📦 Imports	5

📚 Table of Contents

• Imports
• Functions

🛠️ File Location:

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

📦 Imports

Name	Source
getParsedConfigFile	@typescript-eslint/tsconfig-utils
debug	debug
ParseSettings	../parseSettings
ASTAndDefiniteProgram	./shared
getAstFromProgram	./shared

---

Functions

useProvidedPrograms(programInstances: Iterable<ts.Program>, parseSettings: ParseSettings): ASTAndDefiniteProgram

Parameters:

• programInstances Iterable<ts.Program>
• parseSettings ParseSettings

Returns: ASTAndDefiniteProgram

Calls:

• log
• getAstFromProgram (from ./shared)
• astAndProgram.program.getTypeChecker
• path.relative
• errorLines.join

Internal Comments:

// Stop at the first applicable program instance

Code

export function useProvidedPrograms(
  programInstances: Iterable<ts.Program>,
  parseSettings: ParseSettings,
): ASTAndDefiniteProgram {
  log(
    'Retrieving ast for %s from provided program instance(s)',
    parseSettings.filePath,
  );

  let astAndProgram: ASTAndDefiniteProgram | undefined;
  for (const programInstance of programInstances) {
    astAndProgram = getAstFromProgram(programInstance, parseSettings.filePath);
    // Stop at the first applicable program instance
    if (astAndProgram) {
      break;
    }
  }

  if (astAndProgram) {
    astAndProgram.program.getTypeChecker(); // ensure parent pointers are set in source files
    return astAndProgram;
  }

  const relativeFilePath = path.relative(
    parseSettings.tsconfigRootDir,
    parseSettings.filePath,
  );

  const [typeSource, typeSources] =
    parseSettings.projects.size > 0
      ? ['project', 'project(s)']
      : ['programs', 'program instance(s)'];

  const errorLines = [
    `"parserOptions.${typeSource}" has been provided for @typescript-eslint/parser.`,
    `The file was not found in any of the provided ${typeSources}: ${relativeFilePath}`,
  ];

  throw new Error(errorLines.join('\n'));
}

createProgramFromConfigFile(configFile: string, projectDirectory: string): ts.Program

Utility offered by parser to help consumers construct their own program instance.

Parameters:

• configFile any: the path to the tsconfig.json file, relative to projectDirectory
• projectDirectory any: the project directory to use as the CWD, defaults to process.cwd()

Raw JSDoc

/**
 * Utility offered by parser to help consumers construct their own program instance.
 *
 * @param configFile the path to the tsconfig.json file, relative to `projectDirectory`
 * @param projectDirectory the project directory to use as the CWD, defaults to `process.cwd()`
 */

Calls:

• getParsedConfigFile (from @typescript-eslint/tsconfig-utils)
• ts.createCompilerHost
• ts.createProgram

Code

export function createProgramFromConfigFile(
  configFile: string,
  projectDirectory?: string,
): ts.Program {
  const parsed = getParsedConfigFile(ts, configFile, projectDirectory);
  const host = ts.createCompilerHost(parsed.options, true);
  return ts.createProgram(parsed.fileNames, parsed.options, host);
}

---

Generated by Syntax Scribe