236 lines
11 KiB
TypeScript
236 lines
11 KiB
TypeScript
|
import type * as typescript from 'typescript';
|
|||
|
|
import { Chalk } from 'chalk';
|
|||
|
|
import * as logger from './logger';
|
|||
|
|
export interface ErrorInfo {
|
|||
|
|
code: number;
|
|||
|
|
severity: Severity;
|
|||
|
|
content: string;
|
|||
|
|
file: string;
|
|||
|
|
line: number;
|
|||
|
|
character: number;
|
|||
|
|
context: string;
|
|||
|
|
}
|
|||
|
|
export type FileLocation = {
|
|||
|
|
/** 1-based */
|
|||
|
|
line: number;
|
|||
|
|
/** 1-based */
|
|||
|
|
character: number;
|
|||
|
|
};
|
|||
|
|
export interface HostMayBeCacheable {
|
|||
|
|
clearCache?(): void;
|
|||
|
|
fileExistsCache?: Map<string, boolean>;
|
|||
|
|
directoryExistsCache?: Map<string, boolean>;
|
|||
|
|
realpathCache?: Map<string, string>;
|
|||
|
|
}
|
|||
|
|
export interface CacheableHost extends HostMayBeCacheable {
|
|||
|
|
fileExists: typescript.ModuleResolutionHost['fileExists'];
|
|||
|
|
directoryExists: NonNullable<typescript.ModuleResolutionHost['directoryExists']>;
|
|||
|
|
realpath?: typescript.ModuleResolutionHost['realpath'];
|
|||
|
|
}
|
|||
|
|
export interface ModuleResolutionHostMayBeCacheable extends typescript.ModuleResolutionHost, HostMayBeCacheable {
|
|||
|
|
readFile(filePath: string, encoding?: string): string | undefined;
|
|||
|
|
trace: NonNullable<typescript.ModuleResolutionHost['trace']>;
|
|||
|
|
directoryExists: NonNullable<typescript.ModuleResolutionHost['directoryExists']>;
|
|||
|
|
getCurrentDirectory: NonNullable<typescript.ModuleResolutionHost['getCurrentDirectory']>;
|
|||
|
|
getDirectories: NonNullable<typescript.ModuleResolutionHost['getDirectories']>;
|
|||
|
|
useCaseSensitiveFileNames: NonNullable<typescript.LanguageServiceHost['useCaseSensitiveFileNames']>;
|
|||
|
|
getNewLine: NonNullable<typescript.LanguageServiceHost['getNewLine']>;
|
|||
|
|
getDefaultLibFileName: NonNullable<typescript.LanguageServiceHost['getDefaultLibFileName']>;
|
|||
|
|
readDirectory: NonNullable<typescript.LanguageServiceHost['readDirectory']>;
|
|||
|
|
}
|
|||
|
|
export interface ServiceHostWhichMayBeCacheable extends typescript.LanguageServiceHost, HostMayBeCacheable {
|
|||
|
|
}
|
|||
|
|
export interface WatchHost extends typescript.WatchCompilerHostOfFilesAndCompilerOptions<typescript.EmitAndSemanticDiagnosticsBuilderProgram>, HostMayBeCacheable {
|
|||
|
|
invokeFileWatcher: WatchFactory['invokeFileWatcher'];
|
|||
|
|
updateRootFileNames(): void;
|
|||
|
|
outputFiles: Map<FilePathKey, typescript.OutputFile[]>;
|
|||
|
|
tsbuildinfo?: typescript.OutputFile;
|
|||
|
|
}
|
|||
|
|
export type WatchCallbacks<T> = Map<FilePathKey, {
|
|||
|
|
fileName: string;
|
|||
|
|
callbacks: T[];
|
|||
|
|
}>;
|
|||
|
|
export interface WatchFactory {
|
|||
|
|
watchedFiles: WatchCallbacks<typescript.FileWatcherCallback>;
|
|||
|
|
watchedDirectories: WatchCallbacks<typescript.DirectoryWatcherCallback>;
|
|||
|
|
watchedDirectoriesRecursive: WatchCallbacks<typescript.DirectoryWatcherCallback>;
|
|||
|
|
invokeFileWatcher(fileName: string, eventKind: typescript.FileWatcherEventKind): boolean;
|
|||
|
|
/** Used to watch changes in source files, missing files needed to update the program or config file */
|
|||
|
|
watchFile: typescript.WatchHost['watchFile'];
|
|||
|
|
/** Used to watch resolved module's failed lookup locations, config file specs, type roots where auto type reference directives are added */
|
|||
|
|
watchDirectory: typescript.WatchHost['watchDirectory'];
|
|||
|
|
}
|
|||
|
|
export interface SolutionDiagnostics {
|
|||
|
|
global: typescript.Diagnostic[];
|
|||
|
|
perFile: Map<FilePathKey, typescript.Diagnostic[]>;
|
|||
|
|
transpileErrors: [FilePathKey | undefined, typescript.Diagnostic[]][];
|
|||
|
|
}
|
|||
|
|
export type FilePathKey = string & {
|
|||
|
|
__filePathKeyBrand: any;
|
|||
|
|
};
|
|||
|
|
export interface SolutionBuilderWithWatchHost extends typescript.SolutionBuilderWithWatchHost<typescript.EmitAndSemanticDiagnosticsBuilderProgram>, WatchFactory {
|
|||
|
|
diagnostics: SolutionDiagnostics;
|
|||
|
|
writtenFiles: typescript.OutputFile[];
|
|||
|
|
configFileInfo: Map<FilePathKey, ConfigFileInfo>;
|
|||
|
|
outputAffectingInstanceVersion: Map<FilePathKey, true>;
|
|||
|
|
getInputFileStamp(fileName: string): Date;
|
|||
|
|
updateSolutionBuilderInputFile(fileName: string): void;
|
|||
|
|
getOutputFileKeyFromReferencedProject(outputFileName: string): FilePathKey | undefined;
|
|||
|
|
getOutputFileAndKeyFromReferencedProject(oututFileName: string): {
|
|||
|
|
key: FilePathKey;
|
|||
|
|
outputFile: string | false;
|
|||
|
|
} | undefined;
|
|||
|
|
getOutputFileTextAndKeyFromReferencedProject(oututFileName: string): {
|
|||
|
|
key: FilePathKey;
|
|||
|
|
text: string | undefined;
|
|||
|
|
} | undefined;
|
|||
|
|
getInputFileNameFromOutput(outputFileName: string): string | undefined;
|
|||
|
|
getOutputFilesFromReferencedProjectInput(inputFileName: string): typescript.OutputFile[];
|
|||
|
|
buildReferences(): void;
|
|||
|
|
ensureAllReferenceTimestamps(): void;
|
|||
|
|
clearCache(): void;
|
|||
|
|
close(): void;
|
|||
|
|
}
|
|||
|
|
export interface ConfigFileInfo {
|
|||
|
|
config: typescript.ParsedCommandLine | undefined;
|
|||
|
|
outputFileNames?: Map<FilePathKey, {
|
|||
|
|
inputFileName: string;
|
|||
|
|
outputNames: string[];
|
|||
|
|
}>;
|
|||
|
|
tsbuildInfoFile?: string;
|
|||
|
|
dtsFiles?: string[];
|
|||
|
|
}
|
|||
|
|
interface CacheWithRedirects<T> {
|
|||
|
|
ownMap: Map<string, T>;
|
|||
|
|
redirectsMap: Map<typescript.Path, Map<string, T>>;
|
|||
|
|
getOrCreateMapOfCacheRedirects(redirectedReference: typescript.ResolvedProjectReference | undefined): Map<string, T>;
|
|||
|
|
clear(): void;
|
|||
|
|
setOwnOptions(newOptions: typescript.CompilerOptions): void;
|
|||
|
|
setOwnMap(newOwnMap: Map<string, T>): void;
|
|||
|
|
}
|
|||
|
|
interface PerModuleNameCache {
|
|||
|
|
get(directory: string): typescript.ResolvedModuleWithFailedLookupLocations | undefined;
|
|||
|
|
set(directory: string, result: typescript.ResolvedModuleWithFailedLookupLocations): void;
|
|||
|
|
}
|
|||
|
|
export interface ModuleResolutionCache extends typescript.ModuleResolutionCache {
|
|||
|
|
directoryToModuleNameMap: CacheWithRedirects<Map<string, typescript.ResolvedModuleWithFailedLookupLocations>>;
|
|||
|
|
moduleNameToDirectoryMap: CacheWithRedirects<PerModuleNameCache>;
|
|||
|
|
clear(): void;
|
|||
|
|
update(compilerOptions: typescript.CompilerOptions): void;
|
|||
|
|
}
|
|||
|
|
export interface TSInstance {
|
|||
|
|
compiler: typeof typescript;
|
|||
|
|
compilerOptions: typescript.CompilerOptions;
|
|||
|
|
/** Used for Vue for the most part */
|
|||
|
|
appendTsTsxSuffixesIfRequired: (filePath: string) => string;
|
|||
|
|
loaderOptions: LoaderOptions;
|
|||
|
|
rootFileNames: Set<string>;
|
|||
|
|
moduleResolutionCache?: ModuleResolutionCache;
|
|||
|
|
typeReferenceResolutionCache?: typescript.TypeReferenceDirectiveResolutionCache;
|
|||
|
|
/**
|
|||
|
|
* a cache of all the files
|
|||
|
|
*/
|
|||
|
|
files: TSFiles;
|
|||
|
|
/**
|
|||
|
|
* contains the modified files - cleared each time after-compile is called
|
|||
|
|
*/
|
|||
|
|
modifiedFiles?: Map<FilePathKey, true>;
|
|||
|
|
/**
|
|||
|
|
* Paths to project references that are missing source maps.
|
|||
|
|
* Cleared each time after-compile is called. Used to dedupe
|
|||
|
|
* warnings about source maps during a single compilation.
|
|||
|
|
*/
|
|||
|
|
projectsMissingSourceMaps?: Set<string>;
|
|||
|
|
servicesHost?: ServiceHostWhichMayBeCacheable;
|
|||
|
|
languageService?: typescript.LanguageService | null;
|
|||
|
|
version: number;
|
|||
|
|
dependencyGraph: DependencyGraph;
|
|||
|
|
filesWithErrors?: TSFiles;
|
|||
|
|
transformers: typescript.CustomTransformers;
|
|||
|
|
colors: Chalk;
|
|||
|
|
otherFiles: TSFiles;
|
|||
|
|
watchHost?: WatchHost;
|
|||
|
|
watchOfFilesAndCompilerOptions?: typescript.WatchOfFilesAndCompilerOptions<typescript.EmitAndSemanticDiagnosticsBuilderProgram>;
|
|||
|
|
builderProgram?: typescript.EmitAndSemanticDiagnosticsBuilderProgram;
|
|||
|
|
program?: typescript.Program;
|
|||
|
|
hasUnaccountedModifiedFiles?: boolean;
|
|||
|
|
changedFilesList?: boolean;
|
|||
|
|
reportTranspileErrors?: boolean;
|
|||
|
|
solutionBuilderHost?: SolutionBuilderWithWatchHost;
|
|||
|
|
configFilePath: string | undefined;
|
|||
|
|
filePathKeyMapper: (fileName: string) => FilePathKey;
|
|||
|
|
initialSetupPending: boolean;
|
|||
|
|
configParseResult: typescript.ParsedCommandLine;
|
|||
|
|
log: logger.Logger;
|
|||
|
|
}
|
|||
|
|
export interface LoaderOptionsCache {
|
|||
|
|
[name: string]: WeakMap<LoaderOptions, LoaderOptions>;
|
|||
|
|
}
|
|||
|
|
export type DependencyGraph = Map<FilePathKey, ResolvedModule[]>;
|
|||
|
|
export type ReverseDependencyGraph = Map<FilePathKey, Map<FilePathKey, true>>;
|
|||
|
|
export type LogLevel = 'INFO' | 'WARN' | 'ERROR';
|
|||
|
|
export type ResolveModuleName = (moduleName: string, containingFile: string, compilerOptions: typescript.CompilerOptions, moduleResolutionHost: typescript.ModuleResolutionHost) => typescript.ResolvedModuleWithFailedLookupLocations;
|
|||
|
|
export type CustomResolveModuleName = (moduleName: string, containingFile: string, compilerOptions: typescript.CompilerOptions, moduleResolutionHost: typescript.ModuleResolutionHost, parentResolver: ResolveModuleName) => typescript.ResolvedModuleWithFailedLookupLocations;
|
|||
|
|
export type CustomResolveTypeReferenceDirective = (typeDirectiveName: string, containingFile: string, compilerOptions: typescript.CompilerOptions, moduleResolutionHost: typescript.ModuleResolutionHost, parentResolver: typeof typescript.resolveTypeReferenceDirective) => typescript.ResolvedTypeReferenceDirectiveWithFailedLookupLocations;
|
|||
|
|
export interface LoaderOptions {
|
|||
|
|
silent: boolean;
|
|||
|
|
logLevel: LogLevel;
|
|||
|
|
logInfoToStdOut: boolean;
|
|||
|
|
instance: string;
|
|||
|
|
compiler: string;
|
|||
|
|
configFile: string;
|
|||
|
|
context: string;
|
|||
|
|
transpileOnly: boolean;
|
|||
|
|
ignoreDiagnostics: number[];
|
|||
|
|
reportFiles: string[];
|
|||
|
|
errorFormatter: (message: ErrorInfo, colors: Chalk) => string;
|
|||
|
|
onlyCompileBundledFiles: boolean;
|
|||
|
|
colors: boolean;
|
|||
|
|
compilerOptions: typescript.CompilerOptions;
|
|||
|
|
appendTsSuffixTo: (RegExp | string)[];
|
|||
|
|
appendTsxSuffixTo: (RegExp | string)[];
|
|||
|
|
happyPackMode: boolean;
|
|||
|
|
getCustomTransformers: string | ((program: typescript.Program, getProgram: () => typescript.Program) => typescript.CustomTransformers | undefined);
|
|||
|
|
experimentalWatchApi: boolean;
|
|||
|
|
allowTsInNodeModules: boolean;
|
|||
|
|
experimentalFileCaching: boolean;
|
|||
|
|
projectReferences: boolean;
|
|||
|
|
resolveModuleName: CustomResolveModuleName;
|
|||
|
|
resolveTypeReferenceDirective: CustomResolveTypeReferenceDirective;
|
|||
|
|
useCaseSensitiveFileNames?: boolean;
|
|||
|
|
}
|
|||
|
|
export interface TSFile {
|
|||
|
|
fileName: string;
|
|||
|
|
text?: string;
|
|||
|
|
version: number;
|
|||
|
|
modifiedTime?: Date;
|
|||
|
|
projectReference?: {
|
|||
|
|
/**
|
|||
|
|
* Undefined here means we’ve already checked and confirmed there is no
|
|||
|
|
* project reference for the file. Don’t bother checking again.
|
|||
|
|
*/
|
|||
|
|
project?: typescript.ResolvedProjectReference;
|
|||
|
|
outputFileName?: string;
|
|||
|
|
};
|
|||
|
|
}
|
|||
|
|
/** where key is filepath */
|
|||
|
|
export type TSFiles = Map<FilePathKey, TSFile>;
|
|||
|
|
export interface ResolvedModule {
|
|||
|
|
originalFileName: string;
|
|||
|
|
resolvedFileName: string;
|
|||
|
|
resolvedModule?: ResolvedModule;
|
|||
|
|
isExternalLibraryImport?: boolean;
|
|||
|
|
}
|
|||
|
|
export interface TSCommon {
|
|||
|
|
resolveTypeReferenceDirective(typeReferenceDirectiveName: string, containingFile: string | undefined, options: typescript.CompilerOptions, host: typescript.ModuleResolutionHost, redirectedReference?: typescript.ResolvedProjectReference, cache?: typescript.TypeReferenceDirectiveResolutionCache, resolutionMode?: typescript.SourceFile['impliedNodeFormat']): typescript.ResolvedTypeReferenceDirectiveWithFailedLookupLocations;
|
|||
|
|
}
|
|||
|
|
/**
|
|||
|
|
* Compiler APIs we use that are marked internal and not included in TypeScript's public API declarations
|
|||
|
|
* @internal
|
|||
|
|
*/
|
|||
|
|
export interface TSInternal {
|
|||
|
|
getModeForFileReference?: (ref: typescript.FileReference | string, containingFileMode: typescript.SourceFile['impliedNodeFormat']) => typescript.SourceFile['impliedNodeFormat'];
|
|||
|
|
}
|
|||
|
|
export type Severity = 'error' | 'warning';
|
|||
|
|
export {};
|
|||
|
|
//# sourceMappingURL=interfaces.d.ts.map
|