Skip to content

⬅️ Back to Table of Contents

📄 shared.ts

📊 Analysis Summary

Metric Count
🔧 Functions 7
📦 Imports 4
📊 Variables & Constants 5
📐 Interfaces 2
📑 Type Aliases 2

📚 Table of Contents

🛠️ File Location:

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

📦 Imports

Name Source
Program typescript
CORE_COMPILER_OPTIONS @typescript-eslint/tsconfig-utils
path node:path
ParseSettings ../parseSettings

Variables & Constants

Name Type Kind Value Exported
DEFAULT_COMPILER_OPTIONS ts.CompilerOptions const `{
...CORE_COMPILER_OPTIONS,
allowJs: true,
allowNonTsExtensions: true,
checkJs: true,
}` ✗
DEFAULT_EXTRA_FILE_EXTENSIONS Set<string> const `new Set([
ts.Extension.Cjs,
ts.Extension.Cts,
ts.Extension.Js,
ts.Extension.Jsx,
ts.Extension.Mjs,
ts.Extension.Mts,
ts.Extension.Ts,
ts.Extension.Tsx,
])` ✓
useCaseSensitiveFileNames any const ts.sys !== undefined ? ts.sys.useCaseSensitiveFileNames : true ✗
correctPathCasing (filePath: string) => string const `useCaseSensitiveFileNames
? (filePath: string): string => filePath
: (filePath: string): string => filePath.toLowerCase()` ✗
DEFINITION_EXTENSIONS readonly [any, any, any] const `[
ts.Extension.Dts,
ts.Extension.Dcts,
ts.Extension.Dmts,
] as const` ✗

Functions

createDefaultCompilerOptionsFromExtra(parseSettings: ParseSettings): ts.CompilerOptions

Code 
export function createDefaultCompilerOptionsFromExtra(
  parseSettings: ParseSettings,
): ts.CompilerOptions {
  if (parseSettings.debugLevel.has('typescript')) {
    return {
      ...DEFAULT_COMPILER_OPTIONS,
      extendedDiagnostics: true,
    };
  }

  return DEFAULT_COMPILER_OPTIONS;
}
  • Parameters:
  • parseSettings: ParseSettings
  • Return Type: ts.CompilerOptions
  • Calls:
  • parseSettings.debugLevel.has

getCanonicalFileName(filePath: string): CanonicalPath

Code 
export function getCanonicalFileName(filePath: string): CanonicalPath {
  let normalized = path.normalize(filePath);
  if (normalized.endsWith(path.sep)) {
    normalized = normalized.slice(0, -1);
  }
  return correctPathCasing(normalized) as CanonicalPath;
}
  • Parameters:
  • filePath: string
  • Return Type: CanonicalPath
  • Calls:
  • path.normalize
  • normalized.endsWith
  • normalized.slice
  • correctPathCasing

ensureAbsolutePath(p: string, tsconfigRootDir: string): string

Code 
export function ensureAbsolutePath(p: string, tsconfigRootDir: string): string {
  return path.isAbsolute(p)
    ? p
    : path.join(tsconfigRootDir || process.cwd(), p);
}
  • Parameters:
  • p: string
  • tsconfigRootDir: string
  • Return Type: string
  • Calls:
  • path.isAbsolute
  • path.join
  • process.cwd

canonicalDirname(p: CanonicalPath): CanonicalPath

Code 
export function canonicalDirname(p: CanonicalPath): CanonicalPath {
  return path.dirname(p) as CanonicalPath;
}
  • Parameters:
  • p: CanonicalPath
  • Return Type: CanonicalPath
  • Calls:
  • path.dirname

getExtension(fileName: string | undefined): string | null

Code 
function getExtension(fileName: string | undefined): string | null {
  if (!fileName) {
    return null;
  }

  return (
    DEFINITION_EXTENSIONS.find(definitionExt =>
      fileName.endsWith(definitionExt),
    ) ?? path.extname(fileName)
  );
}
  • Parameters:
  • fileName: string | undefined
  • Return Type: string | null
  • Calls:
  • DEFINITION_EXTENSIONS.find
  • fileName.endsWith
  • path.extname

getAstFromProgram(currentProgram: Program, filePath: string): ASTAndDefiniteProgram | undefined

Code 
export function getAstFromProgram(
  currentProgram: Program,
  filePath: string,
): ASTAndDefiniteProgram | undefined {
  const ast = currentProgram.getSourceFile(filePath);

  // working around https://github.com/typescript-eslint/typescript-eslint/issues/1573
  const expectedExt = getExtension(filePath);
  const returnedExt = getExtension(ast?.fileName);
  if (expectedExt !== returnedExt) {
    return undefined;
  }

  return ast && { ast, program: currentProgram };
}
  • Parameters:
  • currentProgram: Program
  • filePath: string
  • Return Type: ASTAndDefiniteProgram | undefined
  • Calls:
  • currentProgram.getSourceFile
  • getExtension
  • Internal Comments: 
    // working around https://github.com/typescript-eslint/typescript-eslint/issues/1573 (x2)

createHash(content: string): string

Code 
export function createHash(content: string): string {
  // No ts.sys in browser environments.
  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
  if (ts.sys?.createHash) {
    return ts.sys.createHash(content);
  }
  return content;
}

  • JSDoc: 

    /**
 * Hash content for compare content.
 * @param content hashed contend
 * @returns hashed result
 */

  • Parameters:

  • content: string
  • Return Type: string
  • Calls:
  • ts.sys.createHash
  • Internal Comments: 
    // No ts.sys in browser environments.
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition

Interfaces

ASTAndNoProgram

Interface Code 
export interface ASTAndNoProgram {
  ast: ts.SourceFile;
  program: null;
}

Properties

Name Type Optional Description
ast ts.SourceFile ✗
program null ✗

ASTAndDefiniteProgram

Interface Code 
export interface ASTAndDefiniteProgram {
  ast: ts.SourceFile;
  program: ts.Program;
}

Properties

Name Type Optional Description
ast ts.SourceFile ✗
program ts.Program ✗

Type Aliases

ASTAndProgram

type ASTAndProgram = ASTAndDefiniteProgram | ASTAndNoProgram;

CanonicalPath

type CanonicalPath = { __brand: unknown } & string;