microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-02-27 23:58:38 -06:00
Code Issues Packages Projects Releases 212 Wiki Activity

Fix all internal JSDoc comments

Browse Source 
If these are regular comments, then they won't appear in our d.ts files.
But, now we are relying on an external d.ts bundler to produce our final
merged, so they need to be present in the "input" d.ts files, meaning
they have to be JSDoc comments.

These comments only work today because all of our builds load their TS
files from scratch, so they see the actual source files and their
non-JSDoc comments.

The comments also need to be attached to a declaration, not floating,
otherwise they won't be used by api-extractor, so move them if needed.
This commit is contained in:
Jake Bailey 2022-09-07 14:04:47 -07:00
parent 231fa27f89
commit d12116d8da
93 changed files with 2839 additions and 2105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
scripts/failed-tests.cjs
View File

@ -10,6 +10,7 @@ const os = require("os");
reporter?: Mocha.ReporterConstructor | keyof Mocha.reporters;
reporterOptions?: any; // TODO(jakebailey): what?
}} ReporterOptions */
void 0;
/**
* .failed-tests reporter

1
scripts/processDiagnosticMessages.mjs
View File

@ -9,6 +9,7 @@ import fs from "fs";
isEarly?: boolean;
elidedInCompatabilityPyramid?: boolean;
}} DiagnosticDetails */
void 0;
/** @typedef {Map<string, DiagnosticDetails>} InputDiagnosticMessageTable */

1
scripts/word2md.mjs
View File

@ -60,6 +60,7 @@ const sys = (() => {
subscript?: boolean;
};
}} FindReplaceOptions */
void 0;
/**
* @param {Word.Document} doc

39
src/compiler/builder.ts
View File

@ -39,8 +39,11 @@ export interface ReusableDiagnosticRelatedInformation {
/** @internal */
export type ReusableDiagnosticMessageChain = DiagnosticMessageChain;
/** @internal */
/** Signature (Hash of d.ts emitted), is string if it was emitted using same d.ts.map option as what compilerOptions indicate, otherwise tuple of string */
/**
* Signature (Hash of d.ts emitted), is string if it was emitted using same d.ts.map option as what compilerOptions indicate, otherwise tuple of string
*
* @internal
*/
export type EmitSignature = string | [signature: string];
/** @internal */
@ -105,9 +108,10 @@ export const enum BuilderFileEmit {
All = AllJs | AllDts,
}
/** @internal */
/**
* State to store the changed files, affected files and cache semantic diagnostics
*
* @internal
*/
// TODO: GH#18217 Properties of this interface are frequently asserted to be defined.
export interface BuilderProgramState extends BuilderState, ReusableBuilderProgramState {
@ -174,8 +178,11 @@ export type SavedBuildProgramEmitState = Pick<BuilderProgramState,
"hasChangedEmitSignature"
> & { changedFilesSet: BuilderProgramState["changedFilesSet"] | undefined };
/** @internal */
/** Get flags determining what all needs to be emitted */
/**
* Get flags determining what all needs to be emitted
*
* @internal
*/
export function getBuilderFileEmit(options: CompilerOptions) {
let result = BuilderFileEmit.Js;
if (options.sourceMap) result = result | BuilderFileEmit.JsMap;
@ -186,8 +193,11 @@ export function getBuilderFileEmit(options: CompilerOptions) {
return result;
}
/** @internal */
/** Determing what all is pending to be emitted based on previous options or previous file emit flags */
/**
* Determing what all is pending to be emitted based on previous options or previous file emit flags
*
* @internal
*/
export function getPendingEmitKind(optionsOrEmitKind: CompilerOptions | BuilderFileEmit, oldOptionsOrEmitKind: CompilerOptions | BuilderFileEmit | undefined): BuilderFileEmit {
const oldEmitKind = oldOptionsOrEmitKind && (isNumber(oldOptionsOrEmitKind) ? oldOptionsOrEmitKind : getBuilderFileEmit(oldOptionsOrEmitKind));
const emitKind = isNumber(optionsOrEmitKind) ? optionsOrEmitKind : getBuilderFileEmit(optionsOrEmitKind);
@ -821,11 +831,12 @@ export type ProgramBuildInfoFileId = number & { __programBuildInfoFileIdBrand: a
export type ProgramBuildInfoFileIdListId = number & { __programBuildInfoFileIdListIdBrand: any };
/** @internal */
export type ProgramBuildInfoDiagnostic = ProgramBuildInfoFileId | [fileId: ProgramBuildInfoFileId, diagnostics: readonly ReusableDiagnostic[]];
/** @internal */
/**
* fileId if pending emit is same as what compilerOptions suggest
* [fileId] if pending emit is only dts file emit
* [fileId, emitKind] if any other type emit is pending
*
* @internal
*/
export type ProgramBuilderInfoFilePendingEmit = ProgramBuildInfoFileId | [fileId: ProgramBuildInfoFileId] | [fileId: ProgramBuildInfoFileId, emitKind: BuilderFileEmit];
/** @internal */
@ -840,15 +851,17 @@ export type ProgramMultiFileEmitBuildInfoBuilderStateFileInfo = Omit<BuilderStat
*/
signature: string | false | undefined;
};
/** @internal */
/**
* [fileId, signature] if different from file's signature
* fileId if file wasnt emitted
*
* @internal
*/
export type ProgramBuildInfoEmitSignature = ProgramBuildInfoFileId | [fileId: ProgramBuildInfoFileId, signature: EmitSignature | []];
/** @internal */
/**
* ProgramMultiFileEmitBuildInfoFileInfo is string if FileInfo.version === FileInfo.signature && !FileInfo.affectsGlobalScope otherwise encoded FileInfo
*
* @internal
*/
export type ProgramMultiFileEmitBuildInfoFileInfo = string | ProgramMultiFileEmitBuildInfoBuilderStateFileInfo;
/** @internal */
@ -866,15 +879,17 @@ export interface ProgramMultiFileEmitBuildInfo {
// Because this is only output file in the program, we dont need fileId to deduplicate name
latestChangedDtsFile?: string | undefined;
}
/** @internal */
/**
* ProgramBundleEmitBuildInfoFileInfo is string if !FileInfo.impliedFormat otherwise encoded FileInfo
*
* @internal
*/
export type ProgramBundleEmitBuildInfoFileInfo = string | BuilderState.FileInfo;
/** @internal */
/**
* false if it is the emit corresponding to compilerOptions
* value otherwise
*
* @internal
*/
export type ProgramBuildInfoBundlePendingEmit = BuilderFileEmit | false;
/** @internal */

27
src/compiler/builderPublic.ts
View File

@ -23,18 +23,21 @@ export interface BuilderProgramHost {
writeFile?: WriteFileCallback;
/**
* disable using source file version as signature for testing
*
* @internal
*/
/*@internal*/
disableUseFileVersionAsSignature?: boolean;
/**
* Store the list of files that update signature during the emit
*
* @internal
*/
/*@internal*/
storeFilesChangingSignatureDuringEmit?: boolean;
/**
* Gets the current time
*
* @internal
*/
/*@internal*/
now?(): Date;
}
@ -42,13 +45,13 @@ export interface BuilderProgramHost {
* Builder to manage the program state changes
*/
export interface BuilderProgram {
/*@internal*/
/** @internal */
getState(): ReusableBuilderProgramState;
/*@internal*/
/** @internal */
saveEmitState(): SavedBuildProgramEmitState;
/*@internal*/
/** @internal */
restoreEmitState(saved: SavedBuildProgramEmitState): void;
/*@internal*/
/** @internal */
hasChangedEmitSignature?(): boolean;
/**
* Returns current program
@ -56,13 +59,15 @@ export interface BuilderProgram {
getProgram(): Program;
/**
* Returns current program that could be undefined if the program was released
*
* @internal
*/
/*@internal*/
getProgramOrUndefined(): Program | undefined;
/**
* Releases reference to the program, making all the other operations that need program to fail.
*
* @internal
*/
/*@internal*/
releaseProgram(): void;
/**
* Get compiler options of the program
@ -122,13 +127,13 @@ export interface BuilderProgram {
* in that order would be used to write the files
*/
emit(targetSourceFile?: SourceFile, writeFile?: WriteFileCallback, cancellationToken?: CancellationToken, emitOnlyDtsFiles?: boolean, customTransformers?: CustomTransformers): EmitResult;
/*@internal*/
/** @internal */
emitBuildInfo(writeFile?: WriteFileCallback, cancellationToken?: CancellationToken): EmitResult;
/**
* Get the current directory of the program
*/
getCurrentDirectory(): string;
/*@internal*/
/** @internal */
close(): void;
}

4
src/compiler/builderStatePublic.ts
View File

@ -3,12 +3,12 @@ import { Diagnostic, WriteFileCallbackData } from "./_namespaces/ts";
export interface EmitOutput {
outputFiles: OutputFile[];
emitSkipped: boolean;
/* @internal */ diagnostics: readonly Diagnostic[];
/** @internal */ diagnostics: readonly Diagnostic[];
}
export interface OutputFile {
name: string;
writeByteOrderMark: boolean;
text: string;
/* @internal */ data?: WriteFileCallbackData;
/** @internal */ data?: WriteFileCallbackData;
}

111
src/compiler/commandLineParser.ts
View File

@ -21,7 +21,7 @@ import {
unescapeLeadingUnderscores, WatchDirectoryFlags, WatchDirectoryKind, WatchFileKind, WatchOptions,
} from "./_namespaces/ts";
/* @internal */
/** @internal */
export const compileOnSaveCommandLineOption: CommandLineOption = {
name: "compileOnSave",
type: "boolean",
@ -36,7 +36,7 @@ const jsxOptionMap = new Map(getEntries({
"react-jsxdev": JsxEmit.ReactJSXDev,
}));
/* @internal */
/** @internal */
export const inverseJsxOptionMap = new Map(arrayFrom(mapIterator(jsxOptionMap.entries(), ([key, value]: [string, JsxEmit]) => ["" + value, key] as const)));
// NOTE: The order here is important to default lib ordering as entries will have the same
@ -122,19 +122,21 @@ const libEntries: [string, string][] = [
* An array of supported "lib" reference file names used to determine the order for inclusion
* when referenced, as well as for spelling suggestions. This ensures the correct ordering for
* overload resolution when a type declared in one lib is extended by another.
*
* @internal
*/
/* @internal */
export const libs = libEntries.map(entry => entry[0]);
/**
* A map of lib names to lib files. This map is used both for parsing the "lib" command line
* option as well as for resolving lib reference directives.
*
* @internal
*/
/* @internal */
export const libMap = new Map(libEntries);
// Watch related options
/* @internal */
/** @internal */
export const optionsForWatch: CommandLineOption[] = [
{
name: "watchFile",
@ -207,7 +209,7 @@ export const optionsForWatch: CommandLineOption[] = [
},
];
/* @internal */
/** @internal */
export const commonOptionsWithBuild: CommandLineOption[] = [
{
name: "help",
@ -395,7 +397,7 @@ export const commonOptionsWithBuild: CommandLineOption[] = [
},
];
/* @internal */
/** @internal */
export const targetOptionDeclaration: CommandLineOptionOfCustomType = {
name: "target",
shortName: "t",
@ -424,7 +426,7 @@ export const targetOptionDeclaration: CommandLineOptionOfCustomType = {
defaultValueDescription: ScriptTarget.ES3,
};
/*@internal*/
/** @internal */
export const moduleOptionDeclaration: CommandLineOptionOfCustomType = {
name: "module",
shortName: "m",
@ -1372,42 +1374,42 @@ const commandOptionsWithoutBuild: CommandLineOption[] = [
}
];
/* @internal */
/** @internal */
export const optionDeclarations: CommandLineOption[] = [
...commonOptionsWithBuild,
...commandOptionsWithoutBuild,
];
/* @internal */
/** @internal */
export const semanticDiagnosticsOptionDeclarations: readonly CommandLineOption[] =
optionDeclarations.filter(option => !!option.affectsSemanticDiagnostics);
/* @internal */
/** @internal */
export const affectsEmitOptionDeclarations: readonly CommandLineOption[] =
optionDeclarations.filter(option => !!option.affectsEmit);
/* @internal */
/** @internal */
export const affectsDeclarationPathOptionDeclarations: readonly CommandLineOption[] =
optionDeclarations.filter(option => !!option.affectsDeclarationPath);
/* @internal */
/** @internal */
export const moduleResolutionOptionDeclarations: readonly CommandLineOption[] =
optionDeclarations.filter(option => !!option.affectsModuleResolution);
/* @internal */
/** @internal */
export const sourceFileAffectingCompilerOptions: readonly CommandLineOption[] = optionDeclarations.filter(option =>
!!option.affectsSourceFile || !!option.affectsModuleResolution || !!option.affectsBindDiagnostics);
/* @internal */
/** @internal */
export const optionsAffectingProgramStructure: readonly CommandLineOption[] =
optionDeclarations.filter(option => !!option.affectsProgramStructure);
/* @internal */
/** @internal */
export const transpileOptionValueCompilerOptions: readonly CommandLineOption[] = optionDeclarations.filter(option =>
hasProperty(option, "transpileOptionValue"));
// Build related options
/* @internal */
/** @internal */
export const optionsForBuild: CommandLineOption[] = [
{
name: "verbose",
@ -1442,13 +1444,13 @@ export const optionsForBuild: CommandLineOption[] = [
}
];
/* @internal */
/** @internal */
export const buildOpts: CommandLineOption[] = [
...commonOptionsWithBuild,
...optionsForBuild
];
/* @internal */
/** @internal */
export const typeAcquisitionDeclarations: CommandLineOption[] = [
{
/* @deprecated typingOptions.enableAutoDiscovery
@ -1486,13 +1488,13 @@ export const typeAcquisitionDeclarations: CommandLineOption[] = [
},
];
/* @internal */
/** @internal */
export interface OptionsNameMap {
optionsNameMap: ESMap<string, CommandLineOption>;
shortOptionNames: ESMap<string, string>;
}
/*@internal*/
/** @internal */
export function createOptionNameMap(optionDeclarations: readonly CommandLineOption[]): OptionsNameMap {
const optionsNameMap = new Map<string, CommandLineOption>();
const shortOptionNames = new Map<string, string>();
@ -1508,7 +1510,7 @@ export function createOptionNameMap(optionDeclarations: readonly CommandLineOpti
let optionsNameMapCache: OptionsNameMap;
/* @internal */
/** @internal */
export function getOptionsNameMap(): OptionsNameMap {
return optionsNameMapCache ||= createOptionNameMap(optionDeclarations);
}
@ -1518,7 +1520,7 @@ const compilerOptionsAlternateMode: AlternateModeDiagnostics = {
getOptionsNameMap: getBuildOptionsNameMap
};
/* @internal */
/** @internal */
export const defaultInitCompilerOptions: CompilerOptions = {
module: ModuleKind.CommonJS,
target: ScriptTarget.ES2016,
@ -1528,7 +1530,7 @@ export const defaultInitCompilerOptions: CompilerOptions = {
skipLibCheck: true
};
/* @internal */
/** @internal */
export function convertEnableAutoDiscoveryToEnable(typeAcquisition: TypeAcquisition): TypeAcquisition {
// Convert deprecated typingOptions.enableAutoDiscovery to typeAcquisition.enable
if (typeAcquisition && typeAcquisition.enableAutoDiscovery !== undefined && typeAcquisition.enable === undefined) {
@ -1541,7 +1543,7 @@ export function convertEnableAutoDiscoveryToEnable(typeAcquisition: TypeAcquisit
return typeAcquisition;
}
/* @internal */
/** @internal */
export function createCompilerDiagnosticForInvalidCustomType(opt: CommandLineOptionOfCustomType): Diagnostic {
return createDiagnosticForInvalidCustomType(opt, createCompilerDiagnostic);
}
@ -1551,12 +1553,12 @@ function createDiagnosticForInvalidCustomType(opt: CommandLineOptionOfCustomType
return createDiagnostic(Diagnostics.Argument_for_0_option_must_be_Colon_1, `--${opt.name}`, namesOfType);
}
/* @internal */
/** @internal */
export function parseCustomTypeOption(opt: CommandLineOptionOfCustomType, value: string, errors: Push<Diagnostic>) {
return convertJsonOptionOfCustomType(opt, trimString(value || ""), errors);
}
/* @internal */
/** @internal */
export function parseListTypeOption(opt: CommandLineOptionOfListType, value = "", errors: Push<Diagnostic>): (string | number)[] | undefined {
value = trimString(value);
if (startsWith(value, "-")) {
@ -1576,12 +1578,12 @@ export function parseListTypeOption(opt: CommandLineOptionOfListType, value = ""
}
}
/*@internal*/
/** @internal */
export interface OptionsBase {
[option: string]: CompilerOptionsValue | TsConfigSourceFile | undefined;
}
/*@internal*/
/** @internal */
export interface ParseCommandLineWorkerDiagnostics extends DidYouMeanOptionsDiagnostics {
getOptionsNameMap: () => OptionsNameMap;
optionTypeMismatchDiagnostic: DiagnosticMessage;
@ -1607,7 +1609,7 @@ function createUnknownOptionError(
createDiagnostics(diagnostics.unknownOptionDiagnostic, unknownOptionErrorText || unknownOption);
}
/*@internal*/
/** @internal */
export function parseCommandLineWorker(
diagnostics: ParseCommandLineWorkerDiagnostics,
commandLine: readonly string[],
@ -1764,7 +1766,7 @@ function parseOptionValue(
return i;
}
/*@internal*/
/** @internal */
export const compilerOptionsDidYouMeanDiagnostics: ParseCommandLineWorkerDiagnostics = {
alternateMode: compilerOptionsAlternateMode,
getOptionsNameMap,
@ -1795,7 +1797,7 @@ function getOptionDeclarationFromName(getOptionNameMap: () => OptionsNameMap, op
return optionsNameMap.get(optionName);
}
/*@internal*/
/** @internal */
export interface ParsedBuildCommand {
buildOptions: BuildOptions;
watchOptions: WatchOptions | undefined;
@ -1822,7 +1824,7 @@ const buildOptionsDidYouMeanDiagnostics: ParseCommandLineWorkerDiagnostics = {
optionTypeMismatchDiagnostic: Diagnostics.Build_option_0_requires_a_value_of_type_1
};
/*@internal*/
/** @internal */
export function parseBuildCommand(args: readonly string[]): ParsedBuildCommand {
const { options, watchOptions, fileNames: projects, errors } = parseCommandLineWorker(
buildOptionsDidYouMeanDiagnostics,
@ -1852,7 +1854,7 @@ export function parseBuildCommand(args: readonly string[]): ParsedBuildCommand {
return { buildOptions, watchOptions, projects, errors };
}
/* @internal */
/** @internal */
export function getDiagnosticText(_message: DiagnosticMessage, ..._args: any[]): string {
const diagnostic = createCompilerDiagnostic.apply(undefined, arguments);
return diagnostic.messageText as string;
@ -1942,7 +1944,7 @@ export function readJsonConfigFile(fileName: string, readFile: (path: string) =>
return isString(textOrDiagnostic) ? parseJsonText(fileName, textOrDiagnostic) : { fileName, parseDiagnostics: [textOrDiagnostic] } as TsConfigSourceFile;
}
/*@internal*/
/** @internal */
export function tryReadFile(fileName: string, readFile: (path: string) => string | undefined): string | Diagnostic {
let text: string | undefined;
try {
@ -2070,7 +2072,7 @@ function getTsconfigRootOptionsMap() {
return _tsconfigRootOptions;
}
/*@internal*/
/** @internal */
interface JsonConversionNotifier {
/**
* Notifies parent option object is being set with the optionKey and a valid optionValue
@ -2134,8 +2136,9 @@ export function convertToObject(sourceFile: JsonSourceFile, errors: Push<Diagnos
* Convert the json syntax tree into the json value and report errors
* This returns the json value (apart from checking errors) only if returnValue provided is true.
* Otherwise it just checks the errors and returns undefined
*
* @internal
*/
/*@internal*/
export function convertToObjectWorker(
sourceFile: JsonSourceFile,
rootExpression: Expression | undefined,
@ -2381,8 +2384,9 @@ export interface ConvertToTSConfigHost {
* @param configParseResult options to be generated into tsconfig.json
* @param configFileName name of the parsed config file - output paths will be generated relative to this
* @param host provides current directory and case sensitivity services
*
* @internal
*/
/** @internal */
export function convertToTSConfig(configParseResult: ParsedCommandLine, configFileName: string, host: ConvertToTSConfigHost): TSConfig {
const getCanonicalFileName = createGetCanonicalFileName(host.useCaseSensitiveFileNames);
const files = map(
@ -2425,7 +2429,7 @@ export function convertToTSConfig(configParseResult: ParsedCommandLine, configFi
return config;
}
/*@internal*/
/** @internal */
export function optionMapToObject(optionMap: ESMap<string, CompilerOptionsValue>): object {
return {
...arrayFrom(optionMap.entries()).reduce((prev, cur) => ({ ...prev, [cur[0]]: cur[1] }), {}),
@ -2469,7 +2473,7 @@ function getCustomTypeMapOfCommandLineOption(optionDefinition: CommandLineOption
}
}
/* @internal */
/** @internal */
export function getNameOfCompilerOptionValue(value: CompilerOptionsValue, customTypeMap: ESMap<string, string | number>): string | undefined {
// There is a typeMap associated with this command-line option so use it to map value back to its name
return forEachEntry(customTypeMap, (mapValue, key) => {
@ -2479,7 +2483,7 @@ export function getNameOfCompilerOptionValue(value: CompilerOptionsValue, custom
});
}
/* @internal */
/** @internal */
export function serializeCompilerOptions(
options: CompilerOptions,
pathOptions?: { configFilePath: string, useCaseSensitiveFileNames: boolean }
@ -2580,8 +2584,9 @@ function getSerializedCompilerOption(options: CompilerOptions): ESMap<string, Co
* Generate tsconfig configuration when running command line "--init"
* @param options commandlineOptions to be generated into tsconfig.json
* @param fileNames array of filenames to be generated into tsconfig.json
*
* @internal
*/
/* @internal */
export function generateTSConfig(options: CompilerOptions, fileNames: readonly string[], newLine: string): string {
const compilerOptionsMap = getSerializedCompilerOption(options);
return writeConfigurations();
@ -2670,7 +2675,7 @@ export function generateTSConfig(options: CompilerOptions, fileNames: readonly s
}
}
/* @internal */
/** @internal */
export function convertToOptionsWithAbsolutePaths(options: CompilerOptions, toAbsolutePath: (path: string) => string) {
const result: CompilerOptions = {};
const optionsNameMap = getOptionsNameMap().optionsNameMap;
@ -2730,7 +2735,7 @@ export function parseJsonSourceFileConfigFileContent(sourceFile: TsConfigSourceF
return result;
}
/*@internal*/
/** @internal */
export function setConfigFileInOptions(options: CompilerOptions, configFile: TsConfigSourceFile | undefined) {
if (configFile) {
Object.defineProperty(options, "configFile", { enumerable: false, writable: false, value: configFile });
@ -2747,7 +2752,7 @@ function directoryOfCombinedPath(fileName: string, basePath: string) {
return getDirectoryPath(getNormalizedAbsolutePath(fileName, basePath));
}
/*@internal*/
/** @internal */
export const defaultIncludeSpec = "**/*";
/**
@ -2947,12 +2952,12 @@ function shouldReportNoInputFiles(fileNames: string[], canJsonReportNoInutFiles:
return fileNames.length === 0 && canJsonReportNoInutFiles && (!resolutionStack || resolutionStack.length === 0);
}
/*@internal*/
/** @internal */
export function canJsonReportNoInputFiles(raw: any) {
return !hasProperty(raw, "files") && !hasProperty(raw, "references");
}
/*@internal*/
/** @internal */
export function updateErrorForNoInputFiles(fileNames: string[], configFileName: string, configFileSpecs: ConfigFileSpecs, configParseDiagnostics: Diagnostic[], canJsonReportNoInutFiles: boolean) {
const existingErrors = configParseDiagnostics.length;
if (shouldReportNoInputFiles(fileNames, canJsonReportNoInutFiles)) {
@ -3308,7 +3313,7 @@ function convertOptionsFromJson(optionsNameMap: ESMap<string, CommandLineOption>
return defaultOptions;
}
/*@internal*/
/** @internal */
export function convertJsonOption(opt: CommandLineOption, value: any, basePath: string, errors: Push<Diagnostic>): CompilerOptionsValue {
if (isCompilerOptionsValue(opt, value)) {
const optType = opt.type;
@ -3410,8 +3415,9 @@ const wildcardDirectoryPattern = /^[^*?]*(?=\/[^/]*[*?])/;
* @param options Compiler options.
* @param host The host used to resolve files and directories.
* @param extraFileExtensions optionaly file extra file extension information from host
*
* @internal
*/
/* @internal */
export function getFileNamesFromConfigSpecs(
configFileSpecs: ConfigFileSpecs,
basePath: string,
@ -3501,7 +3507,7 @@ export function getFileNamesFromConfigSpecs(
return literalFiles.concat(wildcardFiles, arrayFrom(wildCardJsonFileMap.values()));
}
/* @internal */
/** @internal */
export function isExcludedFile(
pathToCheck: string,
spec: ConfigFileSpecs,
@ -3538,7 +3544,7 @@ function invalidDotDotAfterRecursiveWildcard(s: string) {
return lastDotIndex > wildcardIndex;
}
/* @internal */
/** @internal */
export function matchesExclude(
pathToCheck: string,
excludeSpecs: readonly string[] | undefined,
@ -3729,8 +3735,9 @@ function removeWildcardFilesWithLowerPriorityExtension(file: string, wildcardFil
/**
* Produces a cleaned version of compiler options with personally identifying info (aka, paths) removed.
* Also converts enum values back to strings.
*
* @internal
*/
/* @internal */
export function convertCompilerOptionsForTelemetry(opts: CompilerOptions): CompilerOptions {
const out: CompilerOptions = {};
for (const key in opts) {

307
src/compiler/core.ts
View File

@ -41,11 +41,12 @@ export function length(array: readonly any[] | undefined): number {
return array ? array.length : 0;
}
/** @internal */
/**
* Iterates through 'array' by index and performs the callback on each element of array until the callback
* returns a truthy value, then returns that value.
* If no such value is found, the callback is applied to each element of array and undefined is returned.
*
* @internal
*/
export function forEach<T, U>(array: readonly T[] | undefined, callback: (element: T, index: number) => U | undefined): U | undefined {
if (array) {
@ -59,9 +60,10 @@ export function forEach<T, U>(array: readonly T[] | undefined, callback: (elemen
return undefined;
}
/** @internal */
/**
* Like `forEach`, but iterates in reverse order.
*
* @internal
*/
export function forEachRight<T, U>(array: readonly T[] | undefined, callback: (element: T, index: number) => U | undefined): U | undefined {
if (array) {
@ -75,8 +77,11 @@ export function forEachRight<T, U>(array: readonly T[] | undefined, callback: (e
return undefined;
}
/** @internal */
/** Like `forEach`, but suitable for use with numbers and strings (which may be falsy). */
/**
* Like `forEach`, but suitable for use with numbers and strings (which may be falsy).
*
* @internal
*/
export function firstDefined<T, U>(array: readonly T[] | undefined, callback: (element: T, index: number) => U | undefined): U | undefined {
if (array === undefined) {
return undefined;
@ -151,10 +156,11 @@ export function zipToMap<K, V>(keys: readonly K[], values: readonly V[]): ESMap<
return map;
}
/** @internal */
/**
* Creates a new array with `element` interspersed in between each element of `input`
* if there is more than 1 value in `input`. Otherwise, returns the existing array.
*
* @internal
*/
export function intersperse<T>(input: T[], element: T): T[] {
if (input.length <= 1) {
@ -168,11 +174,12 @@ export function intersperse<T>(input: T[], element: T): T[] {
return result;
}
/** @internal */
/**
* Iterates through `array` by index and performs the callback on each element of array until the callback
* returns a falsey value, then returns false.
* If no such value is found, the callback is applied to each element of array and `true` is returned.
*
* @internal
*/
export function every<T>(array: readonly T[] | undefined, callback: (element: T, index: number) => boolean): boolean {
if (array) {
@ -186,8 +193,11 @@ export function every<T>(array: readonly T[] | undefined, callback: (element: T,
return true;
}
/** @internal */
/** Works like Array.prototype.find, returning `undefined` if no element satisfying the predicate is found. */
/**
* Works like Array.prototype.find, returning `undefined` if no element satisfying the predicate is found.
*
* @internal
*/
export function find<T, U extends T>(array: readonly T[] | undefined, predicate: (element: T, index: number) => element is U, startIndex?: number): U | undefined;
/** @internal */
export function find<T>(array: readonly T[] | undefined, predicate: (element: T, index: number) => boolean, startIndex?: number): T | undefined;
@ -219,8 +229,11 @@ export function findLast<T>(array: readonly T[] | undefined, predicate: (element
return undefined;
}
/** @internal */
/** Works like Array.prototype.findIndex, returning `-1` if no element satisfying the predicate is found. */
/**
* Works like Array.prototype.findIndex, returning `-1` if no element satisfying the predicate is found.
*
* @internal
*/
export function findIndex<T>(array: readonly T[] | undefined, predicate: (element: T, index: number) => boolean, startIndex?: number): number {
if (array === undefined) return -1;
for (let i = startIndex ?? 0; i < array.length; i++) {
@ -242,10 +255,11 @@ export function findLastIndex<T>(array: readonly T[] | undefined, predicate: (el
return -1;
}
/** @internal */
/**
* Returns the first truthy result of `callback`, or else fails.
* This is like `forEach`, but never returns undefined.
*
* @internal
*/
export function findMap<T, U>(array: readonly T[], callback: (element: T, index: number) => U | undefined): U {
for (let i = 0; i < array.length; i++) {
@ -298,10 +312,11 @@ export function countWhere<T>(array: readonly T[] | undefined, predicate: (x: T,
return count;
}
/** @internal */
/**
* Filters an array by a predicate function. Returns the same array instance if the predicate is
* true for all elements, otherwise returns a new array instance containing the filtered subset.
*
* @internal
*/
export function filter<T, U extends T>(array: T[], f: (x: T) => x is U): U[];
/** @internal */
@ -384,8 +399,10 @@ export function mapIterator<T, U>(iter: Iterator<T>, mapFn: (x: T) => U): Iterat
};
}
// Maps from T to T and avoids allocation if all elements map to themselves
/** @internal */
/**
* Maps from T to T and avoids allocation if all elements map to themselves
*
* @internal */
export function sameMap<T>(array: T[], f: (x: T, i: number) => T): T[];
/** @internal */
export function sameMap<T>(array: readonly T[], f: (x: T, i: number) => T): readonly T[];
@ -412,11 +429,12 @@ export function sameMap<T>(array: readonly T[] | undefined, f: (x: T, i: number)
return array;
}
/** @internal */
/**
* Flattens an array containing a mix of array or non-array elements.
*
* @param array The array to flatten.
*
* @internal
*/
export function flatten<T>(array: T[][] | readonly (T | readonly T[] | undefined)[]): T[] {
const result = [];
@ -433,12 +451,14 @@ export function flatten<T>(array: T[][] | readonly (T | readonly T[] | undefined
return result;
}
/** @internal */
/**
* Maps an array. If the mapped value is an array, it is spread into the result.
*
* @param array The array to map.
* @param mapfn The callback used to map the result into one or more values.
*
* @internal
*/
export function flatMap<T, U>(array: readonly T[] | undefined, mapfn: (x: T, i: number) => U | readonly U[] | undefined): readonly U[] {
let result: U[] | undefined;
@ -506,13 +526,15 @@ export function flatMapIterator<T, U>(iter: Iterator<T>, mapfn: (x: T) => readon
}
}
/** @internal */
/**
* Maps an array. If the mapped value is an array, it is spread into the result.
* Avoids allocation if all elements map to themselves.
*
* @param array The array to map.
* @param mapfn The callback used to map the result into one or more values.
*
* @internal
*/
export function sameFlatMap<T>(array: T[], mapfn: (x: T, i: number) => T | readonly T[]): T[];
/** @internal */
@ -661,13 +683,14 @@ export function singleIterator<T>(value: T): Iterator<T> {
};
}
/** @internal */
/**
* Maps contiguous spans of values with the same key.
*
* @param array The array to map.
* @param keyfn A callback used to select the key for an element.
* @param mapfn A callback used to map a contiguous chunk of values to a single value.
*
* @internal
*/
export function spanMap<T, K, U>(array: readonly T[], keyfn: (x: T, i: number) => K, mapfn: (chunk: T[], key: K, start: number, end: number) => U): U[];
/** @internal */
@ -752,8 +775,11 @@ export function some<T>(array: readonly T[] | undefined, predicate?: (value: T)
return false;
}
/** @internal */
/** Calls the callback with (start, afterEnd) index pairs for each range where 'pred' is true. */
/**
* Calls the callback with (start, afterEnd) index pairs for each range where 'pred' is true.
*
* @internal
*/
export function getRangesWhere<T>(arr: readonly T[], pred: (t: T) => boolean, cb: (start: number, afterEnd: number) => void): void {
let start: number | undefined;
for (let i = 0; i < arr.length; i++) {
@ -824,12 +850,13 @@ function deduplicateEquality<T>(array: readonly T[], equalityComparer: EqualityC
return result;
}
/** @internal */
/**
* Deduplicates an unsorted array.
* @param equalityComparer An `EqualityComparer` used to determine if two values are duplicates.
* @param comparer An optional `Comparer` used to sort entries before comparison, though the
* result will remain in the original order in `array`.
*
* @internal
*/
export function deduplicate<T>(array: readonly T[], equalityComparer: EqualityComparer<T>, comparer?: Comparer<T>): T[] {
return array.length === 0 ? [] :
@ -935,9 +962,10 @@ export function arrayIsEqualTo<T>(array1: readonly T[] | undefined, array2: read
return true;
}
/** @internal */
/**
* Compacts an array, removing any falsey elements.
*
* @internal
*/
export function compact<T>(array: (T | undefined | null | false | 0 | "")[]): T[];
/** @internal */
@ -966,11 +994,12 @@ export function compact<T>(array: T[]): T[] {
return result || array;
}
/** @internal */
/**
* Gets the relative complement of `arrayA` with respect to `arrayB`, returning the elements that
* are not present in `arrayA` but are present in `arrayB`. Assumes both arrays are sorted
* based on the provided comparer.
*
* @internal
*/
export function relativeComplement<T>(arrayA: T[] | undefined, arrayB: T[] | undefined, comparer: Comparer<T>): T[] | undefined {
if (!arrayB || !arrayA || arrayB.length === 0 || arrayA.length === 0) return arrayB;
@ -1019,7 +1048,6 @@ export function sum<T extends Record<K, number>, K extends string>(array: readon
return result;
}
/** @internal */
/**
* Appends a value to an array, returning the array.
*
@ -1027,6 +1055,8 @@ export function sum<T extends Record<K, number>, K extends string>(array: readon
* is created if `value` was appended.
* @param value The value to append to the array. If `value` is `undefined`, nothing is
* appended.
*
* @internal
*/
export function append<TArray extends any[] | undefined, TValue extends NonNullable<TArray>[number] | undefined>(to: TArray, value: TValue): [undefined, undefined] extends [TArray, TValue] ? TArray : NonNullable<TArray>[number][];
/** @internal */
@ -1045,7 +1075,6 @@ export function append<T>(to: T[], value: T | undefined): T[] | undefined {
return to;
}
/** @internal */
/**
* Combines two arrays, values, or undefineds into the smallest container that can accommodate the resulting set:
*
@ -1057,6 +1086,8 @@ export function append<T>(to: T[], value: T | undefined): T[] | undefined {
* T[] -> T -> T[] (append)
* T[] -> T[] -> T[] (concatenate)
* ```
*
* @internal
*/
export function combine<T>(xs: T | readonly T[] | undefined, ys: T | readonly T[] | undefined): T | readonly T[] | undefined;
/** @internal */
@ -1078,7 +1109,6 @@ function toOffset(array: readonly any[], offset: number) {
return offset < 0 ? array.length + offset : offset;
}
/** @internal */
/**
* Appends a range of value to an array, returning the array.
*
@ -1088,6 +1118,8 @@ function toOffset(array: readonly any[], offset: number) {
* appended. If an element of `from` is `undefined`, that element is not appended.
* @param start The offset in `from` at which to start copying values.
* @param end The offset in `from` at which to stop copying values (non-inclusive).
*
* @internal
*/
export function addRange<T>(to: T[], from: readonly T[] | undefined, start?: number, end?: number): T[];
/** @internal */
@ -1106,9 +1138,10 @@ export function addRange<T>(to: T[] | undefined, from: readonly T[] | undefined,
return to;
}
/** @internal */
/**
* @return Whether the value was added.
*
* @internal
*/
export function pushIfUnique<T>(array: T[], toAdd: T, equalityComparer?: EqualityComparer<T>): boolean {
if (contains(array, toAdd, equalityComparer)) {
@ -1120,9 +1153,10 @@ export function pushIfUnique<T>(array: T[], toAdd: T, equalityComparer?: Equalit
}
}
/** @internal */
/**
* Unlike `pushIfUnique`, this can take `undefined` as an input, and returns a new array.
*
* @internal
*/
export function appendIfUnique<T>(array: T[] | undefined, toAdd: T, equalityComparer?: EqualityComparer<T>): T[] {
if (array) {
@ -1139,9 +1173,10 @@ function stableSortIndices<T>(array: readonly T[], indices: number[], comparer:
indices.sort((x, y) => comparer(array[x], array[y]) || compareValues(x, y));
}
/** @internal */
/**
* Returns a new sorted array.
*
* @internal
*/
export function sort<T>(array: readonly T[], comparer?: Comparer<T>): SortedReadonlyArray<T> {
return (array.length === 0 ? array : array.slice().sort(comparer)) as SortedReadonlyArray<T>;
@ -1177,9 +1212,10 @@ export function arrayReverseIterator<T>(array: readonly T[]): Iterator<T> {
};
}
/** @internal */
/**
* Stable sort of an array. Elements equal to each other maintain their relative position in the array.
*
* @internal
*/
export function stableSort<T>(array: readonly T[], comparer: Comparer<T>): SortedReadonlyArray<T> {
const indices = indicesOf(array);
@ -1198,10 +1234,11 @@ export function rangeEquals<T>(array1: readonly T[], array2: readonly T[], pos:
return true;
}
/** @internal */
/**
* Returns the element at a specific offset in an array if non-empty, `undefined` otherwise.
* A negative offset indicates the element should be retrieved from the end of the array.
*
* @internal
*/
export function elementAt<T>(array: readonly T[] | undefined, offset: number): T | undefined {
if (array) {
@ -1213,9 +1250,10 @@ export function elementAt<T>(array: readonly T[] | undefined, offset: number): T
return undefined;
}
/** @internal */
/**
* Returns the first element of an array if non-empty, `undefined` otherwise.
*
* @internal
*/
export function firstOrUndefined<T>(array: readonly T[] | undefined): T | undefined {
return array === undefined || array.length === 0 ? undefined : array[0];
@ -1227,9 +1265,10 @@ export function first<T>(array: readonly T[]): T {
return array[0];
}
/** @internal */
/**
* Returns the last element of an array if non-empty, `undefined` otherwise.
*
* @internal
*/
export function lastOrUndefined<T>(array: readonly T[] | undefined): T | undefined {
return array === undefined || array.length === 0 ? undefined : array[array.length - 1];
@ -1241,9 +1280,10 @@ export function last<T>(array: readonly T[]): T {
return array[array.length - 1];
}
/** @internal */
/**
* Returns the only element of an array if it contains only one element, `undefined` otherwise.
*
* @internal
*/
export function singleOrUndefined<T>(array: readonly T[] | undefined): T | undefined {
return array && array.length === 1
@ -1251,18 +1291,20 @@ export function singleOrUndefined<T>(array: readonly T[] | undefined): T | undef
: undefined;
}
/** @internal */
/**
* Returns the only element of an array if it contains only one element; throws otherwise.
*
* @internal
*/
export function single<T>(array: readonly T[]): T {
return Debug.checkDefined(singleOrUndefined(array));
}
/** @internal */
/**
* Returns the only element of an array if it contains only one element; otherwise, returns the
* array.
*
* @internal
*/
export function singleOrMany<T>(array: T[]): T | T[];
/** @internal */
@ -1285,7 +1327,6 @@ export function replaceElement<T>(array: readonly T[], index: number, value: T):
return result;
}
/** @internal */
/**
* Performs a binary search, finding the index at which `value` occurs in `array`.
* If no such index is found, returns the 2's-complement of first index at which
@ -1296,12 +1337,13 @@ export function replaceElement<T>(array: readonly T[], index: number, value: T):
* `array`.
* @param keyComparer A callback used to compare two keys in a sorted array.
* @param offset An offset into `array` at which to start the search.
*
* @internal
*/
export function binarySearch<T, U>(array: readonly T[], value: T, keySelector: (v: T) => U, keyComparer: Comparer<U>, offset?: number): number {
return binarySearchKey(array, keySelector(value), keySelector, keyComparer, offset);
}
/** @internal */
/**
* Performs a binary search, finding the index at which an object with `key` occurs in `array`.
* If no such index is found, returns the 2's-complement of first index at which
@ -1311,6 +1353,8 @@ export function binarySearch<T, U>(array: readonly T[], value: T, keySelector: (
* @param keySelector A callback used to select the search key from each element of `array`.
* @param keyComparer A callback used to compare two keys in a sorted array.
* @param offset An offset into `array` at which to start the search.
*
* @internal
*/
export function binarySearchKey<T, U>(array: readonly T[], key: U, keySelector: (v: T, i: number) => U, keyComparer: Comparer<U>, offset?: number): number {
if (!some(array)) {
@ -1368,31 +1412,34 @@ export function reduceLeft<T>(array: T[], f: (memo: T, value: T, i: number) => T
const hasOwnProperty = Object.prototype.hasOwnProperty;
/** @internal */
/**
* Indicates whether a map-like contains an own property with the specified key.
*
* @param map A map-like.
* @param key A property key.
*
* @internal
*/
export function hasProperty(map: MapLike<any>, key: string): boolean {
return hasOwnProperty.call(map, key);
}
/** @internal */
/**
* Gets the value of an owned property in a map-like.
*
* @param map A map-like.
* @param key A property key.
*
* @internal
*/
export function getProperty<T>(map: MapLike<T>, key: string): T | undefined {
return hasOwnProperty.call(map, key) ? map[key] : undefined;
}
/** @internal */
/**
* Gets the owned, enumerable property keys of a map-like.
*
* @internal
*/
export function getOwnKeys<T>(map: MapLike<T>): string[] {
const keys: string[] = [];
@ -1452,8 +1499,11 @@ export function arrayOf<T>(count: number, f: (index: number) => T): T[] {
return result;
}
/** @internal */
/** Shims `Array.from`. */
/**
* Shims `Array.from`.
*
* @internal
*/
export function arrayFrom<T, U>(iterator: Iterator<T> | IterableIterator<T>, map: (t: T) => U): U[];
/** @internal */
export function arrayFrom<T>(iterator: Iterator<T> | IterableIterator<T>): T[];
@ -1480,12 +1530,13 @@ export function assign<T extends object>(t: T, ...args: (T | undefined)[]) {
return t;
}
/** @internal */
/**
* Performs a shallow equality comparison of the contents of two map-likes.
*
* @param left A map-like whose properties should be compared.
* @param right A map-like whose properties should be compared.
*
* @internal
*/
export function equalOwnProperties<T>(left: MapLike<T> | undefined, right: MapLike<T> | undefined, equalityComparer: EqualityComparer<T> = equateValues) {
if (left === right) return true;
@ -1506,7 +1557,6 @@ export function equalOwnProperties<T>(left: MapLike<T> | undefined, right: MapLi
return true;
}
/** @internal */
/**
* Creates a map from the elements of an array.
*
@ -1516,6 +1566,8 @@ export function equalOwnProperties<T>(left: MapLike<T> | undefined, right: MapLi
* This function makes no effort to avoid collisions; if any two elements produce
* the same key with the given 'makeKey' function, then the element with the higher
* index in the array will be the one associated with the produced key.
*
* @internal
*/
export function arrayToMap<K, V>(array: readonly V[], makeKey: (value: V) => K | undefined): ESMap<K, V>;
/** @internal */
@ -1584,11 +1636,12 @@ export function clone<T>(object: T): T {
return result;
}
/** @internal */
/**
* Creates a new object by adding the own properties of `second`, then the own properties of `first`.
*
* NOTE: This means that if a property exists in both `first` and `second`, the property in `first` will be chosen.
*
* @internal
*/
export function extend<T1, T2>(first: T1, second: T2): T1 & T2 {
const result: T1 & T2 = {} as any;
@ -1729,7 +1782,6 @@ export function createQueue<T>(items?: readonly T[]): Queue<T> {
};
}
/** @internal */
/**
* Creates a Set with custom equality and hash code functionality. This is useful when you
* want to use something looser than object identity - e.g. "has the same span".
@ -1739,6 +1791,8 @@ export function createQueue<T>(items?: readonly T[]): Queue<T> {
*
* To facilitate a perf optimization (lazy allocation of bucket arrays), `TElement` is
* assumed not to be an array type.
*
* @internal
*/
export function createSet<TElement, THash = number>(getHashCode: (element: TElement) => THash, equals: EqualityComparer<TElement>): Set<TElement> {
const multiMap = new Map<THash, TElement | TElement[]>();
@ -1883,9 +1937,10 @@ export function createSet<TElement, THash = number>(getHashCode: (element: TElem
return set;
}
/** @internal */
/**
* Tests whether a value is an array.
*
* @internal
*/
export function isArray(value: any): value is readonly unknown[] {
return Array.isArray ? Array.isArray(value) : value instanceof Array;
@ -1900,9 +1955,10 @@ export function toArray<T>(value: T | T[]): T[] {
return isArray(value) ? value : [value];
}
/** @internal */
/**
* Tests whether a value is string
*
* @internal
*/
export function isString(text: unknown): text is string {
return typeof text === "string";
@ -1928,8 +1984,11 @@ export function cast<TOut extends TIn, TIn = any>(value: TIn | undefined, test:
return Debug.fail(`Invalid cast. The supplied value ${value} did not pass the test '${Debug.getFunctionName(test)}'.`);
}
/** @internal */
/** Does nothing. */
/**
* Does nothing.
*
* @internal
*/
export function noop(_?: unknown): void { }
/** @internal */
@ -1938,32 +1997,47 @@ export const noopPush: Push<any> = {
length: 0
};
/** @internal */
/** Do nothing and return false */
/**
* Do nothing and return false
*
* @internal
*/
export function returnFalse(): false {
return false;
}
/** @internal */
/** Do nothing and return true */
/**
* Do nothing and return true
*
* @internal
*/
export function returnTrue(): true {
return true;
}
/** @internal */
/** Do nothing and return undefined */
/**
* Do nothing and return undefined
*
* @internal
*/
export function returnUndefined(): undefined {
return undefined;
}
/** @internal */
/** Returns its argument. */
/**
* Returns its argument.
*
* @internal
*/
export function identity<T>(x: T) {
return x;
}
/** @internal */
/** Returns lower case string */
/**
* Returns lower case string
*
* @internal
*/
export function toLowerCase(x: string) {
return x.toLowerCase();
}
@ -1991,7 +2065,6 @@ export function toLowerCase(x: string) {
// But to avoid having to do string building for most common cases, also ignore
// a-z, 0-9, \u0131, \u00DF, \, /, ., : and space
const fileNameLowerCaseRegExp = /[^\u0130\u0131\u00DFa-z0-9\\/:\-_\. ]+/g;
/** @internal */
/**
* Case insensitive file systems have descripencies in how they handle some characters (eg. turkish Upper case I with dot on top - \u0130)
* This function is used in places where we want to make file name as a key on these systems
@ -2002,6 +2075,8 @@ const fileNameLowerCaseRegExp = /[^\u0130\u0131\u00DFa-z0-9\\/:\-_\. ]+/g;
* We could use upper case and we would still need to deal with the descripencies but
* we want to continue using lower case since in most cases filenames are lowercasewe and wont need any case changes and avoid having to store another string for the key
* So for this function purpose, we go ahead and assume character I with dot on top it as case sensitive since its very unlikely to use lower case form of that special character
*
* @internal
*/
export function toFileNameLowerCase(x: string) {
return fileNameLowerCaseRegExp.test(x) ?
@ -2009,8 +2084,11 @@ export function toFileNameLowerCase(x: string) {
x;
}
/** @internal */
/** Throws an error because a function is not implemented. */
/**
* Throws an error because a function is not implemented.
*
* @internal
*/
export function notImplemented(): never {
throw new Error("Not implemented");
}
@ -2027,8 +2105,11 @@ export function memoize<T>(callback: () => T): () => T {
};
}
/** @internal */
/** A version of `memoize` that supports a single primitive argument */
/**
* A version of `memoize` that supports a single primitive argument
*
* @internal
*/
export function memoizeOne<A extends string | number | boolean | undefined, T>(callback: (arg: A) => T): (arg: A) => T {
const map = new Map<string, T>();
return (arg: A) => {
@ -2042,12 +2123,13 @@ export function memoizeOne<A extends string | number | boolean | undefined, T>(c
};
}
/** @internal */
/**
* High-order function, composes functions. Note that functions are composed inside-out;
* for example, `compose(a, b)` is the equivalent of `x => b(a(x))`.
*
* @param args The functions to compose.
*
* @internal
*/
export function compose<T>(...args: ((t: T) => T)[]): (t: T) => T;
/** @internal */
@ -2085,10 +2167,11 @@ export const enum AssertionLevel {
VeryAggressive = 3,
}
/** @internal */
/**
* Safer version of `Function` which should not be called.
* Every function should be assignable to this, but this should not be assignable to every function.
*
* @internal
*/
export type AnyFunction = (...args: never[]) => void;
/** @internal */
@ -2099,7 +2182,6 @@ export function equateValues<T>(a: T, b: T) {
return a === b;
}
/** @internal */
/**
* Compare the equality of two strings using a case-sensitive ordinal comparison.
*
@ -2107,6 +2189,8 @@ export function equateValues<T>(a: T, b: T) {
* value of each code-point after applying `toUpperCase` to each string. We always map both
* strings to their upper-case form as some unicode characters do not properly round-trip to
* lowercase (such as `ẞ` (German sharp capital s)).
*
* @internal
*/
export function equateStringsCaseInsensitive(a: string, b: string) {
return a === b
@ -2115,12 +2199,13 @@ export function equateStringsCaseInsensitive(a: string, b: string) {
&& a.toUpperCase() === b.toUpperCase();
}
/** @internal */
/**
* Compare the equality of two strings using a case-sensitive ordinal comparison.
*
* Case-sensitive comparisons compare both strings one code-point at a time using the
* integer value of each code-point.
*
* @internal
*/
export function equateStringsCaseSensitive(a: string, b: string) {
return equateValues(a, b);
@ -2136,18 +2221,20 @@ function compareComparableValues(a: string | number | undefined, b: string | num
Comparison.GreaterThan;
}
/** @internal */
/**
* Compare two numeric values for their order relative to each other.
* To compare strings, use any of the `compareStrings` functions.
*
* @internal
*/
export function compareValues(a: number | undefined, b: number | undefined): Comparison {
return compareComparableValues(a, b);
}
/** @internal */
/**
* Compare two TextSpans, first by `start`, then by `length`.
*
* @internal
*/
export function compareTextSpans(a: Partial<TextSpan> | undefined, b: Partial<TextSpan> | undefined): Comparison {
return compareValues(a?.start, b?.start) || compareValues(a?.length, b?.length);
@ -2162,7 +2249,6 @@ export function min<T>(items: readonly T[], compare: Comparer<T>): T | undefined
return reduceLeft(items, (x, y) => compare(x, y) === Comparison.LessThan ? x : y);
}
/** @internal */
/**
* Compare two strings using a case-insensitive ordinal comparison.
*
@ -2174,6 +2260,8 @@ export function min<T>(items: readonly T[], compare: Comparer<T>): T | undefined
* value of each code-point after applying `toUpperCase` to each string. We always map both
* strings to their upper-case form as some unicode characters do not properly round-trip to
* lowercase (such as `ẞ` (German sharp capital s)).
*
* @internal
*/
export function compareStringsCaseInsensitive(a: string, b: string) {
if (a === b) return Comparison.EqualTo;
@ -2184,7 +2272,6 @@ export function compareStringsCaseInsensitive(a: string, b: string) {
return a < b ? Comparison.LessThan : a > b ? Comparison.GreaterThan : Comparison.EqualTo;
}
/** @internal */
/**
* Compare two strings using a case-sensitive ordinal comparison.
*
@ -2194,6 +2281,8 @@ export function compareStringsCaseInsensitive(a: string, b: string) {
*
* Case-sensitive comparisons compare both strings one code-point at a time using the integer
* value of each code-point.
*
* @internal
*/
export function compareStringsCaseSensitive(a: string | undefined, b: string | undefined): Comparison {
return compareComparableValues(a, b);
@ -2308,7 +2397,6 @@ export function setUILocale(value: string | undefined) {
}
}
/** @internal */
/**
* Compare two strings in a using the case-sensitive sort behavior of the UI locale.
*
@ -2318,6 +2406,8 @@ export function setUILocale(value: string | undefined) {
*
* Case-sensitive comparisons compare strings that differ in base characters, or
* accents/diacritic marks, or case as unequal.
*
* @internal
*/
export function compareStringsCaseSensitiveUI(a: string, b: string) {
const comparer = uiComparerCaseSensitive || (uiComparerCaseSensitive = createUIStringComparer(uiLocale));
@ -2332,13 +2422,16 @@ export function compareProperties<T extends object, K extends keyof T>(a: T | un
comparer(a[key], b[key]);
}
/** @internal */
/** True is greater than false. */
/**
* True is greater than false.
*
* @internal
*/
export function compareBooleans(a: boolean, b: boolean): Comparison {
return compareValues(a ? 1 : 0, b ? 1 : 0);
}
/** @internal */
/**
* Given a name and a list of names that are *not* equal to the name, return a spelling suggestion if there is one that is close enough.
* Names less than length 3 only check for case-insensitive equality.
@ -2350,6 +2443,8 @@ export function compareBooleans(a: boolean, b: boolean): Comparison {
* * Whose levenshtein distance is more than 0.4 of the length of the name
* (0.4 allows 1 substitution/transposition for every 5 characters,
* and 1 insertion/deletion at 3 characters)
*
* @internal
*/
export function getSpellingSuggestion<T>(name: string, candidates: T[], getName: (candidate: T) => string | undefined): T | undefined {
const maximumLengthDifference = Math.max(2, Math.floor(name.length * 0.34));
@ -2449,9 +2544,10 @@ export function stringContains(str: string, substring: string): boolean {
return str.indexOf(substring) !== -1;
}
/** @internal */
/**
* Takes a string like "jquery-min.4.2.3" and returns "jquery"
*
* @internal
*/
export function removeMinAndVersionNumbers(fileName: string) {
// We used to use the regex /[.-]((min)|(\d+(\.\d+)*))$/ and would just .replace it twice.
@ -2501,8 +2597,11 @@ export function removeMinAndVersionNumbers(fileName: string) {
return end === fileName.length ? fileName : fileName.slice(0, end);
}
/** @internal */
/** Remove an item from an array, moving everything to its right one space left. */
/**
* Remove an item from an array, moving everything to its right one space left.
*
* @internal
*/
export function orderedRemoveItem<T>(array: T[], item: T): boolean {
for (let i = 0; i < array.length; i++) {
if (array[i] === item) {
@ -2513,8 +2612,11 @@ export function orderedRemoveItem<T>(array: T[], item: T): boolean {
return false;
}
/** @internal */
/** Remove an item by index from an array, moving everything to its right one space left. */
/**
* Remove an item by index from an array, moving everything to its right one space left.
*
* @internal
*/
export function orderedRemoveItemAt<T>(array: T[], index: number): void {
// This seems to be faster than either `array.splice(i, 1)` or `array.copyWithin(i, i+ 1)`.
for (let i = index; i < array.length - 1; i++) {
@ -2530,8 +2632,11 @@ export function unorderedRemoveItemAt<T>(array: T[], index: number): void {
array.pop();
}
/** @internal */
/** Remove the *first* occurrence of `item` from the array. */
/**
* Remove the *first* occurrence of `item` from the array.
*
* @internal
*/
export function unorderedRemoveItem<T>(array: T[], item: T) {
return unorderedRemoveFirstItemWhere(array, element => element === item);
}
@ -2554,8 +2659,11 @@ export function createGetCanonicalFileName(useCaseSensitiveFileNames: boolean):
return useCaseSensitiveFileNames ? identity : toFileNameLowerCase;
}
/** @internal */
/** Represents a "prefix*suffix" pattern. */
/**
* Represents a "prefix*suffix" pattern.
*
* @internal
*/
export interface Pattern {
prefix: string;
suffix: string;
@ -2566,18 +2674,22 @@ export function patternText({ prefix, suffix }: Pattern): string {
return `${prefix}*${suffix}`;
}
/** @internal */
/**
* Given that candidate matches pattern, returns the text matching the '*'.
* E.g.: matchedText(tryParsePattern("foo*baz"), "foobarbaz") === "bar"
*
* @internal
*/
export function matchedText(pattern: Pattern, candidate: string): string {
Debug.assert(isPatternMatch(pattern, candidate));
return candidate.substring(pattern.prefix.length, candidate.length - pattern.suffix.length);
}
/** @internal */
/** Return the object corresponding to the best pattern to match `candidate`. */
/**
* Return the object corresponding to the best pattern to match `candidate`.
*
* @internal
*/
export function findBestPatternMatch<T>(values: readonly T[], getPattern: (value: T) => Pattern, candidate: string): T | undefined {
let matchedValue: T | undefined;
// use length of prefix as betterness criteria
@ -2729,25 +2841,27 @@ function cartesianProductWorker<T>(arrays: readonly (readonly T[])[], result: (r
}
/** @internal */
/**
* Returns string left-padded with spaces or zeros until it reaches the given length.
*
* @param s String to pad.
* @param length Final padded length. If less than or equal to 's.length', returns 's' unchanged.
* @param padString Character to use as padding (default " ").
*
* @internal
*/
export function padLeft(s: string, length: number, padString: " " | "0" = " ") {
return length <= s.length ? s : padString.repeat(length - s.length) + s;
}
/** @internal */
/**
* Returns string right-padded with spaces until it reaches the given length.
*
* @param s String to pad.
* @param length Final padded length. If less than or equal to 's.length', returns 's' unchanged.
* @param padString Character to use as padding (default " ").
*
* @internal
*/
export function padRight(s: string, length: number, padString: " " = " ") {
return length <= s.length ? s : s + padString.repeat(length - s.length);
@ -2765,21 +2879,24 @@ export function takeWhile<T>(array: readonly T[], predicate: (element: T) => boo
return array.slice(0, index);
}
/** @internal */
/**
* Removes the leading and trailing white space and line terminator characters from a string.
*
* @internal
*/
export const trimString = !!String.prototype.trim ? ((s: string) => s.trim()) : (s: string) => trimStringEnd(trimStringStart(s));
/** @internal */
/**
* Returns a copy with trailing whitespace removed.
*
* @internal
*/
export const trimStringEnd = !!String.prototype.trimEnd ? ((s: string) => s.trimEnd()) : trimEndImpl;
/** @internal */
/**
* Returns a copy with leading whitespace removed.
*
* @internal
*/
export const trimStringStart = !!String.prototype.trimStart ? ((s: string) => s.trimStart()) : (s: string) => s.replace(/^\s+/g, "");

18
src/compiler/corePublic.ts
View File

@ -61,7 +61,7 @@ export interface ESMap<K, V> extends ReadonlyESMap<K, V>, Collection<K> {
export interface Map<T> extends ESMap<string, T> {
}
/* @internal */
/** @internal */
export interface MapConstructor {
// eslint-disable-next-line @typescript-eslint/prefer-function-type
new <K, V>(iterable?: readonly (readonly [K, V])[] | ReadonlyESMap<K, V>): ESMap<K, V>;
@ -81,7 +81,7 @@ export interface Set<T> extends ReadonlySet<T>, Collection<T> {
delete(value: T): boolean;
}
/* @internal */
/** @internal */
export interface SetConstructor {
// eslint-disable-next-line @typescript-eslint/prefer-function-type
new <T>(iterable?: readonly T[] | ReadonlySet<T>): Set<T>;
@ -95,23 +95,23 @@ export interface Iterator<T> {
/** Array that is only intended to be pushed to, never read. */
export interface Push<T> {
push(...values: T[]): void;
/* @internal*/ readonly length: number;
/** @internal */ readonly length: number;
}
/* @internal */
/** @internal */
export type EqualityComparer<T> = (a: T, b: T) => boolean;
/* @internal */
/** @internal */
export type Comparer<T> = (a: T, b: T) => Comparison;
/* @internal */
/** @internal */
export const enum Comparison {
LessThan = -1,
EqualTo = 0,
GreaterThan = 1
}
/* @internal */
/** @internal */
namespace NativeCollections {
declare const self: any;
@ -149,7 +149,7 @@ namespace NativeCollections {
}
}
/* @internal */
/** @internal */
export const Map = NativeCollections.tryGetNativeMap();
/* @internal */
/** @internal */
export const Set = NativeCollections.tryGetNativeSet();

40
src/compiler/emitter.ts
View File

@ -82,12 +82,11 @@ import {
const brackets = createBracketsMap();
/*@internal*/
/** @internal */
export function isBuildInfoFile(file: string) {
return fileExtensionIs(file, Extension.TsBuildInfo);
}
/*@internal*/
/**
* Iterates over the source files that are expected to have an emit output.
*
@ -96,6 +95,8 @@ export function isBuildInfoFile(file: string) {
* @param sourceFilesOrTargetSourceFile
* If an array, the full list of source files to emit.
* Else, calls `getSourceFilesToEmit` with the (optional) target source file to determine the list of source files to emit.
*
* @internal
*/
export function forEachEmittedFile<T>(
host: EmitHost, action: (emitFileNames: EmitFileNames, sourceFileOrBundle: SourceFile | Bundle | undefined) => T,
@ -152,7 +153,7 @@ export function getTsBuildInfoEmitOutputFilePath(options: CompilerOptions) {
return buildInfoExtensionLess + Extension.TsBuildInfo;
}
/*@internal*/
/** @internal */
export function getOutputPathsForBundle(options: CompilerOptions, forceDtsPaths: boolean): EmitFileNames {
const outPath = outFile(options)!;
const jsFilePath = options.emitDeclarationOnly ? undefined : outPath;
@ -163,7 +164,7 @@ export function getOutputPathsForBundle(options: CompilerOptions, forceDtsPaths:
return { jsFilePath, sourceMapFilePath, declarationFilePath, declarationMapPath, buildInfoPath };
}
/*@internal*/
/** @internal */
export function getOutputPathsFor(sourceFile: SourceFile | Bundle, host: EmitHost, forceDtsPaths: boolean): EmitFileNames {
const options = host.getCompilerOptions();
if (sourceFile.kind === SyntaxKind.Bundle) {
@ -187,7 +188,7 @@ function getSourceMapFilePath(jsFilePath: string, options: CompilerOptions) {
return (options.sourceMap && !options.inlineSourceMap) ? jsFilePath + ".map" : undefined;
}
/* @internal */
/** @internal */
export function getOutputExtension(fileName: string, options: CompilerOptions): Extension {
return fileExtensionIs(fileName, Extension.Json) ? Extension.Json :
options.jsx === JsxEmit.Preserve && fileExtensionIsOneOf(fileName, [Extension.Jsx, Extension.Tsx]) ? Extension.Jsx :
@ -205,7 +206,7 @@ function getOutputPathWithoutChangingExt(inputFileName: string, configFile: Pars
inputFileName;
}
/* @internal */
/** @internal */
export function getOutputDeclarationFileName(inputFileName: string, configFile: ParsedCommandLine, ignoreCase: boolean, getCommonSourceDirectory?: () => string) {
return changeExtension(
getOutputPathWithoutChangingExt(inputFileName, configFile, ignoreCase, configFile.options.declarationDir || configFile.options.outDir, getCommonSourceDirectory),
@ -264,7 +265,7 @@ function getOwnOutputFileNames(configFile: ParsedCommandLine, inputFileName: str
}
}
/*@internal*/
/** @internal */
export function getCommonSourceDirectory(
options: CompilerOptions,
emittedFiles: () => readonly string[],
@ -296,7 +297,7 @@ export function getCommonSourceDirectory(
return commonSourceDirectory;
}
/*@internal*/
/** @internal */
export function getCommonSourceDirectoryOfConfig({ options, fileNames }: ParsedCommandLine, ignoreCase: boolean): string {
return getCommonSourceDirectory(
options,
@ -306,7 +307,7 @@ export function getCommonSourceDirectoryOfConfig({ options, fileNames }: ParsedC
);
}
/*@internal*/
/** @internal */
export function getAllProjectOutputs(configFile: ParsedCommandLine, ignoreCase: boolean): readonly string[] {
const { addOutput, getOutputs } = createAddOutput();
if (outFile(configFile.options)) {
@ -335,7 +336,7 @@ export function getOutputFileNames(commandLine: ParsedCommandLine, inputFileName
return getOutputs();
}
/*@internal*/
/** @internal */
export function getFirstProjectOutput(configFile: ParsedCommandLine, ignoreCase: boolean): string {
if (outFile(configFile.options)) {
const { jsFilePath, declarationFilePath } = getOutputPathsForBundle(configFile.options, /*forceDtsPaths*/ false);
@ -357,7 +358,7 @@ export function getFirstProjectOutput(configFile: ParsedCommandLine, ignoreCase:
return Debug.fail(`project ${configFile.options.configFilePath} expected to have at least one output`);
}
/*@internal*/
/** @internal */
// targetSourceFile is when users only want one file in entire project to be emitted. This is used in compileOnSave feature
export function emitFiles(resolver: EmitResolver, host: EmitHost, targetSourceFile: SourceFile | undefined, { scriptTransformers, declarationTransformers }: EmitTransformers, emitOnly?: boolean | EmitOnly, onlyBuildInfo?: boolean, forceDtsEmit?: boolean): EmitResult {
const compilerOptions = host.getCompilerOptions();
@ -727,23 +728,23 @@ export function emitFiles(resolver: EmitResolver, host: EmitHost, targetSourceFi
}
}
/*@internal*/
/** @internal */
export function createBuildInfo(program: ProgramBuildInfo | undefined, bundle: BundleBuildInfo | undefined): BuildInfo {
const version = ts.version; // Extracted into a const so the form is stable between namespace and module
return { bundle, program, version };
}
/*@internal*/
/** @internal */
export function getBuildInfoText(buildInfo: BuildInfo) {
return JSON.stringify(buildInfo);
}
/*@internal*/
/** @internal */
export function getBuildInfo(buildInfoFile: string, buildInfoText: string) {
return readJsonOrUndefined(buildInfoFile, buildInfoText) as BuildInfo | undefined;
}
/*@internal*/
/** @internal */
export const notImplementedResolver: EmitResolver = {
hasGlobalName: notImplemented,
getReferencedExportContainer: notImplemented,
@ -788,8 +789,11 @@ export const notImplementedResolver: EmitResolver = {
isImportRequiredByAugmentation: notImplemented,
};
/*@internal*/
/** File that isnt present resulting in error or output files */
/**
* File that isnt present resulting in error or output files
*
* @internal
*/
export type EmitUsingBuildInfoResult = string | readonly OutputFile[];
function createSourceFilesFromBundleBuildInfo(bundle: BundleBuildInfo, buildInfoDirectory: string, host: CompilerHost): readonly SourceFile[] {
@ -819,7 +823,7 @@ function createSourceFilesFromBundleBuildInfo(bundle: BundleBuildInfo, buildInfo
});
}
/*@internal*/
/** @internal */
export function emitUsingBuildInfo(
config: ParsedCommandLine,
host: CompilerHost,

6
src/compiler/factory/baseNodeFactory.ts
View File

@ -3,8 +3,9 @@ import { Node, objectAllocator, SyntaxKind } from "../_namespaces/ts";
/**
* A `BaseNodeFactory` is an abstraction over an `ObjectAllocator` that handles caching `Node` constructors
* and allocating `Node` instances based on a set of predefined types.
*
* @internal
*/
/* @internal */
export interface BaseNodeFactory {
createBaseSourceFileNode(kind: SyntaxKind): Node;
createBaseIdentifierNode(kind: SyntaxKind): Node;
@ -13,9 +14,10 @@ export interface BaseNodeFactory {
createBaseNode(kind: SyntaxKind): Node;
}
/** @internal */
/**
* Creates a `BaseNodeFactory` which can be used to create `Node` instances from the constructors provided by the object allocator.
*
* @internal
*/
export function createBaseNodeFactory(): BaseNodeFactory {
let NodeConstructor: new (kind: SyntaxKind, pos?: number, end?: number) => Node;

14
src/compiler/factory/emitHelpers.ts
View File

@ -412,7 +412,7 @@ export function createEmitHelperFactory(context: TransformationContext): EmitHel
}
}
/* @internal */
/** @internal */
export function compareEmitHelpers(x: EmitHelper, y: EmitHelper) {
if (x === y) return Comparison.EqualTo;
if (x.priority === y.priority) return Comparison.EqualTo;
@ -421,10 +421,11 @@ export function compareEmitHelpers(x: EmitHelper, y: EmitHelper) {
return compareValues(x.priority, y.priority);
}
/** @internal */
/**
* @param input Template string input strings
* @param args Names which need to be made file-level unique
*
* @internal
*/
export function helperString(input: TemplateStringsArray, ...args: string[]) {
return (uniqueName: EmitHelperUniqueNameCallback) => {
@ -880,7 +881,6 @@ export const exportStarHelper: UnscopedEmitHelper = {
};`
};
/** @internal */
/**
* Parameters:
* @param receiver — The object from which the private member will be read.
@ -928,6 +928,8 @@ export const exportStarHelper: UnscopedEmitHelper = {
*
* Reading from a private static method (TS 4.3+):
* __classPrivateFieldGet(<any>, <constructor>, "m", <function>)
*
* @internal
*/
export const classPrivateFieldGetHelper: UnscopedEmitHelper = {
name: "typescript:classPrivateFieldGet",
@ -941,7 +943,6 @@ export const classPrivateFieldGetHelper: UnscopedEmitHelper = {
};`
};
/** @internal */
/**
* Parameters:
* @param receiver — The object on which the private member will be set.
@ -992,6 +993,8 @@ export const classPrivateFieldGetHelper: UnscopedEmitHelper = {
* Writing to a private static method (TS 4.3+):
* __classPrivateFieldSet(<any>, <constructor>, <any>, "m", <function>)
* NOTE: This always results in a runtime error.
*
* @internal
*/
export const classPrivateFieldSetHelper: UnscopedEmitHelper = {
name: "typescript:classPrivateFieldSet",
@ -1006,7 +1009,6 @@ export const classPrivateFieldSetHelper: UnscopedEmitHelper = {
};`
};
/** @internal */
/**
* Parameters:
* @param state — One of the following:
@ -1018,6 +1020,8 @@ export const classPrivateFieldSetHelper: UnscopedEmitHelper = {
* Usage:
* This helper is used to transform `#field in expression` to
* `__classPrivateFieldIn(<weakMap/weakSet/constructor>, expression)`
*
* @internal
*/
export const classPrivateFieldInHelper: UnscopedEmitHelper = {
name: "typescript:classPrivateFieldIn",

21
src/compiler/factory/emitNode.ts
View File

@ -72,8 +72,9 @@ export function setEmitFlags<T extends Node>(node: T, emitFlags: EmitFlags) {
/**
* Sets flags that control emit behavior of a node.
*
* @internal
*/
/* @internal */
export function addEmitFlags<T extends Node>(node: T, emitFlags: EmitFlags) {
const emitNode = getOrCreateEmitNode(node);
emitNode.flags = emitNode.flags | emitFlags;
@ -114,16 +115,18 @@ export function setTokenSourceMapRange<T extends Node>(node: T, token: SyntaxKin
/**
* Gets a custom text range to use when emitting comments.
*
* @internal
*/
/*@internal*/
export function getStartsOnNewLine(node: Node) {
return node.emitNode?.startsOnNewLine;
}
/**
* Sets a custom text range to use when emitting comments.
*
* @internal
*/
/*@internal*/
export function setStartsOnNewLine<T extends Node>(node: T, newLine: boolean) {
getOrCreateEmitNode(node).startsOnNewLine = newLine;
return node;
@ -263,36 +266,38 @@ export function moveEmitHelpers(source: Node, target: Node, predicate: (helper:
/**
* Gets the SnippetElement of a node.
*
* @internal
*/
/* @internal */
export function getSnippetElement(node: Node): SnippetElement | undefined {
return node.emitNode?.snippetElement;
}
/**
* Sets the SnippetElement of a node.
*
* @internal
*/
/* @internal */
export function setSnippetElement<T extends Node>(node: T, snippet: SnippetElement): T {
const emitNode = getOrCreateEmitNode(node);
emitNode.snippetElement = snippet;
return node;
}
/* @internal */
/** @internal */
export function ignoreSourceNewlines<T extends Node>(node: T): T {
getOrCreateEmitNode(node).flags |= EmitFlags.IgnoreSourceNewlines;
return node;
}
/* @internal */
/** @internal */
export function setTypeNode<T extends Node>(node: T, type: TypeNode): T {
const emitNode = getOrCreateEmitNode(node);
emitNode.typeNode = type;
return node;
}
/* @internal */
/** @internal */
export function getTypeNode<T extends Node>(node: T): TypeNode | undefined {
return node.emitNode?.typeNode;
}

2
src/compiler/factory/nodeConverters.ts
View File

@ -142,4 +142,4 @@ export const nullNodeConverters: NodeConverters = {
convertToObjectAssignmentPattern: notImplemented,
convertToArrayAssignmentPattern: notImplemented,
convertToAssignmentElementTarget: notImplemented,
};
};

14
src/compiler/factory/nodeFactory.ts
View File

@ -82,7 +82,7 @@ import {
let nextAutoGenerateId = 0;
/* @internal */
/** @internal */
export const enum NodeFactoryFlags {
None = 0,
// Disables the parenthesizer rules for the factory.
@ -97,7 +97,7 @@ export const enum NodeFactoryFlags {
const nodeFactoryPatchers: ((factory: NodeFactory) => void)[] = [];
/* @internal */
/** @internal */
export function addNodeFactoryPatcher(fn: (factory: NodeFactory) => void) {
nodeFactoryPatchers.push(fn);
}
@ -106,8 +106,9 @@ export function addNodeFactoryPatcher(fn: (factory: NodeFactory) => void) {
* Creates a `NodeFactory` that can be used to create and update a syntax tree.
* @param flags Flags that control factory behavior.
* @param baseFactory A `BaseNodeFactory` used to create the base `Node` objects.
*
* @internal
*/
/* @internal */
export function createNodeFactory(flags: NodeFactoryFlags, baseFactory: BaseNodeFactory): NodeFactory {
const update = flags & NodeFactoryFlags.NoOriginalNode ? updateWithoutOriginal : updateWithOriginal;
@ -6565,8 +6566,9 @@ function aggregateChildrenFlags(children: MutableNodeArray<Node>) {
/**
* Gets the transform flags to exclude when unioning the transform flags of a subtree.
*
* @internal
*/
/* @internal */
export function getTransformFlagsSubtreeExclusions(kind: SyntaxKind) {
if (kind >= SyntaxKind.FirstTypeNode && kind <= SyntaxKind.LastTypeNode) {
return TransformFlags.TypeExcludes;
@ -6876,7 +6878,7 @@ export function createInputFiles(
declarationMapTextOrBuildInfoPath,
);
}
/*@internal*/
/** @internal */
export function createInputFilesWithFilePaths(
readFileText: (path: string) => string | undefined,
javascriptPath: string,
@ -6929,7 +6931,7 @@ export function createInputFilesWithFilePaths(
});
return node;
}
/*@internal*/
/** @internal */
export function createInputFilesWithFileTexts(
javascriptPath: string | undefined,
javascriptText: string,

42
src/compiler/factory/nodeTests.ts
View File

@ -85,7 +85,7 @@ export function isDotDotDotToken(node: Node): node is DotDotDotToken {
return node.kind === SyntaxKind.DotDotDotToken;
}
/*@internal*/
/** @internal */
export function isCommaToken(node: Node): node is Token<SyntaxKind.CommaToken> {
return node.kind === SyntaxKind.CommaToken;
}
@ -102,27 +102,27 @@ export function isAsteriskToken(node: Node): node is AsteriskToken {
return node.kind === SyntaxKind.AsteriskToken;
}
/*@internal*/
/** @internal */
export function isExclamationToken(node: Node): node is ExclamationToken {
return node.kind === SyntaxKind.ExclamationToken;
}
/*@internal*/
/** @internal */
export function isQuestionToken(node: Node): node is QuestionToken {
return node.kind === SyntaxKind.QuestionToken;
}
/*@internal*/
/** @internal */
export function isColonToken(node: Node): node is ColonToken {
return node.kind === SyntaxKind.ColonToken;
}
/*@internal*/
/** @internal */
export function isQuestionDotToken(node: Node): node is QuestionDotToken {
return node.kind === SyntaxKind.QuestionDotToken;
}
/*@internal*/
/** @internal */
export function isEqualsGreaterThanToken(node: Node): node is EqualsGreaterThanToken {
return node.kind === SyntaxKind.EqualsGreaterThanToken;
}
@ -139,57 +139,57 @@ export function isPrivateIdentifier(node: Node): node is PrivateIdentifier {
// Reserved Words
/* @internal */
/** @internal */
export function isExportModifier(node: Node): node is ExportKeyword {
return node.kind === SyntaxKind.ExportKeyword;
}
/* @internal */
/** @internal */
export function isAsyncModifier(node: Node): node is AsyncKeyword {
return node.kind === SyntaxKind.AsyncKeyword;
}
/* @internal */
/** @internal */
export function isAssertsKeyword(node: Node): node is AssertsKeyword {
return node.kind === SyntaxKind.AssertsKeyword;
}
/* @internal */
/** @internal */
export function isAwaitKeyword(node: Node): node is AwaitKeyword {
return node.kind === SyntaxKind.AwaitKeyword;
}
/* @internal */
/** @internal */
export function isReadonlyKeyword(node: Node): node is ReadonlyKeyword {
return node.kind === SyntaxKind.ReadonlyKeyword;
}
/* @internal */
/** @internal */
export function isStaticModifier(node: Node): node is StaticKeyword {
return node.kind === SyntaxKind.StaticKeyword;
}
/* @internal */
/** @internal */
export function isAbstractModifier(node: Node): node is AbstractKeyword {
return node.kind === SyntaxKind.AbstractKeyword;
}
/* @internal */
/** @internal */
export function isOverrideModifier(node: Node): node is OverrideKeyword {
return node.kind === SyntaxKind.OverrideKeyword;
}
/* @internal */
/** @internal */
export function isAccessorModifier(node: Node): node is AccessorKeyword {
return node.kind === SyntaxKind.AccessorKeyword;
}
/*@internal*/
/** @internal */
export function isSuperKeyword(node: Node): node is SuperExpression {
return node.kind === SyntaxKind.SuperKeyword;
}
/*@internal*/
/** @internal */
export function isImportKeyword(node: Node): node is ImportExpression {
return node.kind === SyntaxKind.ImportKeyword;
}
@ -703,17 +703,17 @@ export function isNotEmittedStatement(node: Node): node is NotEmittedStatement {
return node.kind === SyntaxKind.NotEmittedStatement;
}
/* @internal */
/** @internal */
export function isSyntheticReference(node: Node): node is SyntheticReferenceExpression {
return node.kind === SyntaxKind.SyntheticReferenceExpression;
}
/* @internal */
/** @internal */
export function isMergeDeclarationMarker(node: Node): node is MergeDeclarationMarker {
return node.kind === SyntaxKind.MergeDeclarationMarker;
}
/* @internal */
/** @internal */
export function isEndOfDeclarationMarker(node: Node): node is EndOfDeclarationMarker {
return node.kind === SyntaxKind.EndOfDeclarationMarker;
}
@ -993,7 +993,7 @@ export function isJSDocImplementsTag(node: Node): node is JSDocImplementsTag {
// Synthesized list
/* @internal */
/** @internal */
export function isSyntaxList(n: Node): n is SyntaxList {
return n.kind === SyntaxKind.SyntaxList;
}

68
src/compiler/factory/utilities.ts
View File

@ -343,7 +343,6 @@ export function createExpressionForObjectLiteralElementLike(factory: NodeFactory
}
}
/** @internal */
/**
* Expand the read and increment/decrement operations a pre- or post-increment or pre- or post-decrement expression.
*
@ -375,6 +374,8 @@ export function createExpressionForObjectLiteralElementLike(factory: NodeFactory
* @param node The original prefix or postfix unary node.
* @param expression The expression to use as the value to increment or decrement
* @param resultVariable A temporary variable in which to store the result. Pass `undefined` if the result is discarded, or if the value of `<temp>` is the expected result.
*
* @internal
*/
export function expandPreOrPostfixIncrementOrDecrementExpression(factory: NodeFactory, node: PrefixUnaryExpression | PostfixUnaryExpression, expression: Expression, recordTempVariable: (node: Identifier) => void, resultVariable: Identifier | undefined) {
const operator = node.operator;
@ -405,26 +406,29 @@ export function expandPreOrPostfixIncrementOrDecrementExpression(factory: NodeFa
return expression;
}
/** @internal */
/**
* Gets whether an identifier should only be referred to by its internal name.
*
* @internal
*/
export function isInternalName(node: Identifier) {
return (getEmitFlags(node) & EmitFlags.InternalName) !== 0;
}
/** @internal */
/**
* Gets whether an identifier should only be referred to by its local name.
*
* @internal
*/
export function isLocalName(node: Identifier) {
return (getEmitFlags(node) & EmitFlags.LocalName) !== 0;
}
/** @internal */
/**
* Gets whether an identifier should only be referred to by its export representation if the
* name points to an exported symbol.
*
* @internal
*/
export function isExportName(node: Identifier) {
return (getEmitFlags(node) & EmitFlags.ExportName) !== 0;
@ -623,9 +627,10 @@ export function getOrCreateExternalHelpersModuleNameIfNeeded(factory: NodeFactor
}
}
/** @internal */
/**
* Get the name of that target module from an import or export declaration
*
* @internal
*/
export function getLocalNameForExternalImport(factory: NodeFactory, node: ImportDeclaration | ExportDeclaration | ImportEqualsDeclaration, sourceFile: SourceFile): Identifier | undefined {
const namespaceDeclaration = getNamespaceDeclarationNode(node);
@ -642,7 +647,6 @@ export function getLocalNameForExternalImport(factory: NodeFactory, node: Import
return undefined;
}
/** @internal */
/**
* Get the name of a target module from an import/export declaration as should be written in the emitted output.
* The emitted output name can be different from the input if:
@ -650,6 +654,8 @@ export function getLocalNameForExternalImport(factory: NodeFactory, node: Import
* 2. --out or --outFile is used, making the name relative to the rootDir
* 3- The containing SourceFile has an entry in renamedDependencies for the import as requested by some module loaders (e.g. System).
* Otherwise, a new StringLiteral node representing the module name will be returned.
*
* @internal
*/
export function getExternalModuleNameLiteral(factory: NodeFactory, importNode: ImportDeclaration | ExportDeclaration | ImportEqualsDeclaration | ImportCall, sourceFile: SourceFile, host: EmitHost, resolver: EmitResolver, compilerOptions: CompilerOptions) {
const moduleName = getExternalModuleName(importNode);
@ -671,13 +677,14 @@ function tryRenameExternalModule(factory: NodeFactory, moduleName: LiteralExpres
return rename ? factory.createStringLiteral(rename) : undefined;
}
/** @internal */
/**
* Get the name of a module as should be written in the emitted output.
* The emitted output name can be different from the input if:
* 1. The module has a /// <amd-module name="<new name>" />
* 2. --out or --outFile is used, making the name relative to the rootDir
* Otherwise, a new StringLiteral node representing the module name will be returned.
*
* @internal
*/
export function tryGetModuleNameFromFile(factory: NodeFactory, file: SourceFile | undefined, host: EmitHost, options: CompilerOptions): StringLiteral | undefined {
if (!file) {
@ -696,9 +703,10 @@ function tryGetModuleNameFromDeclaration(declaration: ImportEqualsDeclaration |
return tryGetModuleNameFromFile(factory, resolver.getExternalModuleFileFromDeclaration(declaration), host, compilerOptions);
}
/** @internal */
/**
* Gets the initializer of an BindingOrAssignmentElement.
*
* @internal
*/
export function getInitializerOfBindingOrAssignmentElement(bindingElement: BindingOrAssignmentElement): Expression | undefined {
if (isDeclarationBindingElement(bindingElement)) {
@ -740,9 +748,10 @@ export function getInitializerOfBindingOrAssignmentElement(bindingElement: Bindi
}
}
/** @internal */
/**
* Gets the name of an BindingOrAssignmentElement.
*
* @internal
*/
export function getTargetOfBindingOrAssignmentElement(bindingElement: BindingOrAssignmentElement): BindingOrAssignmentElementTarget | undefined {
if (isDeclarationBindingElement(bindingElement)) {
@ -816,9 +825,10 @@ export function getTargetOfBindingOrAssignmentElement(bindingElement: BindingOrA
return bindingElement;
}
/** @internal */
/**
* Determines whether an BindingOrAssignmentElement is a rest element.
*
* @internal
*/
export function getRestIndicatorOfBindingOrAssignmentElement(bindingElement: BindingOrAssignmentElement): BindingOrAssignmentElementRestIndicator | undefined {
switch (bindingElement.kind) {
@ -836,9 +846,10 @@ export function getRestIndicatorOfBindingOrAssignmentElement(bindingElement: Bin
return undefined;
}
/** @internal */
/**
* Gets the property name of a BindingOrAssignmentElement
*
* @internal
*/
export function getPropertyNameOfBindingOrAssignmentElement(bindingElement: BindingOrAssignmentElement): Exclude<PropertyName, PrivateIdentifier> | undefined {
const propertyName = tryGetPropertyNameOfBindingOrAssignmentElement(bindingElement);
@ -903,9 +914,10 @@ function isStringOrNumericLiteral(node: Node): node is StringLiteral | NumericLi
|| kind === SyntaxKind.NumericLiteral;
}
/** @internal */
/**
* Gets the elements of a BindingOrAssignmentPattern
*
* @internal
*/
export function getElementsOfBindingOrAssignmentPattern(name: BindingOrAssignmentPattern): readonly BindingOrAssignmentElement[] {
switch (name.kind) {
@ -922,7 +934,7 @@ export function getElementsOfBindingOrAssignmentPattern(name: BindingOrAssignmen
}
}
/* @internal */
/** @internal */
export function getJSDocTypeAliasName(fullName: JSDocNamespaceBody | undefined) {
if (fullName) {
let rightNode = fullName;
@ -1256,7 +1268,6 @@ class BinaryExpressionStateMachine<TOuterState, TState, TResult> {
}
}
/** @internal */
/**
* Creates a state machine that walks a `BinaryExpression` using the heap to reduce call-stack depth on a large tree.
* @param onEnter Callback evaluated when entering a `BinaryExpression`. Returns new user-defined state to associate with the node while walking.
@ -1265,6 +1276,8 @@ class BinaryExpressionStateMachine<TOuterState, TState, TResult> {
* @param onExit Callback evaluated when exiting a `BinaryExpression`. The result returned will either be folded into the parent's state, or returned from the walker if at the top frame.
* @param foldState Callback evaluated when the result from a nested `onExit` should be folded into the state of that node's parent.
* @returns A function that walks a `BinaryExpression` node using the above callbacks, returning the result of the call to `onExit` from the outermost `BinaryExpression` node.
*
* @internal
*/
export function createBinaryExpressionTrampoline<TState, TResult>(
onEnter: (node: BinaryExpression, prev: TState | undefined) => TState,
@ -1274,7 +1287,6 @@ class BinaryExpressionStateMachine<TOuterState, TState, TResult> {
onExit: (node: BinaryExpression, userState: TState) => TResult,
foldState: ((userState: TState, result: TResult, side: "left" | "right") => TState) | undefined,
): (node: BinaryExpression) => TResult;
/** @internal */
/**
* Creates a state machine that walks a `BinaryExpression` using the heap to reduce call-stack depth on a large tree.
* @param onEnter Callback evaluated when entering a `BinaryExpression`. Returns new user-defined state to associate with the node while walking.
@ -1283,6 +1295,8 @@ class BinaryExpressionStateMachine<TOuterState, TState, TResult> {
* @param onExit Callback evaluated when exiting a `BinaryExpression`. The result returned will either be folded into the parent's state, or returned from the walker if at the top frame.
* @param foldState Callback evaluated when the result from a nested `onExit` should be folded into the state of that node's parent.
* @returns A function that walks a `BinaryExpression` node using the above callbacks, returning the result of the call to `onExit` from the outermost `BinaryExpression` node.
*
* @internal
*/
export function createBinaryExpressionTrampoline<TOuterState, TState, TResult>(
onEnter: (node: BinaryExpression, prev: TState | undefined, outerState: TOuterState) => TState,
@ -1332,9 +1346,10 @@ export function elideNodes<T extends Node>(factory: NodeFactory, nodes: NodeArra
return setTextRange(factory.createNodeArray([], nodes.hasTrailingComma), nodes);
}
/** @internal */
/**
* Gets the node from which a name should be generated.
*
* @internal
*/
export function getNodeForGeneratedName(name: GeneratedIdentifier | GeneratedPrivateIdentifier) {
if (name.autoGenerateFlags & GeneratedIdentifierFlags.Node) {
@ -1359,14 +1374,16 @@ export function getNodeForGeneratedName(name: GeneratedIdentifier | GeneratedPri
return name;
}
/** @internal */
/**
* Formats a prefix or suffix of a generated name.
*
* @internal
*/
export function formatGeneratedNamePart(part: string | undefined): string;
/** @internal */
/**
* Formats a prefix or suffix of a generated name. If the part is a {@link GeneratedNamePart}, calls {@link generateName} to format the source node.
*
* @internal
*/
export function formatGeneratedNamePart(part: string | GeneratedNamePart | undefined, generateName: (name: GeneratedIdentifier | GeneratedPrivateIdentifier) => string): string;
/** @internal */
@ -1388,16 +1405,16 @@ function formatIdentifierWorker(node: Identifier | PrivateIdentifier, generateNa
idText(node);
}
/** @internal */
/**
* Formats a generated name.
* @param privateName When `true`, inserts a `#` character at the start of the result.
* @param prefix The prefix (if any) to include before the base name.
* @param baseName The base name for the generated name.
* @param suffix The suffix (if any) to include after the base name.
*
* @internal
*/
export function formatGeneratedName(privateName: boolean, prefix: string | undefined, baseName: string, suffix: string | undefined): string;
/** @internal */
/**
* Formats a generated name.
* @param privateName When `true`, inserts a `#` character at the start of the result.
@ -1405,6 +1422,8 @@ export function formatGeneratedName(privateName: boolean, prefix: string | undef
* @param baseName The base name for the generated name.
* @param suffix The suffix (if any) to include after the base name.
* @param generateName Called to format the source node of {@link prefix} when it is a {@link GeneratedNamePart}.
*
* @internal
*/
export function formatGeneratedName(privateName: boolean, prefix: string | GeneratedNamePart | undefined, baseName: string | Identifier | PrivateIdentifier, suffix: string | GeneratedNamePart | undefined, generateName: (name: GeneratedIdentifier | GeneratedPrivateIdentifier) => string): string;
/** @internal */
@ -1416,9 +1435,10 @@ export function formatGeneratedName(privateName: boolean, prefix: string | Gener
}
/** @internal */
/**
* Creates a private backing field for an `accessor` {@link PropertyDeclaration}.
*
* @internal
*/
export function createAccessorPropertyBackingField(factory: NodeFactory, node: PropertyDeclaration, modifiers: ModifiersArray | undefined, initializer: Expression | undefined) {
return factory.updatePropertyDeclaration(
@ -1431,9 +1451,10 @@ export function createAccessorPropertyBackingField(factory: NodeFactory, node: P
);
}
/** @internal */
/**
* Creates a {@link GetAccessorDeclaration} that reads from a private backing field.
*
* @internal
*/
export function createAccessorPropertyGetRedirector(factory: NodeFactory, node: PropertyDeclaration, modifiers: ModifiersArray | undefined, name: PropertyName) {
return factory.createGetAccessorDeclaration(
@ -1452,9 +1473,10 @@ export function createAccessorPropertyGetRedirector(factory: NodeFactory, node:
);
}
/** @internal */
/**
* Creates a {@link SetAccessorDeclaration} that writes to a private backing field.
*
* @internal
*/
export function createAccessorPropertySetRedirector(factory: NodeFactory, node: PropertyDeclaration, modifiers: ModifiersArray | undefined, name: PropertyName) {
return factory.createSetAccessorDeclaration(

88
src/compiler/moduleNameResolver.ts
View File

@ -19,13 +19,13 @@ import {
tryParsePatterns, tryRemoveExtension, version, Version, versionMajorMinor, VersionRange,
} from "./_namespaces/ts";
/* @internal */
/** @internal */
export function trace(host: ModuleResolutionHost, message: DiagnosticMessage, ...args: any[]): void;
export function trace(host: ModuleResolutionHost): void {
host.trace!(formatMessage.apply(undefined, arguments));
}
/* @internal */
/** @internal */
export function isTraceEnabled(compilerOptions: CompilerOptions, host: ModuleResolutionHost): boolean {
return !!compilerOptions.traceResolution && host.trace !== undefined;
}
@ -127,7 +127,7 @@ function createResolvedModuleWithFailedLookupLocations(
};
}
/*@internal*/
/** @internal */
interface ModuleResolutionState {
host: ModuleResolutionHost;
compilerOptions: CompilerOptions;
@ -142,8 +142,10 @@ interface ModuleResolutionState {
reportDiagnostic: DiagnosticReporter;
}
/** Just the fields that we use for module resolution. */
/*@internal*/
/** Just the fields that we use for module resolution.
*
* @internal
*/
interface PackageJsonPathFields {
typings?: string;
types?: string;
@ -223,7 +225,7 @@ function readPackageJsonTypesVersionsField(jsonContent: PackageJson, state: Modu
return typesVersions;
}
/*@internal*/
/** @internal */
interface VersionPaths {
version: string;
paths: MapLike<string[]>;
@ -262,7 +264,7 @@ function readPackageJsonTypesVersionPaths(jsonContent: PackageJson, state: Modul
let typeScriptVersion: Version | undefined;
/* @internal */
/** @internal */
export function getPackageJsonTypesVersionsPaths(typesVersions: MapLike<MapLike<string[]>>) {
if (!typeScriptVersion) typeScriptVersion = new Version(version);
@ -565,7 +567,7 @@ export function getAutomaticTypeDirectiveNames(options: CompilerOptions, host: M
}
export interface TypeReferenceDirectiveResolutionCache extends PerDirectoryResolutionCache<ResolvedTypeReferenceDirectiveWithFailedLookupLocations>, PackageJsonInfoCache {
/*@internal*/ clearAllExceptPackageJsonInfoCache(): void;
/** @internal */ clearAllExceptPackageJsonInfoCache(): void;
}
export interface ModeAwareCache<T> {
@ -593,7 +595,7 @@ export interface PerDirectoryResolutionCache<T> {
export interface ModuleResolutionCache extends PerDirectoryResolutionCache<ResolvedModuleWithFailedLookupLocations>, NonRelativeModuleNameResolutionCache, PackageJsonInfoCache {
getPackageJsonInfoCache(): PackageJsonInfoCache;
/*@internal*/ clearAllExceptPackageJsonInfoCache(): void;
/** @internal */ clearAllExceptPackageJsonInfoCache(): void;
}
/**
@ -605,10 +607,10 @@ export interface NonRelativeModuleNameResolutionCache extends PackageJsonInfoCac
}
export interface PackageJsonInfoCache {
/*@internal*/ getPackageJsonInfo(packageJsonPath: string): PackageJsonInfo | boolean | undefined;
/*@internal*/ setPackageJsonInfo(packageJsonPath: string, info: PackageJsonInfo | boolean): void;
/*@internal*/ entries(): [Path, PackageJsonInfo | boolean][];
/*@internal*/ getInternalMap(): ESMap<Path, PackageJsonInfo | boolean> | undefined;
/** @internal */ getPackageJsonInfo(packageJsonPath: string): PackageJsonInfo | boolean | undefined;
/** @internal */ setPackageJsonInfo(packageJsonPath: string, info: PackageJsonInfo | boolean): void;
/** @internal */ entries(): [Path, PackageJsonInfo | boolean][];
/** @internal */ getInternalMap(): ESMap<Path, PackageJsonInfo | boolean> | undefined;
clear(): void;
}
@ -617,7 +619,7 @@ export interface PerModuleNameCache {
set(directory: string, result: ResolvedModuleWithFailedLookupLocations): void;
}
/*@internal*/
/** @internal */
export interface CacheWithRedirects<T> {
getOwnMap: () => ESMap<string, T>;
redirectsMap: ESMap<Path, ESMap<string, T>>;
@ -627,7 +629,7 @@ export interface CacheWithRedirects<T> {
setOwnMap(newOwnMap: ESMap<string, T>): void;
}
/*@internal*/
/** @internal */
export function createCacheWithRedirects<T>(options?: CompilerOptions): CacheWithRedirects<T> {
let ownMap: ESMap<string, T> = new Map();
const redirectsMap = new Map<Path, ESMap<string, T>>();
@ -752,7 +754,7 @@ function createPerDirectoryResolutionCache<T>(currentDirectory: string, getCanon
}
}
/* @internal */
/** @internal */
export function createModeAwareCache<T>(): ModeAwareCache<T> {
const underlying = new Map<ModeAwareCacheKey, T>();
type ModeAwareCacheKey = string & { __modeAwareCacheKey: any; };
@ -792,18 +794,18 @@ export function createModeAwareCache<T>(): ModeAwareCache<T> {
}
}
/* @internal */
/** @internal */
export function getResolutionName(entry: FileReference | StringLiteralLike) {
// We lower-case all type references because npm automatically lowercases all packages. See GH#9824.
return isStringLiteralLike(entry) ? entry.text : entry.fileName.toLowerCase();
}
/* @internal */
/** @internal */
export function getResolutionMode(entry: FileReference | StringLiteralLike, file: SourceFile) {
return isStringLiteralLike(entry) ? getModeForUsageLocation(file, entry) : entry.resolutionMode || file.impliedNodeFormat;
}
/* @internal */
/** @internal */
export function zipToModeAwareCache<V>(file: SourceFile, keys: readonly StringLiteralLike[] | readonly FileReference[], values: readonly V[]): ModeAwareCache<V> {
Debug.assert(keys.length === values.length);
const map = createModeAwareCache<V>();
@ -819,7 +821,7 @@ export function createModuleResolutionCache(
getCanonicalFileName: (s: string) => string,
options?: CompilerOptions
): ModuleResolutionCache;
/*@internal*/
/** @internal */
export function createModuleResolutionCache(
currentDirectory: string,
getCanonicalFileName: GetCanonicalFileName,
@ -946,7 +948,7 @@ export function createTypeReferenceDirectiveResolutionCache(
options?: CompilerOptions,
packageJsonInfoCache?: PackageJsonInfoCache,
): TypeReferenceDirectiveResolutionCache;
/*@internal*/
/** @internal */
export function createTypeReferenceDirectiveResolutionCache(
currentDirectory: string,
getCanonicalFileName: GetCanonicalFileName,
@ -1276,8 +1278,9 @@ function tryLoadModuleUsingBaseUrl(extensions: Extensions, moduleName: string, l
* Expose resolution logic to allow us to use Node module resolution logic from arbitrary locations.
* No way to do this with `require()`: https://github.com/nodejs/node/issues/5963
* Throws an error if the module can't be resolved.
*
* @internal
*/
/* @internal */
export function resolveJSModule(moduleName: string, initialDir: string, host: ModuleResolutionHost): string {
const { resolvedModule, failedLookupLocations } = tryResolveJSModuleWorker(moduleName, initialDir, host);
if (!resolvedModule) {
@ -1286,7 +1289,7 @@ export function resolveJSModule(moduleName: string, initialDir: string, host: Mo
return resolvedModule.resolvedFileName;
}
/* @internal */
/** @internal */
enum NodeResolutionFeatures {
None = 0,
// resolving `#local` names in your own package.json
@ -1358,7 +1361,7 @@ function tryResolveJSModuleWorker(moduleName: string, initialDir: string, host:
}
export function nodeModuleNameResolver(moduleName: string, containingFile: string, compilerOptions: CompilerOptions, host: ModuleResolutionHost, cache?: ModuleResolutionCache, redirectedReference?: ResolvedProjectReference): ResolvedModuleWithFailedLookupLocations;
/* @internal */ export function nodeModuleNameResolver(moduleName: string, containingFile: string, compilerOptions: CompilerOptions, host: ModuleResolutionHost, cache?: ModuleResolutionCache, redirectedReference?: ResolvedProjectReference, lookupConfig?: boolean): ResolvedModuleWithFailedLookupLocations; // eslint-disable-line @typescript-eslint/unified-signatures
/** @internal */ export function nodeModuleNameResolver(moduleName: string, containingFile: string, compilerOptions: CompilerOptions, host: ModuleResolutionHost, cache?: ModuleResolutionCache, redirectedReference?: ResolvedProjectReference, lookupConfig?: boolean): ResolvedModuleWithFailedLookupLocations; // eslint-disable-line @typescript-eslint/unified-signatures
export function nodeModuleNameResolver(moduleName: string, containingFile: string, compilerOptions: CompilerOptions, host: ModuleResolutionHost, cache?: ModuleResolutionCache, redirectedReference?: ResolvedProjectReference, lookupConfig?: boolean): ResolvedModuleWithFailedLookupLocations {
let extensions;
if (lookupConfig) {
@ -1524,9 +1527,9 @@ function nodeLoadModuleByRelativeName(extensions: Extensions, candidate: string,
return undefined;
}
/*@internal*/
/** @internal */
export const nodeModulesPathPart = "/node_modules/";
/*@internal*/
/** @internal */
export function pathContainsNodeModules(path: string): boolean {
return stringContains(path, nodeModulesPathPart);
}
@ -1540,8 +1543,9 @@ export function pathContainsNodeModules(path: string): boolean {
* For `/node_modules/foo/bar.d.ts` this is packageDirectory: "foo"
* For `/node_modules/@types/foo/bar/index.d.ts` this is packageDirectory: "@types/foo"
* For `/node_modules/foo/bar/index.d.ts` this is packageDirectory: "foo"
*
* @internal
*/
/* @internal */
export function parseNodeModuleFromPath(resolved: string): string | undefined {
const path = normalizePath(resolved);
const idx = path.lastIndexOf(nodeModulesPathPart);
@ -1717,7 +1721,7 @@ function loadNodeModuleFromDirectory(extensions: Extensions, candidate: string,
return withPackageId(packageInfo, loadNodeModuleFromDirectoryWorker(extensions, candidate, onlyRecordFailures, state, packageJsonContent, versionPaths));
}
/* @internal */
/** @internal */
export function getEntrypointsFromPackageJsonInfo(
packageJsonInfo: PackageJsonInfo,
options: CompilerOptions,
@ -1822,7 +1826,7 @@ function loadEntrypointsFromExportMap(
}
}
/*@internal*/
/** @internal */
export function getTemporaryModuleResolutionState(packageJsonInfoCache: PackageJsonInfoCache | undefined, host: ModuleResolutionHost, options: CompilerOptions): ModuleResolutionState {
return {
host,
@ -1838,12 +1842,12 @@ export function getTemporaryModuleResolutionState(packageJsonInfoCache: PackageJ
};
}
/*@internal*/
/** @internal */
export interface PackageJsonInfo {
packageDirectory: string;
contents: PackageJsonInfoContents;
}
/*@internal*/
/** @internal */
export interface PackageJsonInfoContents {
packageJsonContent: PackageJsonPathFields;
versionPaths: VersionPaths | undefined;
@ -1853,8 +1857,9 @@ export interface PackageJsonInfoContents {
/**
* A function for locating the package.json scope for a given path
*
* @internal
*/
/*@internal*/
export function getPackageScopeForPath(fileName: string, state: ModuleResolutionState): PackageJsonInfo | undefined {
const parts = getPathComponents(fileName);
parts.pop();
@ -1868,7 +1873,7 @@ export interface PackageJsonInfoContents {
return undefined;
}
/*@internal*/
/** @internal */
export function getPackageJsonInfo(packageDirectory: string, onlyRecordFailures: boolean, state: ModuleResolutionState): PackageJsonInfo | undefined {
const { host, traceEnabled } = state;
const packageJsonPath = combinePaths(packageDirectory, "package.json");
@ -2014,7 +2019,7 @@ function extensionIsOk(extensions: Extensions, extension: Extension): boolean {
}
}
/* @internal */
/** @internal */
export function parsePackageName(moduleName: string): { packageName: string, rest: string } {
let idx = moduleName.indexOf(directorySeparator);
if (moduleName[0] === "@") {
@ -2023,7 +2028,7 @@ export function parsePackageName(moduleName: string): { packageName: string, res
return idx === -1 ? { packageName: moduleName, rest: "" } : { packageName: moduleName.slice(0, idx), rest: moduleName.slice(idx + 1) };
}
/* @internal */
/** @internal */
export function allKeysStartWithDot(obj: MapLike<unknown>) {
return every(getOwnKeys(obj), k => startsWith(k, "."));
}
@ -2404,7 +2409,7 @@ function getLoadModuleFromTargetImportOrExport(extensions: Extensions, state: Mo
}
}
/* @internal */
/** @internal */
export function isApplicableVersionedTypesKey(conditions: readonly string[], key: string) {
if (conditions.indexOf("types") === -1) return false; // only apply versioned types conditions if the types condition is applied
if (!startsWith(key, "types@")) return false;
@ -2574,12 +2579,12 @@ function mangleScopedPackageNameWithTrace(packageName: string, state: ModuleReso
return mangled;
}
/* @internal */
/** @internal */
export function getTypesPackageName(packageName: string): string {
return `@types/${mangleScopedPackageName(packageName)}`;
}
/* @internal */
/** @internal */
export function mangleScopedPackageName(packageName: string): string {
if (startsWith(packageName, "@")) {
const replaceSlash = packageName.replace(directorySeparator, mangledScopedPackageSeparator);
@ -2590,7 +2595,7 @@ export function mangleScopedPackageName(packageName: string): string {
return packageName;
}
/* @internal */
/** @internal */
export function getPackageNameFromTypesPackageName(mangledName: string): string {
const withoutAtTypePrefix = removePrefix(mangledName, "@types/");
if (withoutAtTypePrefix !== mangledName) {
@ -2599,7 +2604,7 @@ export function getPackageNameFromTypesPackageName(mangledName: string): string
return mangledName;
}
/* @internal */
/** @internal */
export function unmangleScopedPackageName(typesPackageName: string): string {
return stringContains(typesPackageName, mangledScopedPackageSeparator) ?
"@" + typesPackageName.replace(mangledScopedPackageSeparator, directorySeparator) :
@ -2681,8 +2686,9 @@ export function classicNameResolver(moduleName: string, containingFile: string,
/**
* A host may load a module from a global cache of typings.
* This is the minumum code needed to expose that functionality; the rest is in the host.
*
* @internal
*/
/* @internal */
export function loadModuleFromGlobalCache(moduleName: string, projectName: string | undefined, compilerOptions: CompilerOptions, host: ModuleResolutionHost, globalCache: string, packageJsonInfoCache: PackageJsonInfoCache): ResolvedModuleWithFailedLookupLocations {
const traceEnabled = isTraceEnabled(compilerOptions, host);
if (traceEnabled) {

7
src/compiler/moduleSpecifiers.ts
View File

@ -180,8 +180,11 @@ function tryGetModuleSpecifiersFromCacheWorker(
return [cached?.moduleSpecifiers, moduleSourceFile, cached?.modulePaths, cache];
}
/** @internal */
/** Returns an import for each symlink and for the realpath. */
/**
* Returns an import for each symlink and for the realpath.
*
* @internal
*/
export function getModuleSpecifiers(
moduleSymbol: Symbol,
checker: TypeChecker,

28
src/compiler/parser.ts
View File

@ -89,8 +89,9 @@ let SourceFileConstructor: new (kind: SyntaxKind, pos?: number, end?: number) =>
/**
* NOTE: You should not use this, it is only exported to support `createNode` in `~/src/deprecatedCompat/deprecations.ts`.
*
* @internal
*/
/* @internal */
export const parseBaseNodeFactory: BaseNodeFactory = {
createBaseSourceFileNode: kind => new (SourceFileConstructor || (SourceFileConstructor = objectAllocator.getSourceFileConstructor()))(kind, -1, -1),
createBaseIdentifierNode: kind => new (IdentifierConstructor || (IdentifierConstructor = objectAllocator.getIdentifierConstructor()))(kind, -1, -1),
@ -99,7 +100,7 @@ export const parseBaseNodeFactory: BaseNodeFactory = {
createBaseNode: kind => new (NodeConstructor || (NodeConstructor = objectAllocator.getNodeConstructor()))(kind, -1, -1),
};
/* @internal */
/** @internal */
export const parseNodeFactory = createNodeFactory(NodeFactoryFlags.NoParenthesizerRules, parseBaseNodeFactory);
function visitNode<T>(cbNode: (node: Node) => T, node: Node | undefined): T | undefined {
@ -120,14 +121,14 @@ function visitNodes<T>(cbNode: (node: Node) => T, cbNodes: ((node: NodeArray<Nod
}
}
/*@internal*/
/** @internal */
export function isJSDocLikeText(text: string, start: number) {
return text.charCodeAt(start + 1) === CharacterCodes.asterisk &&
text.charCodeAt(start + 2) === CharacterCodes.asterisk &&
text.charCodeAt(start + 3) !== CharacterCodes.slash;
}
/*@internal*/
/** @internal */
export function isFileProbablyExternalModule(sourceFile: SourceFile) {
// Try to use the first top-level import/export when available, then
// fall back to looking for an 'import.meta' somewhere in the tree if necessary.
@ -916,7 +917,6 @@ export function forEachChild<T>(node: Node, cbNode: (node: Node) => T | undefine
return fn === undefined ? undefined : fn(node, cbNode, cbNodes);
}
/** @internal */
/**
* Invokes a callback for each child of the given node. The 'cbNode' callback is invoked for all child nodes
* stored in properties. If a 'cbNodes' callback is specified, it is invoked for embedded arrays; additionally,
@ -929,6 +929,8 @@ export function forEachChild<T>(node: Node, cbNode: (node: Node) => T | undefine
*
* @remarks Unlike `forEachChild`, `forEachChildRecursively` handles recursively invoking the traversal on each child node found,
* and while doing so, handles traversing the structure without relying on the callstack to encode the tree structure.
*
* @internal
*/
export function forEachChildRecursively<T>(rootNode: Node, cbNode: (node: Node, parent: Node) => T | "skip" | undefined, cbNodes?: (nodes: NodeArray<Node>, parent: Node) => T | "skip" | undefined): T | undefined {
const queue: (Node | NodeArray<Node>)[] = gatherPossibleChildren(rootNode);
@ -993,8 +995,8 @@ export interface CreateSourceFileOptions {
* check specified by `isFileProbablyExternalModule` will be used to set the field.
*/
setExternalModuleIndicator?: (file: SourceFile) => void;
/*@internal*/ packageJsonLocations?: readonly string[];
/*@internal*/ packageJsonScope?: PackageJsonInfo;
/** @internal */ packageJsonLocations?: readonly string[];
/** @internal */ packageJsonScope?: PackageJsonInfo;
}
function setExternalModuleIndicator(sourceFile: SourceFile) {
@ -1065,7 +1067,7 @@ export function updateSourceFile(sourceFile: SourceFile, newText: string, textCh
return newSourceFile;
}
/* @internal */
/** @internal */
export function parseIsolatedJSDocComment(content: string, start?: number, length?: number) {
const result = Parser.JSDocParser.parseIsolatedJSDocComment(content, start, length);
if (result && result.jsDoc) {
@ -1077,7 +1079,7 @@ export function parseIsolatedJSDocComment(content: string, start?: number, lengt
return result;
}
/* @internal */
/** @internal */
// Exposed only for testing.
export function parseJSDocTypeExpressionForTests(content: string, start?: number, length?: number) {
return Parser.JSDocParser.parseJSDocTypeExpressionForTests(content, start, length);
@ -9775,7 +9777,7 @@ export function isDeclarationFileName(fileName: string): boolean {
return fileExtensionIsOneOf(fileName, supportedDeclarationExtensions);
}
/*@internal*/
/** @internal */
export interface PragmaContext {
languageVersion: ScriptTarget;
pragmas?: PragmaMap;
@ -9802,7 +9804,7 @@ function parseResolutionMode(mode: string | undefined, pos: number, end: number,
return undefined;
}
/*@internal*/
/** @internal */
export function processCommentPragmas(context: PragmaContext, sourceText: string): void {
const pragmas: PragmaPseudoMapEntry[] = [];
@ -9827,10 +9829,10 @@ export function processCommentPragmas(context: PragmaContext, sourceText: string
}
}
/*@internal*/
/** @internal */
type PragmaDiagnosticReporter = (pos: number, length: number, message: DiagnosticMessage) => void;
/*@internal*/
/** @internal */
export function processPragmasIntoFields(context: PragmaContext, reportDiagnostic: PragmaDiagnosticReporter): void {
context.checkJsDirective = undefined;
context.referencedFiles = [];

109
src/compiler/path.ts
View File

@ -4,11 +4,12 @@ import {
identity, lastOrUndefined, Path, some, startsWith, stringContains,
} from "./_namespaces/ts";
/** @internal */
/**
* Internally, we represent paths as strings with '/' as the directory separator.
* When we make system calls (eg: LanguageServiceHost.getDirectory()),
* we expect the host to correctly handle paths in our specified format.
*
* @internal
*/
export const directorySeparator = "/";
/** @internal */
@ -18,41 +19,44 @@ const backslashRegExp = /\\/g;
//// Path Tests
/** @internal */
/**
* Determines whether a charCode corresponds to `/` or `\`.
*
* @internal
*/
export function isAnyDirectorySeparator(charCode: number): boolean {
return charCode === CharacterCodes.slash || charCode === CharacterCodes.backslash;
}
/** @internal */
/**
* Determines whether a path starts with a URL scheme (e.g. starts with `http://`, `ftp://`, `file://`, etc.).
*
* @internal
*/
export function isUrl(path: string) {
return getEncodedRootLength(path) < 0;
}
/** @internal */
/**
* Determines whether a path is an absolute disk path (e.g. starts with `/`, or a dos path
* like `c:`, `c:\` or `c:/`).
*
* @internal
*/
export function isRootedDiskPath(path: string) {
return getEncodedRootLength(path) > 0;
}
/** @internal */
/**
* Determines whether a path consists only of a path root.
*
* @internal
*/
export function isDiskPathRoot(path: string) {
const rootLength = getEncodedRootLength(path);
return rootLength > 0 && rootLength === path.length;
}
/** @internal */
/**
* Determines whether a path starts with an absolute path component (i.e. `/`, `c:/`, `file://`, etc.).
*
@ -67,23 +71,27 @@ export function isDiskPathRoot(path: string) {
* pathIsAbsolute("path/to/file.ext") === false
* pathIsAbsolute("./path/to/file.ext") === false
* ```
*
* @internal
*/
export function pathIsAbsolute(path: string): boolean {
return getEncodedRootLength(path) !== 0;
}
/** @internal */
/**
* Determines whether a path starts with a relative path component (i.e. `.` or `..`).
*
* @internal
*/
export function pathIsRelative(path: string): boolean {
return /^\.\.?($|[\\/])/.test(path);
}
/** @internal */
/**
* Determines whether a path is neither relative nor absolute, e.g. "path/to/file".
* Also known misleadingly as "non-relative".
*
* @internal
*/
export function pathIsBareSpecifier(path: string): boolean {
return !pathIsAbsolute(path) && !pathIsRelative(path);
@ -110,9 +118,10 @@ export function fileExtensionIsOneOf(path: string, extensions: readonly string[]
return false;
}
/** @internal */
/**
* Determines whether a path has a trailing separator (`/` or `\\`).
*
* @internal
*/
export function hasTrailingDirectorySeparator(path: string) {
return path.length > 0 && isAnyDirectorySeparator(path.charCodeAt(path.length - 1));
@ -195,7 +204,6 @@ function getEncodedRootLength(path: string): number {
return 0;
}
/** @internal */
/**
* Returns length of the root part of a path or URL (i.e. length of "/", "x:/", "//server/share/, file:///user/files").
*
@ -220,13 +228,14 @@ function getEncodedRootLength(path: string): number {
* getRootLength("http://server") === 13 // "http://server"
* getRootLength("http://server/path") === 14 // "http://server/"
* ```
*
* @internal
*/
export function getRootLength(path: string) {
const rootLength = getEncodedRootLength(path);
return rootLength < 0 ? ~rootLength : rootLength;
}
/** @internal */
/**
* Returns the path except for its basename. Semantics align with NodeJS's `path.dirname`
* except that we support URLs as well.
@ -247,9 +256,10 @@ export function getRootLength(path: string) {
* getDirectoryPath("http://typescriptlang.org/") === "http://typescriptlang.org/"
* getDirectoryPath("http://typescriptlang.org") === "http://typescriptlang.org"
* ```
*
* @internal
*/
export function getDirectoryPath(path: Path): Path;
/** @internal */
/**
* Returns the path except for its basename. Semantics align with NodeJS's `path.dirname`
* except that we support URLs as well.
@ -278,6 +288,8 @@ export function getDirectoryPath(path: Path): Path;
* getDirectoryPath("file:///") === "file:///"
* getDirectoryPath("file://") === "file://"
* ```
*
* @internal
*/
export function getDirectoryPath(path: string): string;
/** @internal */
@ -294,7 +306,6 @@ export function getDirectoryPath(path: string): string {
return path.slice(0, Math.max(rootLength, path.lastIndexOf(directorySeparator)));
}
/** @internal */
/**
* Returns the path except for its containing directory name.
* Semantics align with NodeJS's `path.basename` except that we support URL's as well.
@ -323,9 +334,10 @@ export function getDirectoryPath(path: string): string {
* getBaseFileName("file:///") === ""
* getBaseFileName("file://") === ""
* ```
*
* @internal
*/
export function getBaseFileName(path: string): string;
/** @internal */
/**
* Gets the portion of a path following the last (non-terminal) separator (`/`).
* Semantics align with NodeJS's `path.basename` except that we support URL's as well.
@ -337,6 +349,8 @@ export function getBaseFileName(path: string): string;
* getBaseFileName("/path/to/file.js", [".ext", ".js"], true) === "file"
* getBaseFileName("/path/to/file.ext", ".EXT", false) === "file.ext"
* ```
*
* @internal
*/
export function getBaseFileName(path: string, extensions: string | readonly string[], ignoreCase: boolean): string;
/** @internal */
@ -376,7 +390,6 @@ function getAnyExtensionFromPathWorker(path: string, extensions: string | readon
return "";
}
/** @internal */
/**
* Gets the file extension for a path.
*
@ -386,9 +399,10 @@ function getAnyExtensionFromPathWorker(path: string, extensions: string | readon
* getAnyExtensionFromPath("/path/to/file") === ""
* getAnyExtensionFromPath("/path/to.ext/file") === ""
* ```
*
* @internal
*/
export function getAnyExtensionFromPath(path: string): string;
/** @internal */
/**
* Gets the file extension for a path, provided it is one of the provided extensions.
*
@ -397,6 +411,8 @@ export function getAnyExtensionFromPath(path: string): string;
* getAnyExtensionFromPath("/path/to/file.js", ".ext", true) === ""
* getAnyExtensionFromPath("/path/to/file.js", [".ext", ".js"], true) === ".js"
* getAnyExtensionFromPath("/path/to/file.ext", ".EXT", false) === ""
*
* @internal
*/
export function getAnyExtensionFromPath(path: string, extensions: string | readonly string[], ignoreCase: boolean): string;
/** @internal */
@ -421,7 +437,6 @@ function pathComponents(path: string, rootLength: number) {
return [root, ...rest];
}
/** @internal */
/**
* Parse a path into an array containing a root component (at index 0) and zero or more path
* components (at indices > 0). The result is not normalized.
@ -451,6 +466,9 @@ function pathComponents(path: string, rootLength: number) {
* getPathComponents("file:///path/to/") === ["file:///", "path", "to"]
* getPathComponents("file:///") === ["file:///"]
* getPathComponents("file://") === ["file://"]
* ```
*
* @internal
*/
export function getPathComponents(path: string, currentDirectory = "") {
path = combinePaths(currentDirectory, path);
@ -459,7 +477,6 @@ export function getPathComponents(path: string, currentDirectory = "") {
//// Path Formatting
/** @internal */
/**
* Formats a parsed path consisting of a root component (at index 0) and zero or more path
* segments (at indices > 0).
@ -467,6 +484,8 @@ export function getPathComponents(path: string, currentDirectory = "") {
* ```ts
* getPathFromPathComponents(["/", "path", "to", "file.ext"]) === "/path/to/file.ext"
* ```
*
* @internal
*/
export function getPathFromPathComponents(pathComponents: readonly string[]) {
if (pathComponents.length === 0) return "";
@ -477,9 +496,10 @@ export function getPathFromPathComponents(pathComponents: readonly string[]) {
//// Path Normalization
/** @internal */
/**
* Normalize path separators, converting `\` into `/`.
*
* @internal
*/
export function normalizeSlashes(path: string): string {
return path.indexOf("\\") !== -1
@ -487,10 +507,11 @@ export function normalizeSlashes(path: string): string {
: path;
}
/** @internal */
/**
* Reduce an array of path components to a more simplified path by navigating any
* `"."` or `".."` entries in the path.
*
* @internal
*/
export function reducePathComponents(components: readonly string[]) {
if (!some(components)) return [];
@ -513,7 +534,6 @@ export function reducePathComponents(components: readonly string[]) {
return reduced;
}
/** @internal */
/**
* Combines paths. If a path is absolute, it replaces any previous path. Relative paths are not simplified.
*
@ -531,6 +551,8 @@ export function reducePathComponents(components: readonly string[]) {
* combinePaths("file:///path", "to", "file.ext") === "file:///path/to/file.ext"
* combinePaths("file:///path", "file:///to", "file.ext") === "file:///to/file.ext"
* ```
*
* @internal
*/
export function combinePaths(path: string, ...paths: (string | undefined)[]): string {
if (path) path = normalizeSlashes(path);
@ -547,7 +569,6 @@ export function combinePaths(path: string, ...paths: (string | undefined)[]): st
return path;
}
/** @internal */
/**
* Combines and resolves paths. If a path is absolute, it replaces any previous path. Any
* `.` and `..` path components are resolved. Trailing directory separators are preserved.
@ -557,12 +578,13 @@ export function combinePaths(path: string, ...paths: (string | undefined)[]): st
* resolvePath("/path", "to", "file.ext/") === "path/to/file.ext/"
* resolvePath("/path", "dir", "..", "to", "file.ext") === "path/to/file.ext"
* ```
*
* @internal
*/
export function resolvePath(path: string, ...paths: (string | undefined)[]): string {
return normalizePath(some(paths) ? combinePaths(path, ...paths) : normalizeSlashes(path));
}
/** @internal */
/**
* Parse a path into an array containing a root component (at index 0) and zero or more path
* components (at indices > 0). The result is normalized.
@ -572,6 +594,8 @@ export function resolvePath(path: string, ...paths: (string | undefined)[]): str
* ```ts
* getNormalizedPathComponents("to/dir/../file.ext", "/path/") === ["/", "path", "to", "file.ext"]
* ```
*
* @internal
*/
export function getNormalizedPathComponents(path: string, currentDirectory: string | undefined) {
return reducePathComponents(getPathComponents(path, currentDirectory));
@ -622,7 +646,6 @@ export function toPath(fileName: string, basePath: string | undefined, getCanoni
//// Path Mutation
/** @internal */
/**
* Removes a trailing directory separator from a path, if it does not already have one.
*
@ -630,6 +653,8 @@ export function toPath(fileName: string, basePath: string | undefined, getCanoni
* removeTrailingDirectorySeparator("/path/to/file.ext") === "/path/to/file.ext"
* removeTrailingDirectorySeparator("/path/to/file.ext/") === "/path/to/file.ext"
* ```
*
* @internal
*/
export function removeTrailingDirectorySeparator(path: Path): Path;
/** @internal */
@ -643,7 +668,6 @@ export function removeTrailingDirectorySeparator(path: string) {
return path;
}
/** @internal */
/**
* Adds a trailing directory separator to a path, if it does not already have one.
*
@ -651,6 +675,8 @@ export function removeTrailingDirectorySeparator(path: string) {
* ensureTrailingDirectorySeparator("/path/to/file.ext") === "/path/to/file.ext/"
* ensureTrailingDirectorySeparator("/path/to/file.ext/") === "/path/to/file.ext/"
* ```
*
* @internal
*/
export function ensureTrailingDirectorySeparator(path: Path): Path;
/** @internal */
@ -664,7 +690,6 @@ export function ensureTrailingDirectorySeparator(path: string) {
return path;
}
/** @internal */
/**
* Ensures a path is either absolute (prefixed with `/` or `c:`) or dot-relative (prefixed
* with `./` or `../`) so as not to be confused with an unprefixed module name.
@ -675,21 +700,23 @@ export function ensureTrailingDirectorySeparator(path: string) {
* ensurePathIsNonModuleName("../path/to/file.ext") === "../path/to/file.ext"
* ensurePathIsNonModuleName("path/to/file.ext") === "./path/to/file.ext"
* ```
*
* @internal
*/
export function ensurePathIsNonModuleName(path: string): string {
return !pathIsAbsolute(path) && !pathIsRelative(path) ? "./" + path : path;
}
/** @internal */
/**
* Changes the extension of a path to the provided extension.
*
* ```ts
* changeAnyExtension("/path/to/file.ext", ".js") === "/path/to/file.js"
* ```
*
* @internal
*/
export function changeAnyExtension(path: string, ext: string): string;
/** @internal */
/**
* Changes the extension of a path to the provided extension if it has one of the provided extensions.
*
@ -698,6 +725,8 @@ export function changeAnyExtension(path: string, ext: string): string;
* changeAnyExtension("/path/to/file.ext", ".js", ".ts") === "/path/to/file.ext"
* changeAnyExtension("/path/to/file.ext", ".js", [".ext", ".ts"]) === "/path/to/file.js"
* ```
*
* @internal
*/
export function changeAnyExtension(path: string, ext: string, extensions: string | readonly string[], ignoreCase: boolean): string;
/** @internal */
@ -747,25 +776,28 @@ function comparePathsWorker(a: string, b: string, componentComparer: (a: string,
return compareValues(aComponents.length, bComponents.length);
}
/** @internal */
/**
* Performs a case-sensitive comparison of two paths. Path roots are always compared case-insensitively.
*
* @internal
*/
export function comparePathsCaseSensitive(a: string, b: string) {
return comparePathsWorker(a, b, compareStringsCaseSensitive);
}
/** @internal */
/**
* Performs a case-insensitive comparison of two paths.
*
* @internal
*/
export function comparePathsCaseInsensitive(a: string, b: string) {
return comparePathsWorker(a, b, compareStringsCaseInsensitive);
}
/** @internal */
/**
* Compare two paths using the provided case sensitivity.
*
* @internal
*/
export function comparePaths(a: string, b: string, ignoreCase?: boolean): Comparison;
/** @internal */
@ -782,9 +814,10 @@ export function comparePaths(a: string, b: string, currentDirectory?: string | b
return comparePathsWorker(a, b, getStringComparer(ignoreCase));
}
/** @internal */
/**
* Determines whether a `parent` path contains a `child` path using the provide case sensitivity.
*
* @internal
*/
export function containsPath(parent: string, child: string, ignoreCase?: boolean): boolean;
/** @internal */
@ -817,12 +850,13 @@ export function containsPath(parent: string, child: string, currentDirectory?: s
return true;
}
/** @internal */
/**
* Determines whether `fileName` starts with the specified `directoryName` using the provided path canonicalization callback.
* Comparison is case-sensitive between the canonical paths.
*
* Use `containsPath` if file names are not already reduced and absolute.
*
* @internal
*/
export function startsWithDirectory(fileName: string, directoryName: string, getCanonicalFileName: GetCanonicalFileName): boolean {
const canonicalFileName = getCanonicalFileName(fileName);
@ -857,14 +891,16 @@ export function getPathComponentsRelativeTo(from: string, to: string, stringEqua
return ["", ...relative, ...components];
}
/** @internal */
/**
* Gets a relative path that can be used to traverse between `from` and `to`.
*
* @internal
*/
export function getRelativePathFromDirectory(from: string, to: string, ignoreCase: boolean): string;
/** @internal */
/**
* Gets a relative path that can be used to traverse between `from` and `to`.
*
* @internal
*/
export function getRelativePathFromDirectory(fromDirectory: string, to: string, getCanonicalFileName: GetCanonicalFileName): string; // eslint-disable-line @typescript-eslint/unified-signatures
/** @internal */
@ -908,9 +944,10 @@ export function getRelativePathToDirectoryOrUrl(directoryPathOrUrl: string, rela
//// Path Traversal
/** @internal */
/**
* Calls `callback` on `directory` and every ancestor directory it has, returning the first defined result.
*
* @internal
*/
export function forEachAncestorDirectory<T>(directory: Path, callback: (directory: Path) => T | undefined): T | undefined;
/** @internal */

7
src/compiler/perfLogger.ts
View File

@ -38,6 +38,9 @@ catch (e) {
etwModule = undefined;
}
/** @internal */
/** Performance logger that will generate ETW events if possible - check for `logEvent` member, as `etwModule` will be `{}` when browserified */
/**
* Performance logger that will generate ETW events if possible - check for `logEvent` member, as `etwModule` will be `{}` when browserified
*
* @internal
*/
export const perfLogger: PerfLogger = etwModule && etwModule.logEvent ? etwModule : nullLogger;

32
src/compiler/performance.ts
View File

@ -54,11 +54,12 @@ const marks = new Map<string, number>();
const counts = new Map<string, number>();
const durations = new Map<string, number>();
/** @internal */
/**
* Marks a performance event.
*
* @param markName The name of the mark.
*
* @internal
*/
export function mark(markName: string) {
if (enabled) {
@ -69,7 +70,6 @@ export function mark(markName: string) {
}
}
/** @internal */
/**
* Adds a performance measurement with the specified name.
*
@ -78,6 +78,8 @@ export function mark(markName: string) {
* profiler was enabled is used.
* @param endMarkName The name of the ending mark. If not supplied, the current timestamp is
* used.
*
* @internal
*/
export function measure(measureName: string, startMarkName?: string, endMarkName?: string) {
if (enabled) {
@ -89,31 +91,34 @@ export function measure(measureName: string, startMarkName?: string, endMarkName
}
}
/** @internal */
/**
* Gets the number of times a marker was encountered.
*
* @param markName The name of the mark.
*
* @internal
*/
export function getCount(markName: string) {
return counts.get(markName) || 0;
}
/** @internal */
/**
* Gets the total duration of all measurements with the supplied name.
*
* @param measureName The name of the measure whose durations should be accumulated.
*
* @internal
*/
export function getDuration(measureName: string) {
return durations.get(measureName) || 0;
}
/** @internal */
/**
* Iterate over each measure, performing some action
*
* @param cb The action to perform for each measure
*
* @internal
*/
export function forEachMeasure(cb: (measureName: string, duration: number) => void) {
durations.forEach((duration, measureName) => cb(measureName, duration));
@ -144,16 +149,20 @@ export function clearMarks(name?: string) {
performanceImpl?.clearMarks(name);
}
/** @internal */
/**
* Indicates whether the performance API is enabled.
*
* @internal
*/
export function isEnabled() {
return enabled;
}
/** @internal */
/** Enables (and resets) performance measurements for the compiler. */
/**
* Enables (and resets) performance measurements for the compiler.
*
* @internal
*/
export function enable(system: System = sys) {
if (!enabled) {
enabled = true;
@ -172,8 +181,11 @@ export function enable(system: System = sys) {
return true;
}
/** @internal */
/** Disables performance measurements for the compiler. */
/**
* Disables performance measurements for the compiler.
*
* @internal
*/
export function disable() {
if (enabled) {
marks.clear();

9
src/compiler/performanceCore.ts
View File

@ -135,9 +135,12 @@ export function tryGetNativePerformanceHooks() {
return nativePerformanceHooks;
}
/** @internal */
/** Gets a timestamp with (at least) ms resolution */
/**
* Gets a timestamp with (at least) ms resolution
*
* @internal
*/
export const timestamp =
nativePerformance ? () => nativePerformance.now() :
Date.now ? Date.now :
() => +(new Date());
() => +(new Date());

64
src/compiler/program.ts
View File

@ -74,7 +74,7 @@ export function resolveTripleslashReference(moduleName: string, containingFile:
return normalizePath(referencedFileName);
}
/* @internal */
/** @internal */
export function computeCommonSourceDirectoryOfFilenames(fileNames: readonly string[], currentDirectory: string, getCanonicalFileName: GetCanonicalFileName): string {
let commonPathComponents: string[] | undefined;
const failed = forEach(fileNames, sourceFile => {
@ -124,7 +124,7 @@ export function createCompilerHost(options: CompilerOptions, setParentNodes?: bo
return createCompilerHostWorker(options, setParentNodes);
}
/*@internal*/
/** @internal */
export function createGetSourceFile(
readFile: ProgramHost<any>["readFile"],
getCompilerOptions: () => CompilerOptions,
@ -148,7 +148,7 @@ export function createGetSourceFile(
};
}
/*@internal*/
/** @internal */
export function createWriteFileMeasuringIO(
actualWriteFile: (path: string, data: string, writeByteOrderMark: boolean) => void,
createDirectory: (path: string) => void,
@ -181,7 +181,7 @@ export function createWriteFileMeasuringIO(
};
}
/*@internal*/
/** @internal */
export function createCompilerHostWorker(options: CompilerOptions, setParentNodes?: boolean, system = sys): CompilerHost {
const existingDirectories = new Map<string, boolean>();
const getCanonicalFileName = createGetCanonicalFileName(system.useCaseSensitiveFileNames);
@ -229,7 +229,7 @@ export function createCompilerHostWorker(options: CompilerOptions, setParentNode
return compilerHost;
}
/*@internal*/
/** @internal */
interface CompilerHostLikeForCache {
fileExists(fileName: string): boolean;
readFile(fileName: string, encoding?: string): string | undefined;
@ -238,7 +238,7 @@ interface CompilerHostLikeForCache {
writeFile?: WriteFileCallback;
}
/*@internal*/
/** @internal */
export function changeCompilerHostLikeToUseCache(
host: CompilerHostLikeForCache,
toPath: (fileName: string) => Path,
@ -354,7 +354,7 @@ export function changeCompilerHostLikeToUseCache(
}
export function getPreEmitDiagnostics(program: Program, sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly Diagnostic[];
/*@internal*/ export function getPreEmitDiagnostics(program: BuilderProgram, sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly Diagnostic[]; // eslint-disable-line @typescript-eslint/unified-signatures
/** @internal */ export function getPreEmitDiagnostics(program: BuilderProgram, sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly Diagnostic[]; // eslint-disable-line @typescript-eslint/unified-signatures
export function getPreEmitDiagnostics(program: Program | BuilderProgram, sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly Diagnostic[] {
let diagnostics: Diagnostic[] | undefined;
diagnostics = addRange(diagnostics, program.getConfigFileParsingDiagnostics());
@ -480,7 +480,7 @@ function formatCodeSpan(file: SourceFile, start: number, length: number, indent:
return context;
}
/* @internal */
/** @internal */
export function formatLocation(file: SourceFile, start: number, host: FormatDiagnosticsHost, color = formatColorAndReset) {
const { line: firstLine, character: firstLineChar } = getLineAndCharacterOfPosition(file, start); // TODO: GH#18217
const relativeFileName = host ? convertToRelativePath(file.fileName, host.getCurrentDirectory(), fileName => host.getCanonicalFileName(fileName)) : file.fileName;
@ -553,7 +553,7 @@ export function flattenDiagnosticMessageText(diag: string | DiagnosticMessageCha
return result;
}
/* @internal */
/** @internal */
export function loadWithTypeDirectiveCache<T>(names: string[] | readonly FileReference[], containingFile: string, redirectedReference: ResolvedProjectReference | undefined, containingFileMode: SourceFile["impliedNodeFormat"], loader: (name: string, containingFile: string, redirectedReference: ResolvedProjectReference | undefined, resolutionMode: SourceFile["impliedNodeFormat"]) => T): T[] {
if (names.length === 0) {
return [];
@ -585,8 +585,8 @@ export function loadWithTypeDirectiveCache<T>(names: string[] | readonly FileRef
* @internal
*/
export interface SourceFileImportsList {
/* @internal */ imports: SourceFile["imports"];
/* @internal */ moduleAugmentations: SourceFile["moduleAugmentations"];
/** @internal */ imports: SourceFile["imports"];
/** @internal */ moduleAugmentations: SourceFile["moduleAugmentations"];
impliedNodeFormat?: SourceFile["impliedNodeFormat"];
}
@ -616,7 +616,7 @@ export function getModeForResolutionAtIndex(file: SourceFileImportsList, index:
return getModeForUsageLocation(file, getModuleNameStringLiteralAt(file, index));
}
/* @internal */
/** @internal */
export function isExclusivelyTypeOnlyImportOrExport(decl: ImportDeclaration | ExportDeclaration) {
if (isExportDeclaration(decl)) {
return decl.isTypeOnly;
@ -663,7 +663,7 @@ export function getModeForUsageLocation(file: {impliedNodeFormat?: SourceFile["i
return exprParentParent && isImportEqualsDeclaration(exprParentParent) ? ModuleKind.CommonJS : ModuleKind.ESNext;
}
/* @internal */
/** @internal */
export function getResolutionModeOverrideForClause(clause: AssertClause | undefined, grammarErrorOnNode?: (node: Node, diagnostic: DiagnosticMessage) => void) {
if (!clause) return undefined;
if (length(clause.elements) !== 1) {
@ -684,7 +684,7 @@ export function getResolutionModeOverrideForClause(clause: AssertClause | undefi
return elem.value.text === "import" ? ModuleKind.ESNext : ModuleKind.CommonJS;
}
/* @internal */
/** @internal */
export function loadWithModeAwareCache<T>(names: readonly StringLiteralLike[] | readonly string[], containingFile: SourceFile, containingFileName: string, redirectedReference: ResolvedProjectReference | undefined, resolutionInfo: ModuleResolutionInfo | undefined, loader: (name: string, resolverMode: ModuleKind.CommonJS | ModuleKind.ESNext | undefined, containingFileName: string, redirectedReference: ResolvedProjectReference | undefined) => T): T[] {
if (names.length === 0) {
return [];
@ -711,7 +711,7 @@ export function loadWithModeAwareCache<T>(names: readonly StringLiteralLike[] |
return resolutions;
}
/* @internal */
/** @internal */
export function forEachResolvedProjectReference<T>(
resolvedProjectReferences: readonly (ResolvedProjectReference | undefined)[] | undefined,
cb: (resolvedProjectReference: ResolvedProjectReference, parent: ResolvedProjectReference | undefined) => T | undefined
@ -756,7 +756,7 @@ function forEachProjectReference<T>(
}
}
/* @internal */
/** @internal */
export const inferredTypesContainingFile = "__inferred type names__.ts";
interface DiagnosticCache<T extends Diagnostic> {
@ -764,7 +764,7 @@ interface DiagnosticCache<T extends Diagnostic> {
allDiagnostics?: readonly T[];
}
/*@internal*/
/** @internal */
export function isReferencedFile(reason: FileIncludeReason | undefined): reason is ReferencedFile {
switch (reason?.kind) {
case FileIncludeKind.Import:
@ -777,7 +777,7 @@ export function isReferencedFile(reason: FileIncludeReason | undefined): reason
}
}
/*@internal*/
/** @internal */
export interface ReferenceFileLocation {
file: SourceFile;
pos: number;
@ -785,19 +785,19 @@ export interface ReferenceFileLocation {
packageId: PackageId | undefined;
}
/*@internal*/
/** @internal */
export interface SyntheticReferenceFileLocation {
file: SourceFile;
packageId: PackageId | undefined;
text: string;
}
/*@internal*/
/** @internal */
export function isReferenceFileLocation(location: ReferenceFileLocation | SyntheticReferenceFileLocation): location is ReferenceFileLocation {
return (location as ReferenceFileLocation).pos !== undefined;
}
/*@internal*/
/** @internal */
export function getReferencedFileLocation(getSourceFileByPath: (path: Path) => SourceFile | undefined, ref: ReferencedFile): ReferenceFileLocation | SyntheticReferenceFileLocation {
const file = Debug.checkDefined(getSourceFileByPath(ref.file));
const { kind, index } = ref;
@ -828,8 +828,9 @@ export function getReferencedFileLocation(getSourceFileByPath: (path: Path) => S
/**
* Determines if program structure is upto date or needs to be recreated
*
* @internal
*/
/* @internal */
export function isProgramUptoDate(
program: Program | undefined,
rootFileNames: string[],
@ -935,7 +936,7 @@ export function getImpliedNodeFormatForFile(fileName: Path, packageJsonInfoCache
return typeof result === "object" ? result.impliedNodeFormat : result;
}
/*@internal*/
/** @internal */
export function getImpliedNodeFormatForFileWorker(
fileName: string,
packageJsonInfoCache: PackageJsonInfoCache | undefined,
@ -4307,10 +4308,10 @@ function updateHostForUseSourceOfProjectReferenceRedirect(host: HostForUseSource
}
}
/*@internal*/
/** @internal */
export const emitSkippedWithNoDiagnostics: EmitResult = { diagnostics: emptyArray, sourceMaps: undefined, emittedFiles: undefined, emitSkipped: true };
/*@internal*/
/** @internal */
export function handleNoEmitOptions<T extends BuilderProgram>(
program: Program | T,
sourceFile: SourceFile | undefined,
@ -4351,12 +4352,12 @@ export function handleNoEmitOptions<T extends BuilderProgram>(
return { diagnostics, sourceMaps: undefined, emittedFiles, emitSkipped: true };
}
/*@internal*/
/** @internal */
export function filterSemanticDiagnostics(diagnostic: readonly Diagnostic[], option: CompilerOptions): readonly Diagnostic[] {
return filter(diagnostic, d => !d.skippedOn || !option[d.skippedOn]);
}
/*@internal*/
/** @internal */
interface CompilerHostLike {
useCaseSensitiveFileNames(): boolean;
getCurrentDirectory(): string;
@ -4367,7 +4368,7 @@ interface CompilerHostLike {
onUnRecoverableConfigFileDiagnostic?: DiagnosticReporter;
}
/* @internal */
/** @internal */
export function parseConfigHostFromCompilerHostLike(host: CompilerHostLike, directoryStructureHost: DirectoryStructureHost = host): ParseConfigFileHost {
return {
fileExists: f => directoryStructureHost.fileExists(f),
@ -4388,7 +4389,7 @@ export function parseConfigHostFromCompilerHostLike(host: CompilerHostLike, dire
fileExists(fileName: string): boolean;
}
/* @internal */
/** @internal */
export function createPrependNodes(
projectReferences: readonly ProjectReference[] | undefined,
getCommandLine: (ref: ProjectReference, index: number) => ParsedCommandLine | undefined,
@ -4423,11 +4424,12 @@ export function resolveProjectReferencePath(hostOrRef: ResolveProjectReferencePa
return resolveConfigFileProjectName(passedInRef.path);
}
/* @internal */
/**
* Returns a DiagnosticMessage if we won't include a resolved module due to its extension.
* The DiagnosticMessage's parameters are the imported module name, and the filename it resolved to.
* This returns a diagnostic even if the module will be an untyped module.
*
* @internal
*/
export function getResolutionDiagnostic(options: CompilerOptions, { extension }: ResolvedModuleFull): DiagnosticMessage | undefined {
switch (extension) {
@ -4467,7 +4469,7 @@ function getModuleNames({ imports, moduleAugmentations }: SourceFile): StringLit
return res;
}
/* @internal */
/** @internal */
export function getModuleNameStringLiteralAt({ imports, moduleAugmentations }: SourceFileImportsList, index: number): StringLiteralLike {
if (index < imports.length) return imports[index];
let augIndex = imports.length;

10
src/compiler/resolutionCache.ts
View File

@ -18,8 +18,11 @@ import {
stringContains, trace, unorderedRemoveItem, WatchDirectoryFlags,
} from "./_namespaces/ts";
/** @internal */
/** This is the cache of module/typedirectives resolution that can be retained across program */
/**
* This is the cache of module/typedirectives resolution that can be retained across program
*
* @internal
*/
export interface ResolutionCache {
startRecordingFilesWithChangedResolutions(): void;
finishRecordingFilesWithChangedResolutions(): Path[] | undefined;
@ -132,12 +135,13 @@ export function removeIgnoredPath(path: Path): Path | undefined {
path;
}
/** @internal */
/**
* Filter out paths like
* "/", "/user", "/user/username", "/user/username/folderAtRoot",
* "c:/", "c:/users", "c:/users/username", "c:/users/username/folderAtRoot", "c:/folderAtRoot"
* @param dirPath
*
* @internal
*/
export function canWatchDirectoryOrFile(dirPath: Path) {
const rootLength = getRootLength(dirPath);

46
src/compiler/scanner.ts
View File

@ -7,12 +7,12 @@ import {
export type ErrorCallback = (message: DiagnosticMessage, length: number) => void;
/* @internal */
/** @internal */
export function tokenIsIdentifierOrKeyword(token: SyntaxKind): boolean {
return token >= SyntaxKind.Identifier;
}
/* @internal */
/** @internal */
export function tokenIsIdentifierOrKeywordOrGreaterThan(token: SyntaxKind): boolean {
return token === SyntaxKind.GreaterThanToken || tokenIsIdentifierOrKeyword(token);
}
@ -27,16 +27,16 @@ export interface Scanner {
hasUnicodeEscape(): boolean;
hasExtendedUnicodeEscape(): boolean;
hasPrecedingLineBreak(): boolean;
/* @internal */
/** @internal */
hasPrecedingJSDocComment(): boolean;
isIdentifier(): boolean;
isReservedWord(): boolean;
isUnterminated(): boolean;
/* @internal */
/** @internal */
getNumericLiteralFlags(): TokenFlags;
/* @internal */
/** @internal */
getCommentDirectives(): CommentDirective[] | undefined;
/* @internal */
/** @internal */
getTokenFlags(): TokenFlags;
reScanGreaterToken(): SyntaxKind;
reScanSlashToken(): SyntaxKind;
@ -56,7 +56,7 @@ export interface Scanner {
scan(): SyntaxKind;
getText(): string;
/* @internal */
/** @internal */
clearCommentDirectives(): void;
// Sets the text for the scanner to scan. An optional subrange starting point and length
// can be provided to have the scanner only scan a portion of the text.
@ -65,7 +65,7 @@ export interface Scanner {
setScriptTarget(scriptTarget: ScriptTarget): void;
setLanguageVariant(variant: LanguageVariant): void;
setTextPos(textPos: number): void;
/* @internal */
/** @internal */
setInJSDocType(inType: boolean): void;
// Invokes the provided callback then unconditionally restores the scanner to the state it
// was in immediately prior to invoking the callback. The result of invoking the callback
@ -333,7 +333,7 @@ function lookupInUnicodeMap(code: number, map: readonly number[]): boolean {
return false;
}
/* @internal */ export function isUnicodeIdentifierStart(code: number, languageVersion: ScriptTarget | undefined) {
/** @internal */ export function isUnicodeIdentifierStart(code: number, languageVersion: ScriptTarget | undefined) {
return languageVersion! >= ScriptTarget.ES2015 ?
lookupInUnicodeMap(code, unicodeESNextIdentifierStart) :
languageVersion === ScriptTarget.ES5 ? lookupInUnicodeMap(code, unicodeES5IdentifierStart) :
@ -360,12 +360,12 @@ export function tokenToString(t: SyntaxKind): string | undefined {
return tokenStrings[t];
}
/* @internal */
/** @internal */
export function stringToToken(s: string): SyntaxKind | undefined {
return textToToken.get(s);
}
/* @internal */
/** @internal */
export function computeLineStarts(text: string): number[] {
const result: number[] = [];
let pos = 0;
@ -396,7 +396,7 @@ export function computeLineStarts(text: string): number[] {
}
export function getPositionOfLineAndCharacter(sourceFile: SourceFileLike, line: number, character: number): number;
/* @internal */
/** @internal */
export function getPositionOfLineAndCharacter(sourceFile: SourceFileLike, line: number, character: number, allowEdits?: true): number; // eslint-disable-line @typescript-eslint/unified-signatures
export function getPositionOfLineAndCharacter(sourceFile: SourceFileLike, line: number, character: number, allowEdits?: true): number {
return sourceFile.getPositionOfLineAndCharacter ?
@ -404,7 +404,7 @@ export function getPositionOfLineAndCharacter(sourceFile: SourceFileLike, line:
computePositionOfLineAndCharacter(getLineStarts(sourceFile), line, character, sourceFile.text, allowEdits);
}
/* @internal */
/** @internal */
export function computePositionOfLineAndCharacter(lineStarts: readonly number[], line: number, character: number, debugText?: string, allowEdits?: true): number {
if (line < 0 || line >= lineStarts.length) {
if (allowEdits) {
@ -432,12 +432,12 @@ export function computePositionOfLineAndCharacter(lineStarts: readonly number[],
return res;
}
/* @internal */
/** @internal */
export function getLineStarts(sourceFile: SourceFileLike): readonly number[] {
return sourceFile.lineMap || (sourceFile.lineMap = computeLineStarts(sourceFile.text));
}
/* @internal */
/** @internal */
export function computeLineAndCharacterOfPosition(lineStarts: readonly number[], position: number): LineAndCharacter {
const lineNumber = computeLineOfPosition(lineStarts, position);
return {
@ -534,7 +534,7 @@ function isCodePoint(code: number): boolean {
return code <= 0x10FFFF;
}
/* @internal */
/** @internal */
export function isOctalDigit(ch: number): boolean {
return ch >= CharacterCodes._0 && ch <= CharacterCodes._7;
}
@ -566,7 +566,7 @@ export function couldStartTrivia(text: string, pos: number): boolean {
}
}
/* @internal */
/** @internal */
export function skipTrivia(text: string, pos: number, stopAfterLineBreak?: boolean, stopAtComments?: boolean, inJSDoc?: boolean): number {
if (positionIsSynthesized(pos)) {
return pos;
@ -720,14 +720,14 @@ function scanConflictMarkerTrivia(text: string, pos: number, error?: (diag: Diag
const shebangTriviaRegex = /^#!.*/;
/*@internal*/
/** @internal */
export function isShebangTrivia(text: string, pos: number) {
// Shebangs check must only be done at the start of the file
Debug.assert(pos === 0);
return shebangTriviaRegex.test(text);
}
/*@internal*/
/** @internal */
export function scanShebangTrivia(text: string, pos: number) {
const shebang = shebangTriviaRegex.exec(text)![0];
pos = pos + shebang.length;
@ -918,7 +918,7 @@ export function isIdentifierPart(ch: number, languageVersion: ScriptTarget | und
ch > CharacterCodes.maxAsciiCharacter && isUnicodeIdentifierPart(ch, languageVersion);
}
/* @internal */
/** @internal */
export function isIdentifierText(name: string, languageVersion: ScriptTarget | undefined, identifierVariant?: LanguageVariant): boolean {
let ch = codePointAt(name, 0);
if (!isIdentifierStart(ch, languageVersion)) {
@ -2616,7 +2616,7 @@ export function createScanner(languageVersion: ScriptTarget,
}
}
/* @internal */
/** @internal */
const codePointAt: (s: string, i: number) => number = (String.prototype as any).codePointAt ? (s, i) => (s as any).codePointAt(i) : function codePointAt(str, i): number {
// from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/codePointAt
const size = str.length;
@ -2637,7 +2637,7 @@ const codePointAt: (s: string, i: number) => number = (String.prototype as any).
return first;
};
/* @internal */
/** @internal */
function charSize(ch: number) {
if (ch >= 0x10000) {
return 2;
@ -2661,7 +2661,7 @@ function utf16EncodeAsStringFallback(codePoint: number) {
const utf16EncodeAsStringWorker: (codePoint: number) => string = (String as any).fromCodePoint ? codePoint => (String as any).fromCodePoint(codePoint) : utf16EncodeAsStringFallback;
/* @internal */
/** @internal */
export function utf16EncodeAsString(codePoint: number) {
return utf16EncodeAsStringWorker(codePoint);
}

6
src/compiler/semver.ts
View File

@ -30,9 +30,10 @@ const buildPartRegExp = /^[a-z0-9-]+$/i;
// > Numeric identifiers MUST NOT include leading zeroes.
const numericIdentifierRegExp = /^(0|[1-9]\d*)$/;
/** @internal */
/**
* Describes a precise semantic version number, https://semver.org
*
* @internal
*/
export class Version {
static readonly zero = new Version(0, 0, 0, ["0"]);
@ -185,9 +186,10 @@ function comparePrereleaseIdentifiers(left: readonly string[], right: readonly s
return compareValues(left.length, right.length);
}
/** @internal */
/**
* Describes a semantic version range, per https://github.com/npm/node-semver#ranges
*
* @internal
*/
export class VersionRange {
private _alternatives: readonly (readonly Comparator[])[];

3
src/compiler/sourcemap.ts
View File

@ -353,9 +353,10 @@ export function getLineInfo(text: string, lineStarts: readonly number[]): LineIn
};
}
/** @internal */
/**
* Tries to find the sourceMappingURL comment at the end of a file.
*
* @internal
*/
export function tryGetSourceMappingURL(lineInfo: LineInfo) {
for (let index = lineInfo.getLineCount() - 1; index >= 0; index--) {

4
src/compiler/symbolWalker.ts
View File

@ -4,8 +4,6 @@ import {
SyntaxKind, Type, TypeFlags, TypeParameter, TypePredicate, TypeQueryNode, TypeReference, UnionOrIntersectionType,
} from "./_namespaces/ts";
/** @internal */
/** @internal */
export function createGetSymbolWalker(
getRestTypeOfSignature: (sig: Signature) => Type,
@ -193,4 +191,4 @@ export function createGetSymbolWalker(
return false;
}
}
}
}

77
src/compiler/sys.ts
View File

@ -14,8 +14,9 @@ declare function clearTimeout(handle: any): void;
/**
* djb2 hashing algorithm
* http://www.cse.yorku.ca/~oz/hash.html
*
* @internal
*/
/* @internal */
export function generateDjb2Hash(data: string): string {
let acc = 5381;
for (let i = 0; i < data.length; i++) {
@ -28,8 +29,9 @@ export function generateDjb2Hash(data: string): string {
* Set a high stack trace limit to provide more information in case of an error.
* Called for command-line and server use cases.
* Not called if TypeScript is used as a library.
*
* @internal
*/
/* @internal */
export function setStackTraceLimit() {
if ((Error as any).stackTraceLimit < 100) { // Also tests that we won't set the property if it doesn't exist.
(Error as any).stackTraceLimit = 100;
@ -50,22 +52,22 @@ interface WatchedFile {
mtime: Date;
}
/* @internal */
/** @internal */
export enum PollingInterval {
High = 2000,
Medium = 500,
Low = 250
}
/* @internal */
/** @internal */
export type HostWatchFile = (fileName: string, callback: FileWatcherCallback, pollingInterval: PollingInterval, options: WatchOptions | undefined) => FileWatcher;
/* @internal */
/** @internal */
export type HostWatchDirectory = (fileName: string, callback: DirectoryWatcherCallback, recursive: boolean, options: WatchOptions | undefined) => FileWatcher;
/* @internal */
/** @internal */
export const missingFileModifiedTime = new Date(0); // Any subsequent modification will occur after this time
/* @internal */
/** @internal */
export function getModifiedTime(host: { getModifiedTime: NonNullable<System["getModifiedTime"]>; }, fileName: string) {
return host.getModifiedTime(fileName) || missingFileModifiedTime;
}
@ -86,7 +88,7 @@ function createPollingIntervalBasedLevels(levels: Levels) {
const defaultChunkLevels: Levels = { Low: 32, Medium: 64, High: 256 };
let pollingChunkSize = createPollingIntervalBasedLevels(defaultChunkLevels);
/* @internal */
/** @internal */
export let unchangedPollThresholds = createPollingIntervalBasedLevels(defaultChunkLevels);
function setCustomPollingValues(system: System) {
@ -483,7 +485,7 @@ function onWatchedFileStat(watchedFile: WatchedFile, modifiedTime: Date): boolea
return false;
}
/*@internal*/
/** @internal */
export function getFileWatcherEventKind(oldTime: number, newTime: number) {
return oldTime === 0
? FileWatcherEventKind.Created
@ -492,17 +494,17 @@ export function getFileWatcherEventKind(oldTime: number, newTime: number) {
: FileWatcherEventKind.Changed;
}
/*@internal*/
/** @internal */
export const ignoredPaths = ["/node_modules/.", "/.git", "/.#"];
let curSysLog: (s: string) => void = noop; // eslint-disable-line prefer-const
/*@internal*/
/** @internal */
export function sysLog(s: string) {
return curSysLog(s);
}
/*@internal*/
/** @internal */
export function setSysLog(logger: typeof sysLog) {
curSysLog = logger;
}
@ -769,17 +771,17 @@ function createDirectoryWatcherSupportingRecursive({
}
}
/*@internal*/
/** @internal */
export type FsWatchCallback = (eventName: "rename" | "change", relativeFileName: string | undefined, modifiedTime?: Date) => void;
/*@internal*/
/** @internal */
export type FsWatch = (fileOrDirectory: string, entryKind: FileSystemEntryKind, callback: FsWatchCallback, recursive: boolean, fallbackPollingInterval: PollingInterval, fallbackOptions: WatchOptions | undefined) => FileWatcher;
/*@internal*/
/** @internal */
export interface FsWatchWorkerWatcher extends FileWatcher {
on(eventName: string, listener: () => void): void;
}
/*@internal*/
/** @internal */
export type FsWatchWorker = (fileOrDirectory: string, recursive: boolean, callback: FsWatchCallback) => FsWatchWorkerWatcher;
/*@internal*/
/** @internal */
export const enum FileSystemEntryKind {
File,
Directory,
@ -840,10 +842,10 @@ function createFsWatchCallbackForDirectoryWatcherCallback(
};
}
/*@internal*/
/** @internal */
export type FileSystemEntryExists = (fileorDirectrory: string, entryKind: FileSystemEntryKind) => boolean;
/*@internal*/
/** @internal */
export interface CreateSystemWatchFunctions {
// Polling watch file
pollingWatchFileWorker: HostWatchFile;
@ -867,7 +869,7 @@ export interface CreateSystemWatchFunctions {
sysLog: (s: string) => void;
}
/*@internal*/
/** @internal */
export function createSystemWatchFunctions({
pollingWatchFileWorker,
getModifiedTime,
@ -1238,8 +1240,9 @@ export function createSystemWatchFunctions({
/**
* patch writefile to create folder before writing the file
*
* @internal
*/
/*@internal*/
export function patchWriteFileEnsuringDirectory(sys: System) {
// patch writefile to create folder before writing the file
const originalWriteFile = sys.writeFile;
@ -1253,10 +1256,10 @@ export function patchWriteFileEnsuringDirectory(sys: System) {
path => sys.directoryExists(path));
}
/*@internal*/
/** @internal */
export type BufferEncoding = "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex";
/*@internal*/
/** @internal */
interface NodeBuffer extends Uint8Array {
constructor: any;
write(str: string, encoding?: BufferEncoding): number;
@ -1332,7 +1335,7 @@ interface NodeBuffer extends Uint8Array {
values(): IterableIterator<number>;
}
/*@internal*/
/** @internal */
interface Buffer extends NodeBuffer { }
// TODO: GH#18217 Methods on System are often used as if they are certainly defined
@ -1372,26 +1375,26 @@ export interface System {
createSHA256Hash?(data: string): string;
getMemoryUsage?(): number;
exit(exitCode?: number): void;
/*@internal*/ enableCPUProfiler?(path: string, continuation: () => void): boolean;
/*@internal*/ disableCPUProfiler?(continuation: () => void): boolean;
/*@internal*/ cpuProfilingEnabled?(): boolean;
/** @internal */ enableCPUProfiler?(path: string, continuation: () => void): boolean;
/** @internal */ disableCPUProfiler?(continuation: () => void): boolean;
/** @internal */ cpuProfilingEnabled?(): boolean;
realpath?(path: string): string;
/*@internal*/ getEnvironmentVariable(name: string): string;
/*@internal*/ tryEnableSourceMapsForHost?(): void;
/*@internal*/ debugMode?: boolean;
/** @internal */ getEnvironmentVariable(name: string): string;
/** @internal */ tryEnableSourceMapsForHost?(): void;
/** @internal */ debugMode?: boolean;
setTimeout?(callback: (...args: any[]) => void, ms: number, ...args: any[]): any;
clearTimeout?(timeoutId: any): void;
clearScreen?(): void;
/*@internal*/ setBlocking?(): void;
/** @internal */ setBlocking?(): void;
base64decode?(input: string): string;
base64encode?(input: string): string;
/*@internal*/ bufferFrom?(input: string, encoding?: string): Buffer;
/*@internal*/ require?(baseDir: string, moduleName: string): RequireResult;
/** @internal */ bufferFrom?(input: string, encoding?: string): Buffer;
/** @internal */ require?(baseDir: string, moduleName: string): RequireResult;
// For testing
/*@internal*/ now?(): Date;
/*@internal*/ disableUseFileVersionAsSignature?: boolean;
/*@internal*/ storeFilesChangingSignatureDuringEmit?: boolean;
/** @internal */ now?(): Date;
/** @internal */ disableUseFileVersionAsSignature?: boolean;
/** @internal */ storeFilesChangingSignatureDuringEmit?: boolean;
}
export interface FileWatcher {
@ -1973,7 +1976,7 @@ export let sys: System = (() => {
return sys!;
})();
/*@internal*/
/** @internal */
export function setSys(s: System) {
sys = s;
}

3
src/compiler/transformer.ts
View File

@ -159,7 +159,6 @@ export function noEmitNotification(hint: EmitHint, node: Node, callback: (hint:
callback(hint, node);
}
/** @internal */
/**
* Transforms an array of SourceFiles by passing them through each transformer.
*
@ -169,6 +168,8 @@ export function noEmitNotification(hint: EmitHint, node: Node, callback: (hint:
* @param nodes An array of nodes to transform.
* @param transforms An array of `TransformerFactory` callbacks.
* @param allowDtsFiles A value indicating whether to allow the transformation of .d.ts files.
*
* @internal
*/
export function transformNodes<T extends Node>(resolver: EmitResolver | undefined, host: EmitHost | undefined, factory: NodeFactory, options: CompilerOptions, nodes: readonly T[], transformers: readonly TransformerFactory<T>[], allowDtsFiles: boolean): TransformationResult<T> {
const enabledSyntaxKindFeatures = new Array<SyntaxKindFeatureFlags>(SyntaxKind.Count);

3
src/compiler/transformers/classFields.ts
View File

@ -159,13 +159,14 @@ const enum ClassFacts {
NeedsSubstitutionForThisInClassStaticField = 1 << 3,
}
/** @internal */
/**
* Transforms ECMAScript Class Syntax.
* TypeScript parameter property syntax is transformed in the TypeScript transformer.
* For now, this transforms public field declarations using TypeScript class semantics,
* where declarations are elided and initializers are transformed as assignments in the constructor.
* When --useDefineForClassFields is on, this transforms to ECMAScript semantics, with Object.defineProperty.
*
* @internal
*/
export function transformClassFields(context: TransformationContext) {
const {

5
src/compiler/transformers/declarations.ts
View File

@ -62,7 +62,7 @@ export function isInternalDeclaration(node: Node, currentSourceFile: SourceFile)
const commentRanges = previousSibling
? concatenate(
// to handle
// ... parameters, /* @internal */
// ... parameters, /** @internal */
// public param: string
getTrailingCommentRanges(text, skipTrivia(text, previousSibling.end + 1, /* stopAfterLineBreak */ false, /* stopAtComments */ true)),
getLeadingCommentRanges(text, node.pos)
@ -85,12 +85,13 @@ const declarationEmitNodeBuilderFlags =
NodeBuilderFlags.GenerateNamesForShadowedTypeParams |
NodeBuilderFlags.NoTruncation;
/** @internal */
/**
* Transforms a ts file into a .d.ts file
* This process requires type information, which is retrieved through the emit resolver. Because of this,
* in many places this transformer assumes it will be operating on parse tree nodes directly.
* This means that _no transforms should be allowed to occur before this one_.
*
* @internal
*/
export function transformDeclarations(context: TransformationContext) {
const throwDiagnostic = () => Debug.fail("Diagnostic emitted without context");

6
src/compiler/transformers/destructuring.ts
View File

@ -34,7 +34,6 @@ export const enum FlattenLevel {
ObjectRest,
}
/** @internal */
/**
* Flattens a DestructuringAssignment or a VariableDeclaration to an expression.
*
@ -45,6 +44,8 @@ export const enum FlattenLevel {
* @param needsValue An optional value indicating whether the value from the right-hand-side of
* the destructuring assignment is needed as part of a larger expression.
* @param createAssignmentCallback An optional callback used to create the assignment expression.
*
* @internal
*/
export function flattenDestructuringAssignment(
node: VariableDeclaration | DestructuringAssignment,
@ -174,7 +175,6 @@ function bindingOrAssignmentPatternContainsNonLiteralComputedName(pattern: Bindi
return !!forEach(getElementsOfBindingOrAssignmentPattern(pattern), bindingOrAssignmentElementContainsNonLiteralComputedName);
}
/** @internal */
/**
* Flattens a VariableDeclaration or ParameterDeclaration to one or more variable declarations.
*
@ -185,6 +185,8 @@ function bindingOrAssignmentPatternContainsNonLiteralComputedName(pattern: Bindi
* @param skipInitializer A value indicating whether to ignore the initializer of `node`.
* @param hoistTempVariables Indicates whether temporary variables should not be recorded in-line.
* @param level Indicates the extent to which flattening should occur.
*
* @internal
*/
export function flattenDestructuringBinding(
node: VariableDeclaration | ParameterDeclaration,

7
src/compiler/transformers/es2017.ts
View File

@ -819,8 +819,11 @@ export function transformES2017(context: TransformationContext) {
}
}
/** @internal */
/** Creates a variable named `_super` with accessor properties for the given property names. */
/**
* Creates a variable named `_super` with accessor properties for the given property names.
*
* @internal
*/
export function createSuperAccessVariableStatement(factory: NodeFactory, resolver: EmitResolver, node: FunctionLikeDeclaration, names: Set<__String>) {
// Create a variable declaration with a getter/setter (if binding) definition for each name:
// const _super = Object.create(null, { x: { get: () => super.x, set: (v) => super.x = v }, ... });

3
src/compiler/transformers/es5.ts
View File

@ -5,11 +5,12 @@ import {
SourceFile, stringToToken, SyntaxKind, TransformationContext,
} from "../_namespaces/ts";
/** @internal */
/**
* Transforms ES5 syntax into ES3 syntax.
*
* @param context Context and state information for the transformation.
*
* @internal
*/
export function transformES5(context: TransformationContext) {
const { factory } = context;

2
src/compiler/transformers/legacyDecorators.ts
View File

@ -720,4 +720,4 @@ export function transformLegacyDecorators(context: TransformationContext) {
return undefined;
}
}
}

2
src/compiler/transformers/typeSerializer.ts
View File

@ -586,4 +586,4 @@ export function createRuntimeTypeSerializer(context: TransformationContext): Run
getGlobalConstructorWithFallback(name) :
factory.createIdentifier(name);
}
}
}

27
src/compiler/transformers/utilities.ts
View File

@ -274,11 +274,12 @@ function multiMapSparseArrayAdd<V>(map: V[][], key: number, value: V): V[] {
return values;
}
/** @internal */
/**
* Used in the module transformer to check if an expression is reasonably without sideeffect,
* and thus better to copy into multiple places rather than to cache in a temporary variable
* - this is mostly subjective beyond the requirement that the expression not be sideeffecting
*
* @internal
*/
export function isSimpleCopiableExpression(expression: Expression) {
return isStringLiteralLike(expression) ||
@ -287,11 +288,12 @@ export function isSimpleCopiableExpression(expression: Expression) {
isIdentifier(expression);
}
/** @internal */
/**
* A simple inlinable expression is an expression which can be copied into multiple locations
* without risk of repeating any sideeffects and whose value could not possibly change between
* any such locations
*
* @internal
*/
export function isSimpleInlineableExpression(expression: Expression) {
return !isIdentifier(expression) && isSimpleCopiableExpression(expression);
@ -325,9 +327,10 @@ export function getNonAssignmentOperatorForCompoundAssignment(kind: CompoundAssi
}
}
/** @internal */
/**
* @returns Contained super() call from descending into the statement ignoring parentheses, if that call exists.
*
* @internal
*/
export function getSuperCallFromStatement(statement: Statement) {
if (!isExpressionStatement(statement)) {
@ -340,9 +343,10 @@ export function getSuperCallFromStatement(statement: Statement) {
: undefined;
}
/** @internal */
/**
* @returns The index (after prologue statements) of a super call, or -1 if not found.
*
* @internal
*/
export function findSuperStatementIndex(statements: NodeArray<Statement>, indexAfterLastPrologueStatement: number) {
for (let i = indexAfterLastPrologueStatement; i < statements.length; i += 1) {
@ -356,12 +360,13 @@ export function findSuperStatementIndex(statements: NodeArray<Statement>, indexA
return -1;
}
/** @internal */
/**
* Gets all the static or all the instance property declarations of a class
*
* @param node The class node.
* @param isStatic A value indicating whether to get properties from the static or instance side of the class.
*
* @internal
*/
export function getProperties(node: ClassExpression | ClassDeclaration, requireInitializer: true, isStatic: boolean): readonly InitializedPropertyDeclaration[];
/** @internal */
@ -400,23 +405,25 @@ function isStaticPropertyDeclaration(member: ClassElement) {
return isPropertyDeclaration(member) && hasStaticModifier(member);
}
/** @internal */
/**
* Gets a value indicating whether a class element is either a static or an instance property declaration with an initializer.
*
* @param member The class element node.
* @param isStatic A value indicating whether the member should be a static or instance member.
*
* @internal
*/
export function isInitializedProperty(member: ClassElement): member is PropertyDeclaration & { initializer: Expression; } {
return member.kind === SyntaxKind.PropertyDeclaration
&& (member as PropertyDeclaration).initializer !== undefined;
}
/** @internal */
/**
* Gets a value indicating whether a class element is a private instance method or accessor.
*
* @param member The class element node.
*
* @internal
*/
export function isNonStaticMethodOrAccessorWithPrivateName(member: ClassElement): member is PrivateIdentifierMethodDeclaration | PrivateIdentifierAccessorDeclaration | PrivateIdentifierAutoAccessorPropertyDeclaration {
return !isStatic(member) && (isMethodOrAccessor(member) || isAutoAccessorPropertyDeclaration(member)) && isPrivateIdentifier(member.name);
@ -450,12 +457,13 @@ function getDecoratorsOfParameters(node: FunctionLikeDeclaration | undefined) {
return decorators;
}
/** @internal */
/**
* Gets an AllDecorators object containing the decorators for the class and the decorators for the
* parameters of the constructor of the class.
*
* @param node The class node.
*
* @internal
*/
export function getAllDecoratorsOfClass(node: ClassLikeDeclaration): AllDecorators | undefined {
const decorators = getDecorators(node);
@ -470,12 +478,13 @@ export function getAllDecoratorsOfClass(node: ClassLikeDeclaration): AllDecorato
};
}
/** @internal */
/**
* Gets an AllDecorators object containing the decorators for the member and its parameters.
*
* @param parent The class node that contains the member.
* @param member The class member.
*
* @internal
*/
export function getAllDecoratorsOfClassElement(member: ClassElement, parent: ClassLikeDeclaration): AllDecorators | undefined {
switch (member.kind) {

2
src/compiler/tsbuild.ts
View File

@ -175,4 +175,4 @@ export function resolveConfigFileProjectName(project: string): ResolvedConfigFil
}
return combinePaths(project, "tsconfig.json") as ResolvedConfigFileName;
}
}

63
src/compiler/tsbuildPublic.ts
View File

@ -36,15 +36,15 @@ export interface BuildOptions {
force?: boolean;
verbose?: boolean;
/*@internal*/ clean?: boolean;
/*@internal*/ watch?: boolean;
/*@internal*/ help?: boolean;
/** @internal */ clean?: boolean;
/** @internal */ watch?: boolean;
/** @internal */ help?: boolean;
/*@internal*/ preserveWatchOutput?: boolean;
/*@internal*/ listEmittedFiles?: boolean;
/*@internal*/ listFiles?: boolean;
/*@internal*/ explainFiles?: boolean;
/*@internal*/ pretty?: boolean;
/** @internal */ preserveWatchOutput?: boolean;
/** @internal */ listEmittedFiles?: boolean;
/** @internal */ listFiles?: boolean;
/** @internal */ explainFiles?: boolean;
/** @internal */ pretty?: boolean;
incremental?: boolean;
assumeChangesOnlyAffectDirectDependencies?: boolean;
declaration?: boolean;
@ -54,11 +54,11 @@ export interface BuildOptions {
inlineSourceMap?: boolean;
traceResolution?: boolean;
/* @internal */ diagnostics?: boolean;
/* @internal */ extendedDiagnostics?: boolean;
/* @internal */ locale?: string;
/* @internal */ generateCpuProfile?: string;
/* @internal */ generateTrace?: string;
/** @internal */ diagnostics?: boolean;
/** @internal */ extendedDiagnostics?: boolean;
/** @internal */ locale?: string;
/** @internal */ generateCpuProfile?: string;
/** @internal */ generateTrace?: string;
[option: string]: CompilerOptionsValue | undefined;
}
@ -85,7 +85,7 @@ enum BuildResultFlags {
AnyErrors = ConfigFileErrors | SyntaxErrors | TypeErrors | DeclarationEmitErrors | EmitErrors
}
/*@internal*/
/** @internal */
export type ResolvedConfigFilePath = ResolvedConfigFileName & Path;
function getOrCreateValueFromConfigFileMap<T>(configFileMap: ESMap<ResolvedConfigFilePath, T>, resolved: ResolvedConfigFilePath, createT: () => T): T {
@ -102,8 +102,11 @@ function getOrCreateValueMapFromConfigFileMap<K extends string, V>(configFileMap
return getOrCreateValueFromConfigFileMap(configFileMap, resolved, () => new Map());
}
/*@internal*/
/** Helper to use now method instead of current date for testing purposes to get consistent baselines */
/**
* Helper to use now method instead of current date for testing purposes to get consistent baselines
*
* @internal
*/
export function getCurrentTime(host: { now?(): Date; }) {
return host.now ? host.now() : new Date();
}
@ -135,11 +138,11 @@ export interface SolutionBuilderHostBase<T extends BuilderProgram> extends Progr
// TODO: To do better with watch mode and normal build mode api that creates program and emits files
// This currently helps enable --diagnostics and --extendedDiagnostics
afterProgramEmitAndDiagnostics?(program: T): void;
/*@internal*/ beforeEmitBundle?(config: ParsedCommandLine): void;
/*@internal*/ afterEmitBundle?(config: ParsedCommandLine): void;
/** @internal */ beforeEmitBundle?(config: ParsedCommandLine): void;
/** @internal */ afterEmitBundle?(config: ParsedCommandLine): void;
// For testing
/*@internal*/ now?(): Date;
/** @internal */ now?(): Date;
}
export interface SolutionBuilderHost<T extends BuilderProgram> extends SolutionBuilderHostBase<T> {
@ -149,22 +152,22 @@ export interface SolutionBuilderHost<T extends BuilderProgram> extends SolutionB
export interface SolutionBuilderWithWatchHost<T extends BuilderProgram> extends SolutionBuilderHostBase<T>, WatchHost {
}
/*@internal*/
/** @internal */
export type BuildOrder = readonly ResolvedConfigFileName[];
/*@internal*/
/** @internal */
export interface CircularBuildOrder {
buildOrder: BuildOrder;
circularDiagnostics: readonly Diagnostic[];
}
/*@internal*/
/** @internal */
export type AnyBuildOrder = BuildOrder | CircularBuildOrder;
/*@internal*/
/** @internal */
export function isCircularBuildOrder(buildOrder: AnyBuildOrder): buildOrder is CircularBuildOrder {
return !!buildOrder && !!(buildOrder as CircularBuildOrder).buildOrder;
}
/*@internal*/
/** @internal */
export function getBuildOrderFromAnyBuildOrder(anyBuildOrder: AnyBuildOrder): BuildOrder {
return isCircularBuildOrder(anyBuildOrder) ? anyBuildOrder.buildOrder : anyBuildOrder;
}
@ -177,12 +180,12 @@ export interface SolutionBuilder<T extends BuilderProgram> {
getNextInvalidatedProject(cancellationToken?: CancellationToken): InvalidatedProject<T> | undefined;
// Currently used for testing but can be made public if needed:
/*@internal*/ getBuildOrder(): AnyBuildOrder;
/** @internal */ getBuildOrder(): AnyBuildOrder;
// Testing only
/*@internal*/ getUpToDateStatusOfProject(project: string): UpToDateStatus;
/*@internal*/ invalidateProject(configFilePath: ResolvedConfigFilePath, reloadLevel?: ConfigFileProgramReloadLevel): void;
/*@internal*/ close(): void;
/** @internal */ getUpToDateStatusOfProject(project: string): UpToDateStatus;
/** @internal */ invalidateProject(configFilePath: ResolvedConfigFilePath, reloadLevel?: ConfigFileProgramReloadLevel): void;
/** @internal */ close(): void;
}
/**
@ -688,8 +691,8 @@ export enum InvalidatedProjectKind {
export interface InvalidatedProjectBase {
readonly kind: InvalidatedProjectKind;
readonly project: ResolvedConfigFileName;
/*@internal*/ readonly projectPath: ResolvedConfigFilePath;
/*@internal*/ readonly buildOrder: readonly ResolvedConfigFileName[];
/** @internal */ readonly projectPath: ResolvedConfigFilePath;
/** @internal */ readonly buildOrder: readonly ResolvedConfigFileName[];
/**
* To dispose this project and ensure that all the necessary actions are taken and state is updated accordingly
*/

1747
src/compiler/types.ts
View File

File diff suppressed because it is too large Load Diff

375
src/compiler/utilities.ts
View File

File diff suppressed because it is too large Load Diff

187
src/compiler/utilitiesPublic.ts
View File

@ -96,7 +96,7 @@ export function textSpanContainsPosition(span: TextSpan, position: number) {
return position >= span.start && position < textSpanEnd(span);
}
/* @internal */
/** @internal */
export function textRangeContainsPositionInclusive(span: TextRange, position: number): boolean {
return position >= span.pos && position <= span.end;
}
@ -355,7 +355,7 @@ export function getCombinedModifierFlags(node: Declaration): ModifierFlags {
return getCombinedFlags(node, getEffectiveModifierFlags);
}
/* @internal */
/** @internal */
export function getCombinedNodeFlagsAlwaysIncludeJSDoc(node: Declaration): ModifierFlags {
return getCombinedFlags(node, getEffectiveModifierFlagsAlwaysIncludeJSDoc);
}
@ -371,7 +371,7 @@ export function getCombinedNodeFlags(node: Node): NodeFlags {
return getCombinedFlags(node, n => n.flags);
}
/* @internal */
/** @internal */
export const supportedLocaleDirectories = ["cs", "de", "es", "fr", "it", "ja", "ko", "pl", "pt-br", "ru", "tr", "zh-cn", "zh-tw"];
/**
@ -673,7 +673,7 @@ export function getNameOfDeclaration(declaration: Declaration | Expression | und
(isFunctionExpression(declaration) || isArrowFunction(declaration) || isClassExpression(declaration) ? getAssignedName(declaration) : undefined);
}
/*@internal*/
/** @internal */
export function getAssignedName(node: Node): DeclarationName | undefined {
if (!node.parent) {
return undefined;
@ -741,7 +741,7 @@ export function getJSDocParameterTags(param: ParameterDeclaration): readonly JSD
return getJSDocParameterTagsWorker(param, /*noCache*/ false);
}
/* @internal */
/** @internal */
export function getJSDocParameterTagsNoCache(param: ParameterDeclaration): readonly JSDocParameterTag[] {
return getJSDocParameterTagsWorker(param, /*noCache*/ true);
}
@ -766,7 +766,7 @@ export function getJSDocTypeParameterTags(param: TypeParameterDeclaration): read
return getJSDocTypeParameterTagsWorker(param, /*noCache*/ false);
}
/* @internal */
/** @internal */
export function getJSDocTypeParameterTagsNoCache(param: TypeParameterDeclaration): readonly JSDocTemplateTag[] {
return getJSDocTypeParameterTagsWorker(param, /*noCache*/ true);
}
@ -801,7 +801,7 @@ export function getJSDocPublicTag(node: Node): JSDocPublicTag | undefined {
return getFirstJSDocTag(node, isJSDocPublicTag);
}
/*@internal*/
/** @internal */
export function getJSDocPublicTagNoCache(node: Node): JSDocPublicTag | undefined {
return getFirstJSDocTag(node, isJSDocPublicTag, /*noCache*/ true);
}
@ -811,7 +811,7 @@ export function getJSDocPrivateTag(node: Node): JSDocPrivateTag | undefined {
return getFirstJSDocTag(node, isJSDocPrivateTag);
}
/*@internal*/
/** @internal */
export function getJSDocPrivateTagNoCache(node: Node): JSDocPrivateTag | undefined {
return getFirstJSDocTag(node, isJSDocPrivateTag, /*noCache*/ true);
}
@ -821,7 +821,7 @@ export function getJSDocProtectedTag(node: Node): JSDocProtectedTag | undefined
return getFirstJSDocTag(node, isJSDocProtectedTag);
}
/*@internal*/
/** @internal */
export function getJSDocProtectedTagNoCache(node: Node): JSDocProtectedTag | undefined {
return getFirstJSDocTag(node, isJSDocProtectedTag, /*noCache*/ true);
}
@ -831,7 +831,7 @@ export function getJSDocReadonlyTag(node: Node): JSDocReadonlyTag | undefined {
return getFirstJSDocTag(node, isJSDocReadonlyTag);
}
/*@internal*/
/** @internal */
export function getJSDocReadonlyTagNoCache(node: Node): JSDocReadonlyTag | undefined {
return getFirstJSDocTag(node, isJSDocReadonlyTag, /*noCache*/ true);
}
@ -845,7 +845,7 @@ export function getJSDocDeprecatedTag(node: Node): JSDocDeprecatedTag | undefine
return getFirstJSDocTag(node, isJSDocDeprecatedTag);
}
/*@internal */
/** @internal */
export function getJSDocDeprecatedTagNoCache(node: Node): JSDocDeprecatedTag | undefined {
return getFirstJSDocTag(node, isJSDocDeprecatedTag, /*noCache*/ true);
}
@ -943,7 +943,7 @@ export function getJSDocTags(node: Node): readonly JSDocTag[] {
return getJSDocTagsWorker(node, /*noCache*/ false);
}
/* @internal */
/** @internal */
export function getJSDocTagsNoCache(node: Node): readonly JSDocTag[] {
return getJSDocTagsWorker(node, /*noCache*/ true);
}
@ -1027,7 +1027,7 @@ export function isMemberName(node: Node): node is MemberName {
return node.kind === SyntaxKind.Identifier || node.kind === SyntaxKind.PrivateIdentifier;
}
/* @internal */
/** @internal */
export function isGetOrSetAccessorDeclaration(node: Node): node is AccessorDeclaration {
return node.kind === SyntaxKind.SetAccessor || node.kind === SyntaxKind.GetAccessor;
}
@ -1053,15 +1053,16 @@ export function isOptionalChain(node: Node): node is PropertyAccessChain | Eleme
|| kind === SyntaxKind.NonNullExpression);
}
/* @internal */
/** @internal */
export function isOptionalChainRoot(node: Node): node is OptionalChainRoot {
return isOptionalChain(node) && !isNonNullExpression(node) && !!node.questionDotToken;
}
/**
* Determines whether a node is the expression preceding an optional chain (i.e. `a` in `a?.b`).
*
* @internal
*/
/* @internal */
export function isExpressionOfOptionalChainRoot(node: Node): node is Expression & { parent: OptionalChainRoot } {
return isOptionalChainRoot(node.parent) && node.parent.expression === node;
}
@ -1076,8 +1077,9 @@ export function isExpressionOfOptionalChainRoot(node: Node): node is Expression
* the end of the chain starting at `c?.`)
* 5. For `a?.(b?.c).d`, both `b?.c` and `a?.(b?.c)d` are outermost (`c` is the end of the chain starting at `b`, and `d` is
* the end of the chain starting at `a?.`)
*
* @internal
*/
/* @internal */
export function isOutermostOptionalChain(node: OptionalChain) {
return !isOptionalChain(node.parent) // cases 1, 2, and 3
|| isOptionalChainRoot(node.parent) // case 4
@ -1138,12 +1140,12 @@ export function isJSDocPropertyLikeTag(node: Node): node is JSDocPropertyLikeTag
//
// All node tests in the following list should *not* reference parent pointers so that
// they may be used with transformations.
/* @internal */
/** @internal */
export function isNode(node: Node) {
return isNodeKind(node.kind);
}
/* @internal */
/** @internal */
export function isNodeKind(kind: SyntaxKind) {
return kind >= SyntaxKind.FirstNode;
}
@ -1168,14 +1170,14 @@ export function isToken(n: Node): boolean {
// Node Arrays
/* @internal */
/** @internal */
export function isNodeArray<T extends Node>(array: readonly T[]): array is NodeArray<T> {
return hasProperty(array, "pos") && hasProperty(array, "end");
}
// Literals
/* @internal */
/** @internal */
export function isLiteralKind(kind: SyntaxKind): kind is LiteralToken["kind"] {
return SyntaxKind.FirstLiteralToken <= kind && kind <= SyntaxKind.LastLiteralToken;
}
@ -1199,7 +1201,7 @@ export function isLiteralExpressionOfObject(node: Node) {
// Pseudo-literals
/* @internal */
/** @internal */
export function isTemplateLiteralKind(kind: SyntaxKind): kind is TemplateLiteralToken["kind"] {
return SyntaxKind.FirstTemplateToken <= kind && kind <= SyntaxKind.LastTemplateToken;
}
@ -1243,30 +1245,30 @@ export function isStringTextContainingNode(node: Node): node is StringLiteral |
// Identifiers
/* @internal */
/** @internal */
export function isGeneratedIdentifier(node: Node): node is GeneratedIdentifier {
return isIdentifier(node) && (node.autoGenerateFlags! & GeneratedIdentifierFlags.KindMask) > GeneratedIdentifierFlags.None;
}
/* @internal */
/** @internal */
export function isGeneratedPrivateIdentifier(node: Node): node is GeneratedPrivateIdentifier {
return isPrivateIdentifier(node) && (node.autoGenerateFlags! & GeneratedIdentifierFlags.KindMask) > GeneratedIdentifierFlags.None;
}
// Private Identifiers
/*@internal*/
/** @internal */
export function isPrivateIdentifierClassElementDeclaration(node: Node): node is PrivateClassElementDeclaration {
return (isPropertyDeclaration(node) || isMethodOrAccessor(node)) && isPrivateIdentifier(node.name);
}
/*@internal*/
/** @internal */
export function isPrivateIdentifierPropertyAccessExpression(node: Node): node is PrivateIdentifierPropertyAccessExpression {
return isPropertyAccessExpression(node) && isPrivateIdentifier(node.name);
}
// Keywords
/* @internal */
/** @internal */
export function isModifierKind(token: SyntaxKind): token is Modifier["kind"] {
switch (token) {
case SyntaxKind.AbstractKeyword:
@ -1289,12 +1291,12 @@ export function isModifierKind(token: SyntaxKind): token is Modifier["kind"] {
return false;
}
/* @internal */
/** @internal */
export function isParameterPropertyModifier(kind: SyntaxKind): boolean {
return !!(modifierToFlag(kind) & ModifierFlags.ParameterPropertyModifier);
}
/* @internal */
/** @internal */
export function isClassMemberModifier(idToken: SyntaxKind): boolean {
return isParameterPropertyModifier(idToken) ||
idToken === SyntaxKind.StaticKeyword ||
@ -1334,17 +1336,17 @@ export function isFunctionLike(node: Node | undefined): node is SignatureDeclara
return !!node && isFunctionLikeKind(node.kind);
}
/* @internal */
/** @internal */
export function isFunctionLikeOrClassStaticBlockDeclaration(node: Node | undefined): node is SignatureDeclaration | ClassStaticBlockDeclaration {
return !!node && (isFunctionLikeKind(node.kind) || isClassStaticBlockDeclaration(node));
}
/* @internal */
/** @internal */
export function isFunctionLikeDeclaration(node: Node): node is FunctionLikeDeclaration {
return node && isFunctionLikeDeclarationKind(node.kind);
}
/* @internal */
/** @internal */
export function isBooleanLiteral(node: Node): node is BooleanLiteral {
return node.kind === SyntaxKind.TrueKeyword || node.kind === SyntaxKind.FalseKeyword;
}
@ -1364,7 +1366,7 @@ function isFunctionLikeDeclarationKind(kind: SyntaxKind): boolean {
}
}
/* @internal */
/** @internal */
export function isFunctionLikeKind(kind: SyntaxKind): boolean {
switch (kind) {
case SyntaxKind.MethodSignature:
@ -1381,7 +1383,7 @@ export function isFunctionLikeKind(kind: SyntaxKind): boolean {
}
}
/* @internal */
/** @internal */
export function isFunctionOrModuleBlock(node: Node): boolean {
return isSourceFile(node) || isModuleBlock(node) || isBlock(node) && isFunctionLike(node.parent);
}
@ -1411,7 +1413,7 @@ export function isAutoAccessorPropertyDeclaration(node: Node): node is AutoAcces
return isPropertyDeclaration(node) && hasAccessorModifier(node);
}
/* @internal */
/** @internal */
export function isMethodOrAccessor(node: Node): node is MethodDeclaration | AccessorDeclaration {
switch (node.kind) {
case SyntaxKind.MethodDeclaration:
@ -1423,7 +1425,7 @@ export function isMethodOrAccessor(node: Node): node is MethodDeclaration | Acce
}
}
/* @internal */
/** @internal */
export function isNamedClassElement(node: Node): node is MethodDeclaration | AccessorDeclaration | PropertyDeclaration {
switch (node.kind) {
case SyntaxKind.MethodDeclaration:
@ -1490,7 +1492,7 @@ export function isFunctionOrConstructorTypeNode(node: Node): node is FunctionTyp
// Binding patterns
/* @internal */
/** @internal */
export function isBindingPattern(node: Node | undefined): node is BindingPattern {
if (node) {
const kind = node.kind;
@ -1501,7 +1503,7 @@ export function isBindingPattern(node: Node | undefined): node is BindingPattern
return false;
}
/* @internal */
/** @internal */
export function isAssignmentPattern(node: Node): node is AssignmentPattern {
const kind = node.kind;
return kind === SyntaxKind.ArrayLiteralExpression
@ -1509,7 +1511,7 @@ export function isAssignmentPattern(node: Node): node is AssignmentPattern {
}
/* @internal */
/** @internal */
export function isArrayBindingElement(node: Node): node is ArrayBindingElement {
const kind = node.kind;
return kind === SyntaxKind.BindingElement
@ -1519,8 +1521,9 @@ export function isArrayBindingElement(node: Node): node is ArrayBindingElement {
/**
* Determines whether the BindingOrAssignmentElement is a BindingElement-like declaration
*
* @internal
*/
/* @internal */
export function isDeclarationBindingElement(bindingElement: BindingOrAssignmentElement): bindingElement is VariableDeclaration | ParameterDeclaration | BindingElement {
switch (bindingElement.kind) {
case SyntaxKind.VariableDeclaration:
@ -1534,8 +1537,9 @@ export function isDeclarationBindingElement(bindingElement: BindingOrAssignmentE
/**
* Determines whether a node is a BindingOrAssignmentPattern
*
* @internal
*/
/* @internal */
export function isBindingOrAssignmentPattern(node: BindingOrAssignmentElementTarget): node is BindingOrAssignmentPattern {
return isObjectBindingOrAssignmentPattern(node)
|| isArrayBindingOrAssignmentPattern(node);
@ -1543,8 +1547,9 @@ export function isBindingOrAssignmentPattern(node: BindingOrAssignmentElementTar
/**
* Determines whether a node is an ObjectBindingOrAssignmentPattern
*
* @internal
*/
/* @internal */
export function isObjectBindingOrAssignmentPattern(node: BindingOrAssignmentElementTarget): node is ObjectBindingOrAssignmentPattern {
switch (node.kind) {
case SyntaxKind.ObjectBindingPattern:
@ -1555,7 +1560,7 @@ export function isObjectBindingOrAssignmentPattern(node: BindingOrAssignmentElem
return false;
}
/* @internal */
/** @internal */
export function isObjectBindingOrAssignmentElement(node: Node): node is ObjectBindingOrAssignmentElement {
switch (node.kind) {
case SyntaxKind.BindingElement:
@ -1569,8 +1574,9 @@ export function isObjectBindingOrAssignmentElement(node: Node): node is ObjectBi
/**
* Determines whether a node is an ArrayBindingOrAssignmentPattern
*
* @internal
*/
/* @internal */
export function isArrayBindingOrAssignmentPattern(node: BindingOrAssignmentElementTarget): node is ArrayBindingOrAssignmentPattern {
switch (node.kind) {
case SyntaxKind.ArrayBindingPattern:
@ -1581,7 +1587,7 @@ export function isArrayBindingOrAssignmentPattern(node: BindingOrAssignmentEleme
return false;
}
/* @internal */
/** @internal */
export function isPropertyAccessOrQualifiedNameOrImportTypeNode(node: Node): node is PropertyAccessExpression | QualifiedName | ImportTypeNode {
const kind = node.kind;
return kind === SyntaxKind.PropertyAccessExpression
@ -1621,7 +1627,7 @@ export function isTemplateLiteral(node: Node): node is TemplateLiteral {
|| kind === SyntaxKind.NoSubstitutionTemplateLiteral;
}
/* @internal */
/** @internal */
export function isLeftHandSideExpression(node: Node): node is LeftHandSideExpression {
return isLeftHandSideExpressionKind(skipPartiallyEmittedExpressions(node).kind);
}
@ -1664,7 +1670,7 @@ function isLeftHandSideExpressionKind(kind: SyntaxKind): boolean {
}
}
/* @internal */
/** @internal */
export function isUnaryExpression(node: Node): node is UnaryExpression {
return isUnaryExpressionKind(skipPartiallyEmittedExpressions(node).kind);
}
@ -1684,7 +1690,7 @@ function isUnaryExpressionKind(kind: SyntaxKind): boolean {
}
}
/* @internal */
/** @internal */
export function isUnaryExpressionWithWrite(expr: Node): expr is PrefixUnaryExpression | PostfixUnaryExpression {
switch (expr.kind) {
case SyntaxKind.PostfixUnaryExpression:
@ -1697,10 +1703,11 @@ export function isUnaryExpressionWithWrite(expr: Node): expr is PrefixUnaryExpre
}
}
/* @internal */
/**
* Determines whether a node is an expression based only on its kind.
* Use `isExpressionNode` if not in transforms.
*
* @internal
*/
export function isExpression(node: Node): node is Expression {
return isExpressionKind(skipPartiallyEmittedExpressions(node).kind);
@ -1730,7 +1737,7 @@ export function isAssertionExpression(node: Node): node is AssertionExpression {
|| kind === SyntaxKind.AsExpression;
}
/* @internal */
/** @internal */
export function isNotEmittedOrPartiallyEmittedNode(node: Node): node is NotEmittedStatement | PartiallyEmittedExpression {
return isNotEmittedStatement(node)
|| isPartiallyEmittedExpression(node);
@ -1755,52 +1762,52 @@ export function isIterationStatement(node: Node, lookInLabeledStatements: boolea
return false;
}
/* @internal */
/** @internal */
export function isScopeMarker(node: Node) {
return isExportAssignment(node) || isExportDeclaration(node);
}
/* @internal */
/** @internal */
export function hasScopeMarker(statements: readonly Statement[]) {
return some(statements, isScopeMarker);
}
/* @internal */
/** @internal */
export function needsScopeMarker(result: Statement) {
return !isAnyImportOrReExport(result) && !isExportAssignment(result) && !hasSyntacticModifier(result, ModifierFlags.Export) && !isAmbientModule(result);
}
/* @internal */
/** @internal */
export function isExternalModuleIndicator(result: Statement) {
// Exported top-level member indicates moduleness
return isAnyImportOrReExport(result) || isExportAssignment(result) || hasSyntacticModifier(result, ModifierFlags.Export);
}
/* @internal */
/** @internal */
export function isForInOrOfStatement(node: Node): node is ForInOrOfStatement {
return node.kind === SyntaxKind.ForInStatement || node.kind === SyntaxKind.ForOfStatement;
}
// Element
/* @internal */
/** @internal */
export function isConciseBody(node: Node): node is ConciseBody {
return isBlock(node)
|| isExpression(node);
}
/* @internal */
/** @internal */
export function isFunctionBody(node: Node): node is FunctionBody {
return isBlock(node);
}
/* @internal */
/** @internal */
export function isForInitializer(node: Node): node is ForInitializer {
return isVariableDeclarationList(node)
|| isExpression(node);
}
/* @internal */
/** @internal */
export function isModuleBody(node: Node): node is ModuleBody {
const kind = node.kind;
return kind === SyntaxKind.ModuleBlock
@ -1808,28 +1815,28 @@ export function isModuleBody(node: Node): node is ModuleBody {
|| kind === SyntaxKind.Identifier;
}
/* @internal */
/** @internal */
export function isNamespaceBody(node: Node): node is NamespaceBody {
const kind = node.kind;
return kind === SyntaxKind.ModuleBlock
|| kind === SyntaxKind.ModuleDeclaration;
}
/* @internal */
/** @internal */
export function isJSDocNamespaceBody(node: Node): node is JSDocNamespaceBody {
const kind = node.kind;
return kind === SyntaxKind.Identifier
|| kind === SyntaxKind.ModuleDeclaration;
}
/* @internal */
/** @internal */
export function isNamedImportBindings(node: Node): node is NamedImportBindings {
const kind = node.kind;
return kind === SyntaxKind.NamedImports
|| kind === SyntaxKind.NamespaceImport;
}
/* @internal */
/** @internal */
export function isModuleOrEnumDeclaration(node: Node): node is ModuleDeclaration | EnumDeclaration {
return node.kind === SyntaxKind.ModuleDeclaration || node.kind === SyntaxKind.EnumDeclaration;
}
@ -1911,7 +1918,7 @@ function isStatementKindButNotDeclarationKind(kind: SyntaxKind) {
|| kind === SyntaxKind.MergeDeclarationMarker;
}
/* @internal */
/** @internal */
export function isDeclaration(node: Node): node is NamedDeclaration {
if (node.kind === SyntaxKind.TypeParameter) {
return (node.parent && node.parent.kind !== SyntaxKind.JSDocTemplateTag) || isInJSFile(node);
@ -1920,20 +1927,21 @@ export function isDeclaration(node: Node): node is NamedDeclaration {
return isDeclarationKind(node.kind);
}
/* @internal */
/** @internal */
export function isDeclarationStatement(node: Node): node is DeclarationStatement {
return isDeclarationStatementKind(node.kind);
}
/**
* Determines whether the node is a statement that is not also a declaration
*
* @internal
*/
/* @internal */
export function isStatementButNotDeclaration(node: Node): node is Statement {
return isStatementKindButNotDeclarationKind(node.kind);
}
/* @internal */
/** @internal */
export function isStatement(node: Node): node is Statement {
const kind = node.kind;
return isStatementKindButNotDeclarationKind(kind)
@ -1953,8 +1961,9 @@ function isBlockStatement(node: Node): node is Block {
/**
* NOTE: This is similar to `isStatement` but does not access parent pointers.
*
* @internal
*/
/* @internal */
export function isStatementOrBlock(node: Node): node is Statement | Block {
const kind = node.kind;
return isStatementKindButNotDeclarationKind(kind)
@ -1964,7 +1973,7 @@ export function isStatementOrBlock(node: Node): node is Statement | Block {
// Module references
/* @internal */
/** @internal */
export function isModuleReference(node: Node): node is ModuleReference {
const kind = node.kind;
return kind === SyntaxKind.ExternalModuleReference
@ -1974,7 +1983,7 @@ export function isModuleReference(node: Node): node is ModuleReference {
// JSX
/* @internal */
/** @internal */
export function isJsxTagNameExpression(node: Node): node is JsxTagNameExpression {
const kind = node.kind;
return kind === SyntaxKind.ThisKeyword
@ -1982,7 +1991,7 @@ export function isJsxTagNameExpression(node: Node): node is JsxTagNameExpression
|| kind === SyntaxKind.PropertyAccessExpression;
}
/* @internal */
/** @internal */
export function isJsxChild(node: Node): node is JsxChild {
const kind = node.kind;
return kind === SyntaxKind.JsxElement
@ -1992,14 +2001,14 @@ export function isJsxChild(node: Node): node is JsxChild {
|| kind === SyntaxKind.JsxFragment;
}
/* @internal */
/** @internal */
export function isJsxAttributeLike(node: Node): node is JsxAttributeLike {
const kind = node.kind;
return kind === SyntaxKind.JsxAttribute
|| kind === SyntaxKind.JsxSpreadAttribute;
}
/* @internal */
/** @internal */
export function isStringLiteralOrJsxExpression(node: Node): node is StringLiteral | JsxExpression {
const kind = node.kind;
return kind === SyntaxKind.StringLiteral
@ -2022,8 +2031,11 @@ export function isCaseOrDefaultClause(node: Node): node is CaseOrDefaultClause {
// JSDoc
/** True if node is of some JSDoc syntax kind. */
/* @internal */
/**
* True if node is of some JSDoc syntax kind.
*
* @internal
*/
export function isJSDocNode(node: Node): boolean {
return node.kind >= SyntaxKind.FirstJSDocNode && node.kind <= SyntaxKind.LastJSDocNode;
}
@ -2040,7 +2052,7 @@ export function isJSDocCommentContainingNode(node: Node): boolean {
}
// TODO: determine what this does before making it public.
/* @internal */
/** @internal */
export function isJSDocTag(node: Node): node is JSDocTag {
return node.kind >= SyntaxKind.FirstJSDocTagNode && node.kind <= SyntaxKind.LastJSDocTagNode;
}
@ -2053,22 +2065,31 @@ export function isGetAccessor(node: Node): node is GetAccessorDeclaration {
return node.kind === SyntaxKind.GetAccessor;
}
/** True if has jsdoc nodes attached to it. */
/* @internal */
/**
* True if has jsdoc nodes attached to it.
*
* @internal
*/
// TODO: GH#19856 Would like to return `node is Node & { jsDoc: JSDoc[] }` but it causes long compile times
export function hasJSDocNodes(node: Node): node is HasJSDoc {
const { jsDoc } = node as JSDocContainer;
return !!jsDoc && jsDoc.length > 0;
}
/** True if has type node attached to it. */
/* @internal */
/**
* True if has type node attached to it.
*
* @internal
*/
export function hasType(node: Node): node is HasType {
return !!(node as HasType).type;
}
/** True if has initializer node attached to it. */
/* @internal */
/**
* True if has initializer node attached to it.
*
* @internal
*/
export function hasInitializer(node: Node): node is HasInitializer {
return !!(node as HasInitializer).initializer;
}
@ -2092,13 +2113,13 @@ export function isObjectLiteralElement(node: Node): node is ObjectLiteralElement
return node.kind === SyntaxKind.JsxAttribute || node.kind === SyntaxKind.JsxSpreadAttribute || isObjectLiteralElementLike(node);
}
/* @internal */
/** @internal */
export function isTypeReferenceType(node: Node): node is TypeReferenceType {
return node.kind === SyntaxKind.TypeReference || node.kind === SyntaxKind.ExpressionWithTypeArguments;
}
const MAX_SMI_X86 = 0x3fff_ffff;
/* @internal */
/** @internal */
export function guessIndentation(lines: string[]) {
let indentation = MAX_SMI_X86;
for (const line of lines) {

26
src/compiler/visitorPublic.ts
View File

@ -64,7 +64,7 @@ export function visitNode<T extends Node>(node: T | undefined, visitor: Visitor
return visitedNode as T;
}
/* @internal */
/** @internal */
export function visitNodes<T extends Node, U extends T>(nodes: NodeArray<T>, visitor: Visitor, test: (node: Node) => node is U, start?: number, count?: number): NodeArray<U>;
/**
@ -78,7 +78,7 @@ export function visitNodes<T extends Node, U extends T>(nodes: NodeArray<T>, vis
*/
export function visitNodes<T extends Node>(nodes: NodeArray<T>, visitor: Visitor | undefined, test?: (node: Node) => boolean, start?: number, count?: number): NodeArray<T>;
/* @internal */
/** @internal */
export function visitNodes<T extends Node, U extends T>(nodes: NodeArray<T> | undefined, visitor: Visitor, test: (node: Node) => node is U, start?: number, count?: number): NodeArray<U> | undefined;
/**
@ -141,13 +141,13 @@ export function visitNodes<T extends Node>(nodes: NodeArray<T> | undefined, visi
return nodes;
}
/* @internal */
/** @internal */
export function visitArray<T extends Node, U extends T>(nodes: T[] | undefined, visitor: Visitor, test: (node: Node) => node is U, start?: number, count?: number): U[] | undefined;
/* @internal */
/** @internal */
export function visitArray<T extends Node, U extends T>(nodes: readonly T[] | undefined, visitor: Visitor, test: (node: Node) => node is U, start?: number, count?: number): readonly U[] | undefined;
/* @internal */
/** @internal */
export function visitArray<T extends Node>(nodes: T[] | undefined, visitor: Visitor, test: (node: Node) => node is T, start?: number, count?: number): T[] | undefined;
/* @internal */
/** @internal */
export function visitArray<T extends Node>(nodes: readonly T[] | undefined, visitor: Visitor, test: (node: Node) => node is T, start?: number, count?: number): readonly T[] | undefined;
export function visitArray<T extends Node, U extends T>(nodes: readonly T[] | undefined, visitor: Visitor, test: (node: Node) => node is U, start?: number, count?: number) {
if (nodes === undefined) {
@ -167,7 +167,7 @@ export function visitArray<T extends Node, U extends T>(nodes: readonly T[] | un
return visitArrayWorker(nodes, visitor, test, start, count) as readonly U[];
}
/* @internal */
/** @internal */
function visitArrayWorker<T extends Node>(nodes: readonly T[], visitor: Visitor, test: ((node: Node) => boolean) | undefined, start: number, count: number): readonly T[] | undefined {
let updated: T[] | undefined;
@ -355,9 +355,9 @@ export function visitFunctionBody(node: FunctionBody | undefined, visitor: Visit
* environment and merging hoisted declarations upon completion.
*/
export function visitFunctionBody(node: ConciseBody, visitor: Visitor, context: TransformationContext): ConciseBody;
/* @internal*/ export function visitFunctionBody(node: FunctionBody, visitor: Visitor, context: TransformationContext, nodeVisitor?: NodeVisitor): FunctionBody; // eslint-disable-line @typescript-eslint/unified-signatures
/* @internal*/ export function visitFunctionBody(node: FunctionBody | undefined, visitor: Visitor, context: TransformationContext, nodeVisitor?: NodeVisitor): FunctionBody | undefined; // eslint-disable-line @typescript-eslint/unified-signatures
/* @internal*/ export function visitFunctionBody(node: ConciseBody, visitor: Visitor, context: TransformationContext, nodeVisitor?: NodeVisitor): ConciseBody; // eslint-disable-line @typescript-eslint/unified-signatures
/** @internal */ export function visitFunctionBody(node: FunctionBody, visitor: Visitor, context: TransformationContext, nodeVisitor?: NodeVisitor): FunctionBody; // eslint-disable-line @typescript-eslint/unified-signatures
/** @internal */ export function visitFunctionBody(node: FunctionBody | undefined, visitor: Visitor, context: TransformationContext, nodeVisitor?: NodeVisitor): FunctionBody | undefined; // eslint-disable-line @typescript-eslint/unified-signatures
/** @internal */ export function visitFunctionBody(node: ConciseBody, visitor: Visitor, context: TransformationContext, nodeVisitor?: NodeVisitor): ConciseBody; // eslint-disable-line @typescript-eslint/unified-signatures
export function visitFunctionBody(node: ConciseBody | undefined, visitor: Visitor, context: TransformationContext, nodeVisitor: NodeVisitor = visitNode): ConciseBody | undefined {
context.resumeLexicalEnvironment();
const updated = nodeVisitor(node, visitor, isConciseBody);
@ -377,7 +377,7 @@ export function visitFunctionBody(node: ConciseBody | undefined, visitor: Visito
* Visits an iteration body, adding any block-scoped variables required by the transformation.
*/
export function visitIterationBody(body: Statement, visitor: Visitor, context: TransformationContext): Statement;
/* @internal */
/** @internal */
export function visitIterationBody(body: Statement, visitor: Visitor, context: TransformationContext, nodeVisitor?: NodeVisitor): Statement; // eslint-disable-line @typescript-eslint/unified-signatures
export function visitIterationBody(body: Statement, visitor: Visitor, context: TransformationContext, nodeVisitor: NodeVisitor = visitNode): Statement {
context.startBlockScope();
@ -402,7 +402,7 @@ export function visitIterationBody(body: Statement, visitor: Visitor, context: T
* @param context A lexical environment context for the visitor.
*/
export function visitEachChild<T extends Node>(node: T, visitor: Visitor, context: TransformationContext): T;
/* @internal */
/** @internal */
export function visitEachChild<T extends Node>(node: T, visitor: Visitor, context: TransformationContext, nodesVisitor?: NodesVisitor, tokenVisitor?: Visitor, nodeVisitor?: NodeVisitor): T; // eslint-disable-line @typescript-eslint/unified-signatures
/**
* Visits each child of a Node using the supplied visitor, possibly returning a new Node of the same kind in its place.
@ -412,7 +412,7 @@ export function visitEachChild<T extends Node>(node: T, visitor: Visitor, contex
* @param context A lexical environment context for the visitor.
*/
export function visitEachChild<T extends Node>(node: T | undefined, visitor: Visitor, context: TransformationContext, nodesVisitor?: typeof visitNodes, tokenVisitor?: Visitor): T | undefined;
/* @internal */
/** @internal */
export function visitEachChild<T extends Node>(node: T | undefined, visitor: Visitor, context: TransformationContext, nodesVisitor?: NodesVisitor, tokenVisitor?: Visitor, nodeVisitor?: NodeVisitor): T | undefined; // eslint-disable-line @typescript-eslint/unified-signatures
export function visitEachChild<T extends Node>(node: T | undefined, visitor: Visitor, context: TransformationContext, nodesVisitor = visitNodes, tokenVisitor?: Visitor, nodeVisitor: NodeVisitor = visitNode): T | undefined {
if (node === undefined) {

28
src/compiler/watch.ts
View File

@ -27,9 +27,10 @@ const sysFormatDiagnosticsHost: FormatDiagnosticsHost | undefined = sys ? {
getCanonicalFileName: createGetCanonicalFileName(sys.useCaseSensitiveFileNames)
} : undefined;
/** @internal */
/**
* Create a function that reports error by writing to the system and handles the formatting of the diagnostic
*
* @internal
*/
export function createDiagnosticReporter(system: System, pretty?: boolean): DiagnosticReporter {
const host: FormatDiagnosticsHost = system === sys && sysFormatDiagnosticsHost ? sysFormatDiagnosticsHost : {
@ -77,9 +78,10 @@ function getPlainDiagnosticFollowingNewLines(diagnostic: Diagnostic, newLine: st
: newLine;
}
/** @internal */
/**
* Get locale specific time based on whether we are in test mode
*
* @internal
*/
export function getLocaleTimeString(system: System) {
return !system.now ?
@ -87,9 +89,10 @@ export function getLocaleTimeString(system: System) {
system.now().toLocaleTimeString("en-US", { timeZone: "UTC" });
}
/** @internal */
/**
* Create a function that reports watch status by writing to the system and handles the formatting of the diagnostic
*
* @internal
*/
export function createWatchStatusReporter(system: System, pretty?: boolean): WatchStatusReporter {
return pretty ?
@ -113,8 +116,11 @@ export function createWatchStatusReporter(system: System, pretty?: boolean): Wat
};
}
/** @internal */
/** Parses config file using System interface */
/**
* Parses config file using System interface
*
* @internal
*/
export function parseConfigFileWithSystem(configFileName: string, optionsToExtend: CompilerOptions, extendedConfigCache: Map<ExtendedConfigCacheEntry> | undefined, watchOptionsToExtend: WatchOptions | undefined, system: System, reportDiagnostic: DiagnosticReporter) {
const host: ParseConfigFileHost = system as any;
host.onUnRecoverableConfigFileDiagnostic = diagnostic => reportUnrecoverableDiagnostic(system, reportDiagnostic, diagnostic);
@ -461,9 +467,10 @@ function toFileName(file: SourceFile | string, fileNameConvertor?: (fileName: st
return fileNameConvertor ? fileNameConvertor(fileName) : fileName;
}
/** @internal */
/**
* Helper that emit files, report diagnostics and lists emitted and/or source files depending on compiler options
*
* @internal
*/
export function emitFilesAndReportErrors<T extends BuilderProgram>(
program: Program | T,
@ -724,9 +731,10 @@ export function setGetSourceFileAsHashVersioned(compilerHost: CompilerHost, host
};
}
/** @internal */
/**
* Creates the watch compiler host that can be extended with config file or root file names and options host
*
* @internal
*/
export function createProgramHost<T extends BuilderProgram = EmitAndSemanticDiagnosticsBuilderProgram>(system: System, createProgram: CreateProgram<T> | undefined): ProgramHost<T> {
const getDefaultLibLocation = memoize(() => getDirectoryPath(normalizePath(system.getExecutingFilePath())));
@ -803,9 +811,10 @@ export interface CreateWatchCompilerHostOfConfigFileInput<T extends BuilderProgr
watchOptionsToExtend?: WatchOptions;
extraFileExtensions?: readonly FileExtensionInfo[];
}
/** @internal */
/**
* Creates the watch compiler host from system for config file in watch mode
*
* @internal
*/
export function createWatchCompilerHostOfConfigFile<T extends BuilderProgram = EmitAndSemanticDiagnosticsBuilderProgram>({
configFileName, optionsToExtend, watchOptionsToExtend, extraFileExtensions,
@ -828,9 +837,10 @@ export interface CreateWatchCompilerHostOfFilesAndCompilerOptionsInput<T extends
watchOptions: WatchOptions | undefined;
projectReferences?: readonly ProjectReference[];
}
/** @internal */
/**
* Creates the watch compiler host from system for compiling root files and options in watch mode
*
* @internal
*/
export function createWatchCompilerHostOfFilesAndCompilerOptions<T extends BuilderProgram = EmitAndSemanticDiagnosticsBuilderProgram>({
rootFiles, options, watchOptions, projectReferences,

20
src/compiler/watchPublic.ts
View File

@ -26,7 +26,7 @@ export interface ReadBuildProgramHost {
useCaseSensitiveFileNames(): boolean;
getCurrentDirectory(): string;
readFile(fileName: string): string | undefined;
/*@internal*/
/** @internal */
getBuildInfo?(fileName: string, configFilePath: string | undefined): BuildInfo | undefined;
}
export function readBuilderProgram(compilerOptions: CompilerOptions, host: ReadBuildProgramHost) {
@ -142,9 +142,11 @@ export interface ProgramHost<T extends BuilderProgram> {
*/
getModuleResolutionCache?(): ModuleResolutionCache | undefined;
}
/** Internal interface used to wire emit through same host */
/*@internal*/
/**
* Internal interface used to wire emit through same host
*
* @internal
*/
export interface ProgramHost<T extends BuilderProgram> {
// TODO: GH#18217 Optional methods are frequently asserted
createDirectory?(path: string): void;
@ -205,8 +207,9 @@ export interface WatchCompilerHostOfConfigFile<T extends BuilderProgram> extends
/**
* Host to create watch with config file that is already parsed (from tsc)
*
* @internal
*/
/*@internal*/
export interface WatchCompilerHostOfConfigFile<T extends BuilderProgram> extends WatchCompilerHost<T> {
configFileParsingResult?: ParsedCommandLine;
extendedConfigCache?: Map<ExtendedConfigCacheEntry>;
@ -215,8 +218,11 @@ export interface WatchCompilerHostOfConfigFile<T extends BuilderProgram> extends
export interface Watch<T> {
/** Synchronize with host and get updated program */
getProgram(): T;
/** Gets the existing program without synchronizing with changes on host */
/*@internal*/
/**
* Gets the existing program without synchronizing with changes on host
*
* @internal
*/
getCurrentProgram(): T;
/** Closes the watch */
close(): void;

23
src/compiler/watchUtilities.ts
View File

@ -11,9 +11,10 @@ import {
timestamp, WatchDirectoryFlags, WatchFileKind, WatchOptions,
} from "./_namespaces/ts";
/** @internal */
/**
* Partial interface of the System thats needed to support the caching of directory structure
*
* @internal
*/
export interface DirectoryStructureHost {
fileExists(path: string): boolean;
@ -332,9 +333,10 @@ export interface SharedExtendedConfigFileWatcher<T> extends FileWatcher {
projects: Set<T>;
}
/** @internal */
/**
* Updates the map of shared extended config file watches with a new set of extended config files from a base config file of the project
*
* @internal
*/
export function updateSharedExtendedConfigFileWatcher<T>(
projectPath: T,
@ -373,9 +375,10 @@ export function updateSharedExtendedConfigFileWatcher<T>(
});
}
/** @internal */
/**
* Remove the project from the extended config file watchers and close not needed watches
*
* @internal
*/
export function clearSharedExtendedConfigFileWatcher<T>(
projectPath: T,
@ -386,9 +389,10 @@ export function clearSharedExtendedConfigFileWatcher<T>(
});
}
/** @internal */
/**
* Clean the extendsConfigCache when extended config file has changed
*
* @internal
*/
export function cleanExtendedConfigCache(
extendedConfigCache: ESMap<string, ExtendedConfigCacheEntry>,
@ -403,9 +407,10 @@ export function cleanExtendedConfigCache(
});
}
/** @internal */
/**
* Updates watchers based on the package json files used in module resolution
*
* @internal
*/
export function updatePackageJsonWatch(
lookups: readonly (readonly [Path, object | boolean])[],
@ -423,9 +428,10 @@ export function updatePackageJsonWatch(
);
}
/** @internal */
/**
* Updates the existing missing file watches with the new set of missing files after new program is created
*
* @internal
*/
export function updateMissingFilePathsWatch(
program: Program,
@ -455,12 +461,13 @@ export interface WildcardDirectoryWatcher {
flags: WatchDirectoryFlags;
}
/** @internal */
/**
* Updates the existing wild card directory watches with the new set of wild card directories from the config file
* after new program is created because the config file was reloaded or program was created first time from the config file
* Note that there is no need to call this function when the program is updated with additional files without reloading config files,
* as wildcard directories wont change unless reloading config file
*
* @internal
*/
export function updateWatchingWildcardDirectories(
existingWatchedForWildcards: ESMap<string, WildcardDirectoryWatcher>,
@ -513,7 +520,7 @@ export interface IsIgnoredFileFromWildCardWatchingInput {
writeLog: (s: string) => void;
toPath: (fileName: string) => Path;
}
/* @internal */
/** @internal */
export function isIgnoredFileFromWildCardWatching({
watchedDirPath, fileOrDirectory, fileOrDirectoryPath,
configFileName, options, program, extraFileExtensions,

2
src/debug/dbg.ts
View File

@ -515,4 +515,4 @@ export function formatControlFlowGraph(flowNode: FlowNode) {
declare const module: { exports: {} };
if (typeof module !== "undefined" && module.exports) {
module.exports = Debug;
}
}

2
src/deprecatedCompat/deprecations.ts
View File

@ -106,4 +106,4 @@ export function buildOverload(name: string): OverloadBuilder {
})
})
};
}
}

8
src/harness/client.ts
View File

@ -29,7 +29,7 @@ interface RenameEntry {
readonly locations: RenameLocation[];
}
/* @internal */
/** @internal */
export function extractMessage(message: string): string {
// Read the content length
const contentLengthPrefix = "Content-Length: ";
@ -138,7 +138,7 @@ export class SessionClient implements LanguageService {
return response;
}
/*@internal*/
/** @internal */
configure(preferences: UserPreferences) {
this.preferences = preferences;
const args: protocol.ConfigureRequestArguments = { preferences };
@ -146,14 +146,14 @@ export class SessionClient implements LanguageService {
this.processResponse(request, /*expectEmptyBody*/ true);
}
/*@internal*/
/** @internal */
setFormattingOptions(formatOptions: FormatCodeSettings) {
const args: protocol.ConfigureRequestArguments = { formatOptions };
const request = this.processRequest(CommandNames.Configure, args);
this.processResponse(request, /*expectEmptyBody*/ true);
}
/*@internal*/
/** @internal */
setCompilerOptionsForInferredProjects(options: protocol.CompilerOptions) {
const args: protocol.SetCompilerOptionsForInferredProjectsArgs = { options };
const request = this.processRequest(CommandNames.CompilerOptionsForInferredProjects, args);

9
src/jsTyping/jsTyping.ts
View File

@ -100,9 +100,10 @@ export function nonRelativeModuleNameForTypingCache(moduleName: string) {
return nodeCoreModules.has(moduleName) ? "node" : moduleName;
}
/** @internal */
/**
* A map of loose file names to library names that we are confident require typings
*
* @internal
*/
export type SafeList = ReadonlyESMap<string, string>;
@ -121,7 +122,6 @@ export function loadTypesMap(host: TypingResolutionHost, typesMapPath: Path): Sa
return undefined;
}
/** @internal */
/**
* @param host is the object providing I/O related operations.
* @param fileNames are the file names that belong to the same project
@ -130,6 +130,8 @@ export function loadTypesMap(host: TypingResolutionHost, typesMapPath: Path): Sa
* @param packageNameToTypingLocation is the map of package names to their cached typing locations and installed versions
* @param typeAcquisition is used to customize the typing acquisition process
* @param compilerOptions are used as a source for typing inference
*
* @internal
*/
export function discoverTypings(
host: TypingResolutionHost,
@ -371,9 +373,10 @@ export interface ScopedPackageNameValidationResult {
/** @internal */
export type PackageNameValidationResult = NameValidationResult | ScopedPackageNameValidationResult;
/** @internal */
/**
* Validates package name using rules defined at https://docs.npmjs.com/files/package.json
*
* @internal
*/
export function validatePackageName(packageName: string): PackageNameValidationResult {
return validatePackageNameWorker(packageName, /*supportScopedPackage*/ true);

22
src/jsTyping/shared.ts
View File

@ -7,22 +7,22 @@ export type EventTypesRegistry = "event::typesRegistry";
export type EventBeginInstallTypes = "event::beginInstallTypes";
export type EventEndInstallTypes = "event::endInstallTypes";
export type EventInitializationFailed = "event::initializationFailed";
/* @internal */
/** @internal */
export const ActionSet: ActionSet = "action::set";
/* @internal */
/** @internal */
export const ActionInvalidate: ActionInvalidate = "action::invalidate";
/* @internal */
/** @internal */
export const ActionPackageInstalled: ActionPackageInstalled = "action::packageInstalled";
/* @internal */
/** @internal */
export const EventTypesRegistry: EventTypesRegistry = "event::typesRegistry";
/* @internal */
/** @internal */
export const EventBeginInstallTypes: EventBeginInstallTypes = "event::beginInstallTypes";
/* @internal */
/** @internal */
export const EventEndInstallTypes: EventEndInstallTypes = "event::endInstallTypes";
/* @internal */
/** @internal */
export const EventInitializationFailed: EventInitializationFailed = "event::initializationFailed";
/* @internal */
/** @internal */
export namespace Arguments {
export const GlobalCacheLocation = "--globalTypingsCacheLocation";
export const LogFile = "--logFile";
@ -41,12 +41,12 @@ export namespace Arguments {
export const ValidateDefaultNpmLocation = "--validateDefaultNpmLocation";
}
/* @internal */
/** @internal */
export function hasArgument(argumentName: string) {
return sys.args.indexOf(argumentName) >= 0;
}
/* @internal */
/** @internal */
export function findArgument(argumentName: string): string | undefined {
const index = sys.args.indexOf(argumentName);
return index >= 0 && index < sys.args.length - 1
@ -54,7 +54,7 @@ export function findArgument(argumentName: string): string | undefined {
: undefined;
}
/* @internal */
/** @internal */
export function nowString() {
// E.g. "12:34:56.789"
const d = new Date();

8
src/jsTyping/types.ts
View File

@ -15,7 +15,7 @@ export interface TypingInstallerRequestWithProjectName {
readonly projectName: string;
}
/* @internal */
/** @internal */
export type TypingInstallerRequestUnion = DiscoverTypings | CloseProject | TypesRegistryRequest | InstallPackageRequest;
export interface DiscoverTypings extends TypingInstallerRequestWithProjectName {
@ -44,7 +44,7 @@ export interface InstallPackageRequest extends TypingInstallerRequestWithProject
readonly projectRootPath: Path;
}
/* @internal */
/** @internal */
export interface TypesRegistryResponse extends TypingInstallerResponse {
readonly kind: EventTypesRegistry;
readonly typesRegistry: MapLike<MapLike<string>>;
@ -86,7 +86,7 @@ export interface EndInstallTypes extends InstallTypes {
readonly installSuccess: boolean;
}
/* @internal */
/** @internal */
export interface InstallTypingHost extends JsTyping.TypingResolutionHost {
useCaseSensitiveFileNames: boolean;
writeFile(path: string, content: string): void;
@ -104,5 +104,5 @@ export interface SetTypings extends ProjectResponse {
readonly kind: ActionSet;
}
/* @internal */
/** @internal */
export type TypingInstallerResponseUnion = SetTypings | InvalidateCachedTypings | TypesRegistryResponse | PackageInstalledResponse | InstallTypes | InitializationFailedResponse;

218
src/server/editorServices.ts
View File

@ -36,7 +36,7 @@ import {
} from "./_namespaces/ts";
export const maxProgramSizeForNonTsFiles = 20 * 1024 * 1024;
/*@internal*/
/** @internal */
export const maxFileSize = 4 * 1024 * 1024;
export const ProjectsUpdatedInBackgroundEvent = "projectsUpdatedInBackground";
@ -186,7 +186,7 @@ export type ProjectServiceEvent =
export type ProjectServiceEventHandler = (event: ProjectServiceEvent) => void;
/*@internal*/
/** @internal */
export type PerformanceEventHandler = (event: PerformanceEvent) => void;
export interface SafeList {
@ -330,7 +330,7 @@ export function convertScriptKindName(scriptKindName: protocol.ScriptKindName) {
}
}
/*@internal*/
/** @internal */
export function convertUserPreferences(preferences: protocol.UserPreferences): UserPreferences {
const { lazyConfiguredProjectsFromExternalProject, ...userPreferences } = preferences;
return userPreferences;
@ -396,7 +396,7 @@ function findProjectByName<T extends Project>(projectName: string, projects: T[]
const noopConfigFileWatcher: FileWatcher = { close: noop };
/*@internal*/
/** @internal */
interface ConfigFileExistenceInfo {
/**
* Cached value of existence of config file
@ -468,8 +468,11 @@ function isAncestorConfigFileInfo(infoOrFileNameOrConfig: OpenScriptInfoOrClosed
return !!(infoOrFileNameOrConfig as AncestorConfigFileInfo).configFileInfo;
}
/*@internal*/
/** Kind of operation to perform to get project reference project */
/**
* Kind of operation to perform to get project reference project
*
* @internal
*/
export enum ProjectReferenceProjectLoadKind {
/** Find existing project for project reference */
Find,
@ -479,14 +482,14 @@ export enum ProjectReferenceProjectLoadKind {
FindCreateLoad
}
/*@internal*/
/** @internal */
export function forEachResolvedProjectReferenceProject<T>(
project: ConfiguredProject,
fileName: string | undefined,
cb: (child: ConfiguredProject) => T | undefined,
projectReferenceProjectLoadKind: ProjectReferenceProjectLoadKind.Find | ProjectReferenceProjectLoadKind.FindCreate,
): T | undefined;
/*@internal*/
/** @internal */
export function forEachResolvedProjectReferenceProject<T>(
project: ConfiguredProject,
fileName: string | undefined,
@ -640,14 +643,17 @@ function isScriptInfoWatchedFromNodeModules(info: ScriptInfo) {
return !info.isScriptOpen() && info.mTime !== undefined;
}
/*@internal*/
/** true if script info is part of project and is not in project because it is referenced from project reference source */
/**
* true if script info is part of project and is not in project because it is referenced from project reference source
*
* @internal
*/
export function projectContainsInfoDirectly(project: Project, info: ScriptInfo) {
return project.containsScriptInfo(info) &&
!project.isSourceOfProjectReferenceRedirect(info.path);
}
/*@internal*/
/** @internal */
export function updateProjectIfDirty(project: Project) {
project.invalidateResolutionsOfFailedLookupLocations();
return project.dirty && project.updateGraph();
@ -659,7 +665,7 @@ function setProjectOptionsUsed(project: ConfiguredProject | ExternalProject) {
}
}
/*@internal*/
/** @internal */
export interface OpenFileArguments {
fileName: string;
content?: string;
@ -668,7 +674,7 @@ export interface OpenFileArguments {
projectRootPath?: string;
}
/*@internal*/
/** @internal */
export interface ChangeFileArguments {
fileName: string;
changes: Iterator<TextChange>;
@ -679,7 +685,7 @@ export interface WatchOptionsAndErrors {
errors: Diagnostic[] | undefined;
}
/*@internal*/
/** @internal */
export interface ParsedConfig{
cachedDirectoryStructureHost: CachedDirectoryStructureHost;
/**
@ -704,16 +710,16 @@ function createProjectNameFactoryWithCounter(nameFactory: (counter: number) => s
export class ProjectService {
/*@internal*/
/** @internal */
readonly typingsCache: TypingsCache;
/*@internal*/
/** @internal */
readonly documentRegistry: DocumentRegistry;
/**
* Container of all known scripts
*/
/*@internal*/
/** @internal */
readonly filenameToScriptInfo = new Map<string, ScriptInfo>();
private readonly nodeModulesWatchers = new Map<string, NodeModulesWatcher>();
/**
@ -728,7 +734,7 @@ export class ProjectService {
/**
* Map to the real path of the infos
*/
/* @internal */
/** @internal */
readonly realpathToScriptInfos: MultiMap<Path, ScriptInfo> | undefined;
/**
* maps external project file name to list of config files that were the part of this project
@ -747,17 +753,17 @@ export class ProjectService {
* projects specified by a tsconfig.json file
*/
readonly configuredProjects: Map<ConfiguredProject> = new Map<string, ConfiguredProject>();
/*@internal*/
/** @internal */
readonly newInferredProjectName = createProjectNameFactoryWithCounter(makeInferredProjectName);
/*@internal*/
/** @internal */
readonly newAutoImportProviderProjectName = createProjectNameFactoryWithCounter(makeAutoImportProviderProjectName);
/*@internal*/
/** @internal */
readonly newAuxiliaryProjectName = createProjectNameFactoryWithCounter(makeAuxiliaryProjectName);
/**
* Open files: with value being project root path, and key being Path of the file that is open
*/
readonly openFiles: Map<NormalizedPath | undefined> = new Map<Path, NormalizedPath | undefined>();
/* @internal */
/** @internal */
readonly configFileForOpenFiles: ESMap<Path, NormalizedPath | false> = new Map();
/**
* Map of open files that are opened without complete path but have projectRoot as current directory
@ -781,15 +787,15 @@ export class ProjectService {
* - Or it is present if we have configured project open with config file at that location
* In this case the exists property is always true
*/
/*@internal*/ readonly configFileExistenceInfoCache = new Map<NormalizedPath, ConfigFileExistenceInfo>();
/*@internal*/ readonly throttledOperations: ThrottledOperations;
/** @internal */ readonly configFileExistenceInfoCache = new Map<NormalizedPath, ConfigFileExistenceInfo>();
/** @internal */ readonly throttledOperations: ThrottledOperations;
private readonly hostConfiguration: HostConfiguration;
private safelist: SafeList = defaultTypeSafeList;
private readonly legacySafelist = new Map<string, string>();
private pendingProjectUpdates = new Map<string, Project>();
/* @internal */
/** @internal */
pendingEnsureProjectForOpenFiles = false;
readonly currentDirectory: NormalizedPath;
@ -820,21 +826,21 @@ export class ProjectService {
/** Tracks projects that we have already sent telemetry for. */
private readonly seenProjects = new Map<string, true>();
/*@internal*/
/** @internal */
readonly watchFactory: WatchFactory<WatchType, Project | NormalizedPath>;
/*@internal*/
/** @internal */
private readonly sharedExtendedConfigFileWatchers = new Map<Path, SharedExtendedConfigFileWatcher<NormalizedPath>>();
/*@internal*/
/** @internal */
private readonly extendedConfigCache = new Map<string, ExtendedConfigCacheEntry>();
/*@internal*/
/** @internal */
readonly packageJsonCache: PackageJsonCache;
/*@internal*/
/** @internal */
private packageJsonFilesMap: ESMap<Path, FileWatcher> | undefined;
/*@internal*/
/** @internal */
private incompleteCompletionsCache: IncompleteCompletionsCache | undefined;
/*@internal*/
/** @internal */
readonly session: Session<unknown> | undefined;
@ -917,39 +923,39 @@ export class ProjectService {
return toPath(fileName, this.currentDirectory, this.toCanonicalFileName);
}
/*@internal*/
/** @internal */
getExecutingFilePath() {
return this.getNormalizedAbsolutePath(this.host.getExecutingFilePath());
}
/*@internal*/
/** @internal */
getNormalizedAbsolutePath(fileName: string) {
return getNormalizedAbsolutePath(fileName, this.host.getCurrentDirectory());
}
/*@internal*/
/** @internal */
setDocument(key: DocumentRegistryBucketKeyWithMode, path: Path, sourceFile: SourceFile) {
const info = Debug.checkDefined(this.getScriptInfoForPath(path));
info.cacheSourceFile = { key, sourceFile };
}
/*@internal*/
/** @internal */
getDocument(key: DocumentRegistryBucketKeyWithMode, path: Path): SourceFile | undefined {
const info = this.getScriptInfoForPath(path);
return info && info.cacheSourceFile && info.cacheSourceFile.key === key ? info.cacheSourceFile.sourceFile : undefined;
}
/* @internal */
/** @internal */
ensureInferredProjectsUpToDate_TestOnly() {
this.ensureProjectStructuresUptoDate();
}
/* @internal */
/** @internal */
getCompilerOptionsForInferredProjects() {
return this.compilerOptionsForInferredProjects;
}
/* @internal */
/** @internal */
onUpdateLanguageServiceStateForProject(project: Project, languageServiceEnabled: boolean) {
if (!this.eventHandler) {
return;
@ -1008,7 +1014,7 @@ export class ProjectService {
}
}
/*@internal*/
/** @internal */
delayEnsureProjectForOpenFiles() {
if (!this.openFiles.size) return;
this.pendingEnsureProjectForOpenFiles = true;
@ -1041,12 +1047,12 @@ export class ProjectService {
}
}
/*@internal*/
/** @internal */
hasPendingProjectUpdate(project: Project) {
return this.pendingProjectUpdates.has(project.getProjectName());
}
/* @internal */
/** @internal */
sendProjectsUpdatedInBackgroundEvent() {
if (!this.eventHandler) {
return;
@ -1061,7 +1067,7 @@ export class ProjectService {
this.eventHandler(event);
}
/* @internal */
/** @internal */
sendLargeFileReferencedEvent(file: string, fileSize: number) {
if (!this.eventHandler) {
return;
@ -1074,7 +1080,7 @@ export class ProjectService {
this.eventHandler(event);
}
/* @internal */
/** @internal */
sendProjectLoadingStartEvent(project: ConfiguredProject, reason: string) {
if (!this.eventHandler) {
return;
@ -1087,7 +1093,7 @@ export class ProjectService {
this.eventHandler(event);
}
/* @internal */
/** @internal */
sendProjectLoadingFinishEvent(project: ConfiguredProject) {
if (!this.eventHandler || !project.sendLoadingProjectFinish) {
return;
@ -1101,14 +1107,14 @@ export class ProjectService {
this.eventHandler(event);
}
/* @internal */
/** @internal */
sendPerformanceEvent(kind: PerformanceEvent["kind"], durationMs: number) {
if (this.performanceEventHandler) {
this.performanceEventHandler({ kind, durationMs });
}
}
/* @internal */
/** @internal */
delayUpdateProjectGraphAndEnsureProjectStructureForOpenFiles(project: Project) {
this.delayUpdateProjectGraph(project);
this.delayEnsureProjectForOpenFiles();
@ -1182,14 +1188,14 @@ export class ProjectService {
return this.findExternalProjectByProjectName(projectName) || this.findConfiguredProjectByProjectName(toNormalizedPath(projectName));
}
/* @internal */
/** @internal */
private forEachProject(cb: (project: Project) => void) {
this.externalProjects.forEach(cb);
this.configuredProjects.forEach(cb);
this.inferredProjects.forEach(cb);
}
/* @internal */
/** @internal */
forEachEnabledProject(cb: (project: Project) => void) {
this.forEachProject(project => {
if (!project.isOrphan() && project.languageServiceEnabled) {
@ -1202,13 +1208,13 @@ export class ProjectService {
return ensureProject ? this.ensureDefaultProjectForFile(fileName) : this.tryGetDefaultProjectForFile(fileName);
}
/* @internal */
/** @internal */
tryGetDefaultProjectForFile(fileNameOrScriptInfo: NormalizedPath | ScriptInfo): Project | undefined {
const scriptInfo = isString(fileNameOrScriptInfo) ? this.getScriptInfoForNormalizedPath(fileNameOrScriptInfo) : fileNameOrScriptInfo;
return scriptInfo && !scriptInfo.isOrphan() ? scriptInfo.getDefaultProject() : undefined;
}
/* @internal */
/** @internal */
ensureDefaultProjectForFile(fileNameOrScriptInfo: NormalizedPath | ScriptInfo): Project {
return this.tryGetDefaultProjectForFile(fileNameOrScriptInfo) || this.doEnsureDefaultProjectForFile(fileNameOrScriptInfo);
}
@ -1339,7 +1345,7 @@ export class ProjectService {
/**
* This is to watch whenever files are added or removed to the wildcard directories
*/
/*@internal*/
/** @internal */
private watchWildcardDirectory(directory: Path, flags: WatchDirectoryFlags, configFileName: NormalizedPath, config: ParsedConfig) {
return this.watchFactory.watchDirectory(
directory,
@ -1405,7 +1411,7 @@ export class ProjectService {
);
}
/*@internal*/
/** @internal */
private delayUpdateProjectsFromParsedConfigOnConfigFileChange(canonicalConfigFilePath: NormalizedPath, reloadReason: string) {
const configFileExistenceInfo = this.configFileExistenceInfoCache.get(canonicalConfigFilePath);
if (!configFileExistenceInfo?.config) return false;
@ -1434,7 +1440,7 @@ export class ProjectService {
return scheduledAnyProjectUpdate;
}
/*@internal*/
/** @internal */
private onConfigFileChanged(canonicalConfigFilePath: NormalizedPath, eventKind: FileWatcherEventKind) {
const configFileExistenceInfo = this.configFileExistenceInfoCache.get(canonicalConfigFilePath)!;
if (eventKind === FileWatcherEventKind.Deleted) {
@ -1518,7 +1524,7 @@ export class ProjectService {
}
}
/*@internal*/
/** @internal */
assignOrphanScriptInfoToInferredProject(info: ScriptInfo, projectRootPath: NormalizedPath | undefined) {
Debug.assert(info.isOrphan());
@ -1704,7 +1710,7 @@ export class ProjectService {
return exists;
}
/*@internal*/
/** @internal */
private createConfigFileWatcherForParsedConfig(configFileName: NormalizedPath, canonicalConfigFilePath: NormalizedPath, forProject: ConfiguredProject) {
const configFileExistenceInfo = this.configFileExistenceInfoCache.get(canonicalConfigFilePath)!;
// When watching config file for parsed config, remove the noopFileWatcher that can be created for open files impacted by config file and watch for real
@ -1731,7 +1737,7 @@ export class ProjectService {
forEachEntry(configFileExistenceInfo.openFilesImpactedByConfigFile, identity);
}
/* @internal */
/** @internal */
releaseParsedConfig(canonicalConfigFilePath: NormalizedPath, forProject: ConfiguredProject) {
const configFileExistenceInfo = this.configFileExistenceInfoCache.get(canonicalConfigFilePath)!;
if (!configFileExistenceInfo.config?.projects.delete(forProject.canonicalConfigFilePath)) return;
@ -1769,7 +1775,7 @@ export class ProjectService {
* Close the config file watcher in the cached ConfigFileExistenceInfo
* if there arent any open files that are root of inferred project and there is no parsed config held by any project
*/
/*@internal*/
/** @internal */
private closeConfigFileWatcherOnReleaseOfOpenFile(configFileExistenceInfo: ConfigFileExistenceInfo) {
// Close the config file watcher if there are no more open files that are root of inferred project
// or if there are no projects that need to watch this config file existence info
@ -1817,7 +1823,7 @@ export class ProjectService {
/**
* This is called by inferred project whenever script info is added as a root
*/
/* @internal */
/** @internal */
startWatchingConfigFilesForInferredProjectRoot(info: ScriptInfo) {
Debug.assert(info.isScriptOpen());
this.forEachConfigFileLocation(info, (canonicalConfigFilePath, configFileName) => {
@ -1847,7 +1853,7 @@ export class ProjectService {
/**
* This is called by inferred project whenever root script info is removed from it
*/
/* @internal */
/** @internal */
stopWatchingConfigFilesForInferredProjectRoot(info: ScriptInfo) {
this.forEachConfigFileLocation(info, canonicalConfigFilePath => {
const configFileExistenceInfo = this.configFileExistenceInfoCache.get(canonicalConfigFilePath);
@ -1916,7 +1922,7 @@ export class ProjectService {
return undefined;
}
/*@internal*/
/** @internal */
findDefaultConfiguredProject(info: ScriptInfo) {
if (!info.isScriptOpen()) return undefined;
const configFileName = this.getConfigFileNameForFile(info);
@ -1980,7 +1986,7 @@ export class ProjectService {
this.logger.endGroup();
}
/*@internal*/
/** @internal */
findConfiguredProjectByProjectName(configFileName: NormalizedPath): ConfiguredProject | undefined {
// make sure that casing of config file name is consistent
const canonicalConfigFilePath = asNormalizedPath(this.toCanonicalFileName(configFileName));
@ -2051,7 +2057,7 @@ export class ProjectService {
return project;
}
/*@internal*/
/** @internal */
sendProjectTelemetry(project: ExternalProject | ConfiguredProject): void {
if (this.seenProjects.has(project.projectName)) {
setProjectOptionsUsed(project);
@ -2105,7 +2111,7 @@ export class ProjectService {
project.setTypeAcquisition(typeAcquisition);
}
/* @internal */
/** @internal */
createConfiguredProject(configFileName: NormalizedPath) {
tracing?.instant(tracing.Phase.Session, "createConfiguredProject", { configFilePath: configFileName });
this.logger.info(`Creating configuration project ${configFileName}`);
@ -2138,7 +2144,7 @@ export class ProjectService {
return project;
}
/* @internal */
/** @internal */
private createConfiguredProjectWithDelayLoad(configFileName: NormalizedPath, reason: string) {
const project = this.createConfiguredProject(configFileName);
project.pendingReload = ConfigFileProgramReloadLevel.Full;
@ -2146,14 +2152,14 @@ export class ProjectService {
return project;
}
/* @internal */
/** @internal */
createAndLoadConfiguredProject(configFileName: NormalizedPath, reason: string) {
const project = this.createConfiguredProject(configFileName);
this.loadConfiguredProject(project, reason);
return project;
}
/* @internal */
/** @internal */
private createLoadAndUpdateConfiguredProject(configFileName: NormalizedPath, reason: string) {
const project = this.createAndLoadConfiguredProject(configFileName, reason);
project.updateGraph();
@ -2163,7 +2169,7 @@ export class ProjectService {
/**
* Read the config file of the project, and update the project root file names.
*/
/* @internal */
/** @internal */
private loadConfiguredProject(project: ConfiguredProject, reason: string) {
tracing?.push(tracing.Phase.Session, "loadConfiguredProject", { configFilePath: project.canonicalConfigFilePath });
this.sendProjectLoadingStartEvent(project, reason);
@ -2210,7 +2216,7 @@ export class ProjectService {
tracing?.pop();
}
/*@internal*/
/** @internal */
ensureParsedConfigUptoDate(configFilename: NormalizedPath, canonicalConfigFilePath: NormalizedPath, configFileExistenceInfo: ConfigFileExistenceInfo, forProject: ConfiguredProject): ConfigFileExistenceInfo {
if (configFileExistenceInfo.config) {
if (!configFileExistenceInfo.config.reloadLevel) return configFileExistenceInfo;
@ -2302,7 +2308,7 @@ export class ProjectService {
return configFileExistenceInfo;
}
/*@internal*/
/** @internal */
watchWildcards(configFileName: NormalizedPath, { exists, config }: ConfigFileExistenceInfo, forProject: ConfiguredProject) {
config!.projects.set(forProject.canonicalConfigFilePath, true);
if (exists) {
@ -2323,7 +2329,7 @@ export class ProjectService {
}
}
/*@internal*/
/** @internal */
stopWatchingWildCards(canonicalConfigFilePath: NormalizedPath, forProject: ConfiguredProject) {
const configFileExistenceInfo = this.configFileExistenceInfoCache.get(canonicalConfigFilePath)!;
if (!configFileExistenceInfo.config ||
@ -2429,7 +2435,7 @@ export class ProjectService {
/**
* Reload the file names from config file specs and update the project graph
*/
/*@internal*/
/** @internal */
reloadFileNamesOfConfiguredProject(project: ConfiguredProject) {
const fileNames = this.reloadFileNamesOfParsedConfig(project.getConfigFilePath(), this.configFileExistenceInfoCache.get(project.canonicalConfigFilePath)!.config!);
project.updateErrorOnNoInputFiles(fileNames);
@ -2437,7 +2443,7 @@ export class ProjectService {
return project.updateGraph();
}
/*@internal*/
/** @internal */
private reloadFileNamesOfParsedConfig(configFileName: NormalizedPath, config: ParsedConfig) {
if (config.reloadLevel === undefined) return config.parsedCommandLine!.fileNames;
Debug.assert(config.reloadLevel === ConfigFileProgramReloadLevel.Partial);
@ -2453,7 +2459,7 @@ export class ProjectService {
return fileNames;
}
/*@internal*/
/** @internal */
setFileNamesOfAutoImportProviderProject(project: AutoImportProviderProject, fileNames: string[]) {
this.updateNonInferredProjectFiles(project, fileNames, fileNamePropertyReader);
}
@ -2461,7 +2467,7 @@ export class ProjectService {
/**
* Read the config file of the project again by clearing the cache and update the project graph
*/
/* @internal */
/** @internal */
reloadConfiguredProject(project: ConfiguredProject, reason: string, isInitialLoad: boolean, clearSemanticCache: boolean) {
// At this point, there is no reason to not have configFile in the host
const host = project.getCachedDirectoryStructureHost();
@ -2479,7 +2485,7 @@ export class ProjectService {
this.sendConfigFileDiagEvent(project, configFileName);
}
/* @internal */
/** @internal */
private clearSemanticCache(project: Project) {
project.resolutionCache.clear();
project.getLanguageService(/*ensureSynchronized*/ false).cleanupSemanticCache();
@ -2596,7 +2602,7 @@ export class ProjectService {
return project;
}
/*@internal*/
/** @internal */
getOrCreateScriptInfoNotOpenedByClient(uncheckedFileName: string, currentDirectory: string, hostToQueryFileExistsOn: DirectoryStructureHost) {
return this.getOrCreateScriptInfoNotOpenedByClientForNormalizedPath(
toNormalizedPath(uncheckedFileName), currentDirectory, /*scriptKind*/ undefined,
@ -2608,7 +2614,7 @@ export class ProjectService {
return this.getScriptInfoForNormalizedPath(toNormalizedPath(uncheckedFileName));
}
/* @internal */
/** @internal */
getScriptInfoOrConfig(uncheckedFileName: string): ScriptInfoOrConfig | undefined {
const path = toNormalizedPath(uncheckedFileName);
const info = this.getScriptInfoForNormalizedPath(path);
@ -2617,7 +2623,7 @@ export class ProjectService {
return configProject && configProject.getCompilerOptions().configFile;
}
/* @internal */
/** @internal */
logErrorForScriptInfoNotFound(fileName: string): void {
const names = arrayFrom(this.filenameToScriptInfo.entries()).map(([path, scriptInfo]) => ({ path, fileName: scriptInfo.fileName }));
this.logger.msg(`Could not find file ${JSON.stringify(fileName)}.\nAll files are: ${JSON.stringify(names)}`, Msg.Err);
@ -2627,7 +2633,7 @@ export class ProjectService {
* Returns the projects that contain script info through SymLink
* Note that this does not return projects in info.containingProjects
*/
/*@internal*/
/** @internal */
getSymlinkedProjects(info: ScriptInfo): MultiMap<Path, Project> | undefined {
let projects: MultiMap<Path, Project> | undefined;
if (this.realpathToScriptInfos) {
@ -2740,7 +2746,7 @@ export class ProjectService {
return result;
}
/*@internal*/
/** @internal */
watchPackageJsonsInNodeModules(dir: Path, project: Project): FileWatcher {
const watcher = this.nodeModulesWatchers.get(dir) || this.createNodeModulesWatcher(dir);
(watcher.affectedModuleSpecifierCacheProjects ||= new Set()).add(project.getProjectName());
@ -2868,7 +2874,7 @@ export class ProjectService {
return this.filenameToScriptInfo.get(fileName);
}
/*@internal*/
/** @internal */
getDocumentPositionMapper(project: Project, generatedFileName: string, sourceFileName?: string): DocumentPositionMapper | undefined {
// Since declaration info and map file watches arent updating project's directory structure host (which can cache file structure) use host
const declarationInfo = this.getOrCreateScriptInfoNotOpenedByClient(generatedFileName, project.currentDirectory, this.host);
@ -2977,7 +2983,7 @@ export class ProjectService {
return fileWatcher;
}
/*@internal*/
/** @internal */
getSourceFileLike(fileName: string, projectNameOrProject: string | Project, declarationInfo?: ScriptInfo) {
const project = (projectNameOrProject as Project).projectName ? projectNameOrProject as Project : this.findProject(projectNameOrProject as string);
if (project) {
@ -3018,7 +3024,7 @@ export class ProjectService {
return info.sourceFileLike;
}
/*@internal*/
/** @internal */
setPerformanceEventHandler(performanceEventHandler: PerformanceEventHandler) {
this.performanceEventHandler = performanceEventHandler;
}
@ -3076,12 +3082,12 @@ export class ProjectService {
}
}
/*@internal*/
/** @internal */
getWatchOptions(project: Project) {
return this.getWatchOptionsFromProjectWatchOptions(project.getWatchOptions());
}
/*@internal*/
/** @internal */
private getWatchOptionsFromProjectWatchOptions(projectOptions: WatchOptions | undefined) {
return projectOptions && this.hostConfiguration.watchOptions ?
{ ...this.hostConfiguration.watchOptions, ...projectOptions } :
@ -3271,7 +3277,7 @@ export class ProjectService {
return this.openClientFileWithNormalizedPath(toNormalizedPath(fileName), fileContent, scriptKind, /*hasMixedContent*/ false, projectRootPath ? toNormalizedPath(projectRootPath) : undefined);
}
/*@internal*/
/** @internal */
getOriginalLocationEnsuringConfiguredProject(project: Project, location: DocumentPosition): DocumentPosition | undefined {
const isSourceOfProjectReferenceRedirect = project.isSourceOfProjectReferenceRedirect(location.fileName);
const originalLocation = isSourceOfProjectReferenceRedirect ?
@ -3502,7 +3508,7 @@ export class ProjectService {
}
}
/*@internal*/
/** @internal */
loadAncestorProjectTree(forProjects?: ReadonlyCollection<string>) {
forProjects = forProjects || mapDefinedEntries(
this.configuredProjects,
@ -3701,7 +3707,7 @@ export class ProjectService {
* @param filename is absolute pathname
*/
closeClientFile(uncheckedFileName: string): void;
/*@internal*/
/** @internal */
closeClientFile(uncheckedFileName: string, skipAssignOrphanScriptInfosToInferredProject: true): boolean;
closeClientFile(uncheckedFileName: string, skipAssignOrphanScriptInfosToInferredProject?: true) {
const info = this.getScriptInfoForNormalizedPath(toNormalizedPath(uncheckedFileName));
@ -3724,7 +3730,7 @@ export class ProjectService {
}
}
/* @internal */
/** @internal */
synchronizeProjectList(knownProjects: protocol.ProjectVersionInfo[], includeProjectReferenceRedirectInfo?: boolean): ProjectFilesWithTSDiagnostics[] {
const files: ProjectFilesWithTSDiagnostics[] = [];
this.collectChanges(knownProjects, this.externalProjects, includeProjectReferenceRedirectInfo, files);
@ -3733,7 +3739,7 @@ export class ProjectService {
return files;
}
/* @internal */
/** @internal */
applyChangesInOpenFiles(openFiles: Iterator<OpenFileArguments> | undefined, changedFiles?: Iterator<ChangeFileArguments>, closedFiles?: string[]): void {
let openScriptInfos: ScriptInfo[] | undefined;
let assignOrphanScriptInfosToInferredProject = false;
@ -3796,7 +3802,7 @@ export class ProjectService {
}
}
/* @internal */
/** @internal */
applyChangesToFile(scriptInfo: ScriptInfo, changes: Iterator<TextChange>) {
while (true) {
const iterResult = changes.next();
@ -4104,7 +4110,7 @@ export class ProjectService {
return false;
}
/*@internal*/
/** @internal */
requestEnablePlugin(project: Project, pluginConfigEntry: PluginImport, searchPaths: string[], pluginConfigOverrides: Map<any> | undefined) {
if (!this.host.importPlugin && !this.host.require) {
this.logger.info("Plugins were requested but not running in environment that supports 'require'. Nothing will be loaded");
@ -4131,12 +4137,12 @@ export class ProjectService {
project.endEnablePlugin(project.beginEnablePluginSync(pluginConfigEntry, searchPaths, pluginConfigOverrides));
}
/* @internal */
/** @internal */
hasNewPluginEnablementRequests() {
return !!this.pendingPluginEnablements;
}
/* @internal */
/** @internal */
hasPendingPluginEnablements() {
return !!this.currentPluginEnablementPromise;
}
@ -4144,7 +4150,7 @@ export class ProjectService {
/**
* Waits for any ongoing plugin enablement requests to complete.
*/
/* @internal */
/** @internal */
async waitForPendingPlugins() {
while (this.currentPluginEnablementPromise) {
await this.currentPluginEnablementPromise;
@ -4154,7 +4160,7 @@ export class ProjectService {
/**
* Starts enabling any requested plugins without waiting for the result.
*/
/* @internal */
/** @internal */
enableRequestedPlugins() {
if (this.pendingPluginEnablements) {
void this.enableRequestedPluginsAsync();
@ -4222,7 +4228,7 @@ export class ProjectService {
this.currentPluginConfigOverrides.set(args.pluginName, args.configuration);
}
/*@internal*/
/** @internal */
getPackageJsonsVisibleToFile(fileName: string, rootDir?: string): readonly ProjectPackageJsonInfo[] {
const packageJsonCache = this.packageJsonCache;
const rootPath = rootDir && this.toPath(rootDir);
@ -4250,7 +4256,7 @@ export class ProjectService {
return result;
}
/*@internal*/
/** @internal */
getNearestAncestorDirectoryWithPackageJson(fileName: string): string | undefined {
return forEachAncestorDirectory(fileName, directory => {
switch (this.packageJsonCache.directoryHasPackageJson(this.toPath(directory))) {
@ -4264,7 +4270,7 @@ export class ProjectService {
});
}
/*@internal*/
/** @internal */
private watchPackageJsonFile(path: Path) {
const watchers = this.packageJsonFilesMap || (this.packageJsonFilesMap = new Map());
if (!watchers.has(path)) {
@ -4294,13 +4300,13 @@ export class ProjectService {
}
}
/*@internal*/
/** @internal */
private onAddPackageJson(path: Path) {
this.packageJsonCache.addOrUpdate(path);
this.watchPackageJsonFile(path);
}
/*@internal*/
/** @internal */
includePackageJsonAutoImports(): PackageJsonAutoImportPreference {
switch (this.hostConfiguration.preferences.includePackageJsonAutoImports) {
case "on": return PackageJsonAutoImportPreference.On;
@ -4309,7 +4315,7 @@ export class ProjectService {
}
}
/*@internal*/
/** @internal */
private invalidateProjectPackageJson(packageJsonPath: Path | undefined) {
this.configuredProjects.forEach(invalidate);
this.inferredProjects.forEach(invalidate);
@ -4324,7 +4330,7 @@ export class ProjectService {
}
}
/*@internal*/
/** @internal */
getIncompleteCompletionsCache() {
return this.incompleteCompletionsCache ||= createIncompleteCompletionsCache();
}
@ -4345,9 +4351,9 @@ function createIncompleteCompletionsCache(): IncompleteCompletionsCache {
};
}
/* @internal */
/** @internal */
export type ScriptInfoOrConfig = ScriptInfo | TsConfigSourceFile;
/* @internal */
/** @internal */
export function isConfigFile(config: ScriptInfoOrConfig): config is TsConfigSourceFile {
return (config as TsConfigSourceFile).kind !== undefined;
}

283
src/server/project.ts
View File

@ -39,10 +39,10 @@ export enum ProjectKind {
Auxiliary,
}
/* @internal */
/** @internal */
export type Mutable<T> = { -readonly [K in keyof T]: T[K]; };
/* @internal */
/** @internal */
export function countEachFileTypes(infos: ScriptInfo[], includeSizes = false): FileStats {
const result: Mutable<FileStats> = {
js: 0, jsSize: 0,
@ -101,12 +101,12 @@ export function allFilesAreJsOrDts(project: Project): boolean {
return counts.ts === 0 && counts.tsx === 0;
}
/* @internal */
/** @internal */
export function hasNoTypeScriptSource(fileNames: string[]): boolean {
return !fileNames.some(fileName => (fileExtensionIs(fileName, Extension.Ts) && !isDeclarationFileName(fileName)) || fileExtensionIs(fileName, Extension.Tsx));
}
/* @internal */
/** @internal */
export interface ProjectFilesWithTSDiagnostics extends protocol.ProjectFiles {
projectErrors: readonly Diagnostic[];
}
@ -133,7 +133,7 @@ export interface PluginModuleWithName {
export type PluginModuleFactory = (mod: { typescript: typeof ts }) => PluginModule;
/* @internal */
/** @internal */
export interface BeginEnablePluginResult {
pluginConfigEntry: PluginImport;
pluginConfigOverrides: Map<any> | undefined;
@ -144,8 +144,9 @@ export interface BeginEnablePluginResult {
/**
* The project root can be script info - if root is present,
* or it could be just normalized path if root wasn't present on the host(only for non inferred project)
*
* @internal
*/
/* @internal */
export interface ProjectRootFile {
fileName: NormalizedPath;
info?: ScriptInfo;
@ -160,7 +161,7 @@ function isGeneratedFileWatcher(watch: GeneratedFileWatcherMap): watch is Genera
return (watch as GeneratedFileWatcher).generatedFilePath !== undefined;
}
/*@internal*/
/** @internal */
export interface EmitResult {
emitSkipped: boolean;
diagnostics: readonly Diagnostic[];
@ -177,7 +178,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
/*@internal*/
protected readonly plugins: PluginModuleWithName[] = [];
/*@internal*/
/** @internal */
/**
* This is map from files to unresolved imports in it
* Maop does not contain entries for files that do not have unresolved imports
@ -185,14 +186,14 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
*/
cachedUnresolvedImportsPerFile = new Map<Path, readonly string[]>();
/*@internal*/
/** @internal */
lastCachedUnresolvedImportsList: SortedReadonlyArray<string> | undefined;
/*@internal*/
/** @internal */
private hasAddedorRemovedFiles = false;
/*@internal*/
/** @internal */
private hasAddedOrRemovedSymlinks = false;
/*@internal*/
/** @internal */
lastFileExceededProgramSize: string | undefined;
// wrapper over the real language service that will suppress all semantic operations
@ -203,10 +204,10 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
readonly trace?: (s: string) => void;
readonly realpath?: (path: string) => string;
/*@internal*/
/** @internal */
hasInvalidatedResolutions: HasInvalidatedResolutions | undefined;
/*@internal*/
/** @internal */
resolutionCache: ResolutionCache;
private builderState: BuilderState | undefined;
@ -239,28 +240,28 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
protected isInitialLoadPending: () => boolean = returnFalse;
/*@internal*/
/** @internal */
dirty = false;
/*@internal*/
/** @internal */
typingFiles: SortedReadonlyArray<string> = emptyArray;
/*@internal*/
/** @internal */
originalConfiguredProjects: Set<NormalizedPath> | undefined;
/*@internal*/
/** @internal */
private packageJsonsForAutoImport: Set<string> | undefined;
/*@internal*/
/** @internal */
private noDtsResolutionProject?: AuxiliaryProject | undefined;
/*@internal*/
/** @internal */
getResolvedProjectReferenceToRedirect(_fileName: string): ResolvedProjectReference | undefined {
return undefined;
}
/* @internal */ useSourceOfProjectReferenceRedirect?(): boolean;
/* @internal */ getParsedCommandLine?(fileName: string): ParsedCommandLine | undefined;
/** @internal */ useSourceOfProjectReferenceRedirect?(): boolean;
/** @internal */ getParsedCommandLine?(fileName: string): ParsedCommandLine | undefined;
private readonly cancellationToken: ThrottledCancellationToken;
@ -286,7 +287,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return result.module;
}
/*@internal*/
/** @internal */
public static async importServicePluginAsync(moduleName: string, initialDir: string, host: ServerHost, log: (message: string) => void, logErrors?: (message: string) => void): Promise<{} | undefined> {
Debug.assertIsDefined(host.importPlugin);
const resolvedPath = combinePaths(initialDir, "node_modules");
@ -306,31 +307,34 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return result.module;
}
/*@internal*/
/** @internal */
readonly currentDirectory: string;
/*@internal*/
/** @internal */
readonly projectName: string;
/** @internal */
public directoryStructureHost: DirectoryStructureHost;
/*@internal*/
/** @internal */
public readonly getCanonicalFileName: GetCanonicalFileName;
/*@internal*/
/** @internal */
private exportMapCache: ExportInfoMap | undefined;
/*@internal*/
/** @internal */
private changedFilesForExportMapCache: Set<Path> | undefined;
/*@internal*/
/** @internal */
private moduleSpecifierCache = createModuleSpecifierCache(this);
/*@internal*/
/** @internal */
private symlinks: SymlinkCache | undefined;
/*@internal*/
/** @internal */
autoImportProviderHost: AutoImportProviderProject | false | undefined;
/*@internal*/
/** @internal */
protected typeAcquisition: TypeAcquisition | undefined;
/*@internal*/
/** @internal */
constructor(
/*@internal*/ readonly projectName: string,
projectName: string,
readonly projectKind: ProjectKind,
readonly projectService: ProjectService,
private documentRegistry: DocumentRegistry,
@ -342,6 +346,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
directoryStructureHost: DirectoryStructureHost,
currentDirectory: string | undefined,
) {
this.projectName = projectName;
this.directoryStructureHost = directoryStructureHost;
this.currentDirectory = this.projectService.getNormalizedAbsolutePath(currentDirectory || "");
this.getCanonicalFileName = this.projectService.toCanonicalFileName;
@ -408,7 +413,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return this.typingsCache.installPackage({ ...options, projectName: this.projectName, projectRootPath: this.toPath(this.currentDirectory) });
}
/*@internal*/
/** @internal */
getGlobalTypingsCacheLocation() {
return this.getGlobalCache();
}
@ -417,7 +422,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return this.projectService.typingsCache;
}
/*@internal*/
/** @internal */
getSymlinkCache(): SymlinkCache {
if (!this.symlinks) {
this.symlinks = createSymlinkCache(this.getCurrentDirectory(), this.getCanonicalFileName);
@ -561,17 +566,17 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return this.directoryStructureHost.getDirectories!(path); // TODO: GH#18217
}
/*@internal*/
/** @internal */
getCachedDirectoryStructureHost(): CachedDirectoryStructureHost {
return undefined!; // TODO: GH#18217
}
/*@internal*/
/** @internal */
toPath(fileName: string) {
return toPath(fileName, this.currentDirectory, this.projectService.toCanonicalFileName);
}
/*@internal*/
/** @internal */
watchDirectoryOfFailedLookupLocation(directory: string, cb: DirectoryWatcherCallback, flags: WatchDirectoryFlags) {
return this.projectService.watchFactory.watchDirectory(
directory,
@ -583,7 +588,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
);
}
/*@internal*/
/** @internal */
watchAffectingFileLocation(file: string, cb: FileWatcherCallback) {
return this.projectService.watchFactory.watchFile(
file,
@ -595,12 +600,12 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
);
}
/*@internal*/
/** @internal */
clearInvalidateResolutionOfFailedLookupTimer() {
return this.projectService.throttledOperations.cancel(`${this.getProjectName()}FailedLookupInvalidation`);
}
/*@internal*/
/** @internal */
scheduleInvalidateResolutionsOfFailedLookupLocations() {
this.projectService.throttledOperations.schedule(`${this.getProjectName()}FailedLookupInvalidation`, /*delay*/ 1000, () => {
if (this.resolutionCache.invalidateResolutionsOfFailedLookupLocations()) {
@ -609,7 +614,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
});
}
/*@internal*/
/** @internal */
invalidateResolutionsOfFailedLookupLocations() {
if (this.clearInvalidateResolutionOfFailedLookupTimer() &&
this.resolutionCache.invalidateResolutionsOfFailedLookupLocations()) {
@ -618,12 +623,12 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
}
}
/*@internal*/
/** @internal */
onInvalidatedResolution() {
this.projectService.delayUpdateProjectGraphAndEnsureProjectStructureForOpenFiles(this);
}
/*@internal*/
/** @internal */
watchTypeRootsDirectory(directory: string, cb: DirectoryWatcherCallback, flags: WatchDirectoryFlags) {
return this.projectService.watchFactory.watchDirectory(
directory,
@ -635,30 +640,30 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
);
}
/*@internal*/
/** @internal */
hasChangedAutomaticTypeDirectiveNames() {
return this.resolutionCache.hasChangedAutomaticTypeDirectiveNames();
}
/*@internal*/
/** @internal */
onChangedAutomaticTypeDirectiveNames() {
this.projectService.delayUpdateProjectGraphAndEnsureProjectStructureForOpenFiles(this);
}
/*@internal*/
/** @internal */
getGlobalCache() {
return this.getTypeAcquisition().enable ? this.projectService.typingsInstaller.globalTypingsCacheLocation : undefined;
}
/*@internal*/
/** @internal */
globalCacheResolutionModuleName = JsTyping.nonRelativeModuleNameForTypingCache;
/*@internal*/
/** @internal */
fileIsOpen(filePath: Path) {
return this.projectService.openFiles.has(filePath);
}
/*@internal*/
/** @internal */
writeLog(s: string) {
this.projectService.logger.info(s);
}
@ -712,17 +717,17 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
this.languageService.clearSourceMapperCache();
}
/*@internal*/
/** @internal */
getDocumentPositionMapper(generatedFileName: string, sourceFileName?: string): DocumentPositionMapper | undefined {
return this.projectService.getDocumentPositionMapper(this, generatedFileName, sourceFileName);
}
/*@internal*/
/** @internal */
getSourceFileLike(fileName: string) {
return this.projectService.getSourceFileLike(fileName, this);
}
/*@internal*/
/** @internal */
shouldEmitFile(scriptInfo: ScriptInfo | undefined) {
return scriptInfo &&
!scriptInfo.isDynamicOrHasMixedContent() &&
@ -839,7 +844,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return this.program.getSourceFileByPath(path);
}
/* @internal */
/** @internal */
getSourceFileOrConfigFile(path: Path): SourceFile | undefined {
const options = this.program!.getCompilerOptions();
return path === options.configFilePath ? options.configFile : this.getSourceFile(path);
@ -917,7 +922,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return this.rootFiles && this.rootFiles.length > 0;
}
/*@internal*/
/** @internal */
isOrphan() {
return false;
}
@ -926,7 +931,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return this.rootFiles && this.rootFiles.map(info => info.fileName);
}
/*@internal*/
/** @internal */
getRootFilesMap() {
return this.rootFilesMap;
}
@ -988,7 +993,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return result;
}
/* @internal */
/** @internal */
getFileNamesWithRedirectInfo(includeProjectReferenceRedirectInfo: boolean) {
return this.getFileNames().map((fileName): protocol.FileWithProjectReferenceRedirectInfo => ({
fileName,
@ -1075,7 +1080,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
(this.updatedFileNames || (this.updatedFileNames = new Set<string>())).add(fileName);
}
/*@internal*/
/** @internal */
markFileAsDirty(changedFile: Path) {
this.markAsDirty();
if (this.exportMapCache && !this.exportMapCache.isEmpty()) {
@ -1090,7 +1095,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
}
}
/*@internal*/
/** @internal */
onAutoImportProviderSettingsChanged() {
if (this.autoImportProviderHost === false) {
this.autoImportProviderHost = undefined;
@ -1100,7 +1105,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
}
}
/*@internal*/
/** @internal */
onPackageJsonChange(packageJsonPath: Path) {
if (this.packageJsonsForAutoImport?.has(packageJsonPath)) {
this.moduleSpecifierCache.clear();
@ -1110,7 +1115,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
}
}
/* @internal */
/** @internal */
onFileAddedOrRemoved(isSymlink: boolean | undefined) {
this.hasAddedorRemovedFiles = true;
if (isSymlink) {
@ -1118,7 +1123,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
}
}
/* @internal */
/** @internal */
onDiscoveredSymlink() {
this.hasAddedOrRemovedSymlinks = true;
}
@ -1180,7 +1185,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return !hasNewProgram;
}
/*@internal*/
/** @internal */
updateTypingFiles(typingFiles: SortedReadonlyArray<string>) {
if (enumerateInsertsAndDeletes<string, string>(typingFiles, this.typingFiles, getStringComparer(!this.useCaseSensitiveFileNames()),
/*inserted*/ noop,
@ -1194,7 +1199,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
}
}
/* @internal */
/** @internal */
getCurrentProgram(): Program | undefined {
return this.program;
}
@ -1340,7 +1345,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return hasNewProgram;
}
/* @internal */
/** @internal */
sendPerformanceEvent(kind: PerformanceEvent["kind"], durationMs: number) {
this.projectService.sendPerformanceEvent(kind, durationMs);
}
@ -1388,7 +1393,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return !!this.missingFilesMap && this.missingFilesMap.has(path);
}
/* @internal */
/** @internal */
addGeneratedFileWatch(generatedFile: string, sourceFile: string) {
if (outFile(this.compilerOptions)) {
// Single watcher
@ -1473,7 +1478,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return strBuilder;
}
/*@internal*/
/** @internal */
print(writeProjectFileNames: boolean) {
this.writeLog(`Project '${this.projectName}' (${ProjectKind[this.projectKind]})`);
this.writeLog(this.filesToString(writeProjectFileNames && this.projectService.logger.hasLevel(LogLevel.verbose)));
@ -1501,12 +1506,12 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
}
}
/*@internal*/
/** @internal */
setWatchOptions(watchOptions: WatchOptions | undefined) {
this.watchOptions = watchOptions;
}
/*@internal*/
/** @internal */
getWatchOptions(): WatchOptions | undefined {
return this.watchOptions;
}
@ -1521,7 +1526,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return this.typeAcquisition || {};
}
/* @internal */
/** @internal */
getChangesSinceVersion(lastKnownVersion?: number, includeProjectReferenceRedirectInfo?: boolean): ProjectFilesWithTSDiagnostics {
const includeProjectReferenceRedirectInfoIfRequested =
includeProjectReferenceRedirectInfo
@ -1632,7 +1637,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
this.rootFilesMap.delete(info.path);
}
/*@internal*/
/** @internal */
isSourceOfProjectReferenceRedirect(fileName: string) {
return !!this.program && this.program.isSourceOfProjectReferenceRedirect(fileName);
}
@ -1675,7 +1680,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
/**
* Performs the initial steps of enabling a plugin by finding and instantiating the module for a plugin synchronously using 'require'.
*/
/*@internal*/
/** @internal */
beginEnablePluginSync(pluginConfigEntry: PluginImport, searchPaths: string[], pluginConfigOverrides: Map<any> | undefined): BeginEnablePluginResult {
Debug.assertIsDefined(this.projectService.host.require);
@ -1692,7 +1697,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
/**
* Performs the initial steps of enabling a plugin by finding and instantiating the module for a plugin asynchronously using dynamic `import`.
*/
/*@internal*/
/** @internal */
async beginEnablePluginAsync(pluginConfigEntry: PluginImport, searchPaths: string[], pluginConfigOverrides: Map<any> | undefined): Promise<BeginEnablePluginResult> {
Debug.assertIsDefined(this.projectService.host.importPlugin);
@ -1715,7 +1720,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
/**
* Performs the remaining steps of enabling a plugin after its module has been instantiated.
*/
/*@internal*/
/** @internal */
endEnablePlugin({ pluginConfigEntry, pluginConfigOverrides, resolvedModule, errorLogs }: BeginEnablePluginResult) {
if (resolvedModule) {
const configurationOverride = pluginConfigOverrides && pluginConfigOverrides.get(pluginConfigEntry.name);
@ -1772,7 +1777,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
}
}
/*@internal*/
/** @internal */
onPluginConfigurationChanged(pluginName: string, configuration: any) {
this.plugins.filter(plugin => plugin.name === pluginName).forEach(plugin => {
if (plugin.module.onConfigurationChanged) {
@ -1786,45 +1791,45 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
this.projectService.sendProjectsUpdatedInBackgroundEvent();
}
/*@internal*/
/** @internal */
getPackageJsonsVisibleToFile(fileName: string, rootDir?: string): readonly ProjectPackageJsonInfo[] {
if (this.projectService.serverMode !== LanguageServiceMode.Semantic) return emptyArray;
return this.projectService.getPackageJsonsVisibleToFile(fileName, rootDir);
}
/*@internal*/
/** @internal */
getNearestAncestorDirectoryWithPackageJson(fileName: string): string | undefined {
return this.projectService.getNearestAncestorDirectoryWithPackageJson(fileName);
}
/*@internal*/
/** @internal */
getPackageJsonsForAutoImport(rootDir?: string): readonly ProjectPackageJsonInfo[] {
const packageJsons = this.getPackageJsonsVisibleToFile(combinePaths(this.currentDirectory, inferredTypesContainingFile), rootDir);
this.packageJsonsForAutoImport = new Set(packageJsons.map(p => p.fileName));
return packageJsons;
}
/* @internal */
/** @internal */
getPackageJsonCache() {
return this.projectService.packageJsonCache;
}
/*@internal*/
/** @internal */
getCachedExportInfoMap() {
return this.exportMapCache ||= createCacheableExportInfoMap(this);
}
/*@internal*/
/** @internal */
clearCachedExportInfoMap() {
this.exportMapCache?.clear();
}
/*@internal*/
/** @internal */
getModuleSpecifierCache() {
return this.moduleSpecifierCache;
}
/*@internal*/
/** @internal */
includePackageJsonAutoImports(): PackageJsonAutoImportPreference {
if (this.projectService.includePackageJsonAutoImports() === PackageJsonAutoImportPreference.Off ||
!this.languageServiceEnabled ||
@ -1835,7 +1840,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return this.projectService.includePackageJsonAutoImports();
}
/*@internal*/
/** @internal */
getModuleResolutionHostForAutoImportProvider(): ModuleResolutionHost {
if (this.program) {
return {
@ -1852,7 +1857,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return this.projectService.host;
}
/*@internal*/
/** @internal */
getPackageJsonAutoImportProvider(): Program | undefined {
if (this.autoImportProviderHost === false) {
return undefined;
@ -1886,24 +1891,24 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
}
}
/*@internal*/
/** @internal */
private isDefaultProjectForOpenFiles(): boolean {
return !!forEachEntry(
this.projectService.openFiles,
(_, fileName) => this.projectService.tryGetDefaultProjectForFile(toNormalizedPath(fileName)) === this);
}
/*@internal*/
/** @internal */
watchNodeModulesForPackageJsonChanges(directoryPath: string) {
return this.projectService.watchPackageJsonsInNodeModules(this.toPath(directoryPath), this);
}
/*@internal*/
/** @internal */
getIncompleteCompletionsCache() {
return this.projectService.getIncompleteCompletionsCache();
}
/*@internal*/
/** @internal */
getNoDtsResolutionProject(rootFileNames: readonly string[]): Project {
Debug.assert(this.projectService.serverMode === LanguageServiceMode.Semantic);
if (!this.noDtsResolutionProject) {
@ -1935,7 +1940,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
return this.noDtsResolutionProject;
}
/*@internal*/
/** @internal */
private getCompilerOptionsForNoDtsResolutionProject() {
return {
...this.getCompilerOptions(),
@ -2010,11 +2015,11 @@ export class InferredProject extends Project {
/** this is canonical project root path */
readonly projectRootPath: string | undefined;
/*@internal*/
/** @internal */
/** stored only if their is no projectRootPath and this isnt single inferred project */
readonly canonicalCurrentDirectory: string | undefined;
/*@internal*/
/** @internal */
constructor(
projectService: ProjectService,
documentRegistry: DocumentRegistry,
@ -2063,7 +2068,7 @@ export class InferredProject extends Project {
}
}
/*@internal*/
/** @internal */
isOrphan() {
return !this.hasRoots();
}
@ -2109,7 +2114,7 @@ class AuxiliaryProject extends Project {
return true;
}
/*@internal*/
/** @internal */
scheduleInvalidateResolutionsOfFailedLookupLocations(): void {
// Invalidation will happen on-demand as part of updateGraph
return;
@ -2117,10 +2122,10 @@ class AuxiliaryProject extends Project {
}
export class AutoImportProviderProject extends Project {
/*@internal*/
/** @internal */
private static readonly maxDependencies = 10;
/*@internal*/
/** @internal */
static getRootFileNames(dependencySelection: PackageJsonAutoImportPreference, hostProject: Project, moduleResolutionHost: ModuleResolutionHost, compilerOptions: CompilerOptions): string[] {
if (!dependencySelection) {
return ts.emptyArray;
@ -2240,7 +2245,7 @@ export class AutoImportProviderProject extends Project {
}
}
/*@internal*/
/** @internal */
static readonly compilerOptionsOverrides: CompilerOptions = {
diagnostics: false,
skipLibCheck: true,
@ -2250,7 +2255,7 @@ export class AutoImportProviderProject extends Project {
noLib: true,
};
/*@internal*/
/** @internal */
static create(dependencySelection: PackageJsonAutoImportPreference, hostProject: Project, moduleResolutionHost: ModuleResolutionHost, documentRegistry: DocumentRegistry): AutoImportProviderProject | undefined {
if (dependencySelection === PackageJsonAutoImportPreference.Off) {
return undefined;
@ -2271,7 +2276,7 @@ export class AutoImportProviderProject extends Project {
private rootFileNames: string[] | undefined;
/*@internal*/
/** @internal */
constructor(
private hostProject: Project,
initialRootNames: string[],
@ -2295,7 +2300,7 @@ export class AutoImportProviderProject extends Project {
this.getParsedCommandLine = maybeBind(this.hostProject, this.hostProject.getParsedCommandLine);
}
/*@internal*/
/** @internal */
isEmpty() {
return !some(this.rootFileNames);
}
@ -2324,7 +2329,7 @@ export class AutoImportProviderProject extends Project {
return hasSameSetOfFiles;
}
/*@internal*/
/** @internal */
scheduleInvalidateResolutionsOfFailedLookupLocations(): void {
// Invalidation will happen on-demand as part of updateGraph
return;
@ -2347,12 +2352,12 @@ export class AutoImportProviderProject extends Project {
throw new Error("AutoImportProviderProject language service should never be used. To get the program, use `project.getCurrentProgram()`.");
}
/*@internal*/
/** @internal */
onAutoImportProviderSettingsChanged(): never {
throw new Error("AutoImportProviderProject is an auto import provider; use `markAsDirty()` instead.");
}
/*@internal*/
/** @internal */
onPackageJsonChange(): never {
throw new Error("package.json changes should be notified on an AutoImportProvider's host project");
}
@ -2365,7 +2370,7 @@ export class AutoImportProviderProject extends Project {
return this.hostProject.getProjectReferences();
}
/*@internal*/
/** @internal */
includePackageJsonAutoImports() {
return PackageJsonAutoImportPreference.Off;
}
@ -2374,12 +2379,12 @@ export class AutoImportProviderProject extends Project {
return { enable: false };
}
/*@internal*/
/** @internal */
getSymlinkCache() {
return this.hostProject.getSymlinkCache();
}
/*@internal*/
/** @internal */
getModuleResolutionCache() {
return this.hostProject.getCurrentProgram()?.getModuleResolutionCache();
}
@ -2391,15 +2396,15 @@ export class AutoImportProviderProject extends Project {
* Otherwise it will create an InferredProject.
*/
export class ConfiguredProject extends Project {
/* @internal */
/** @internal */
pendingReload: ConfigFileProgramReloadLevel | undefined;
/* @internal */
/** @internal */
pendingReloadReason: string | undefined;
/* @internal */
/** @internal */
openFileWatchTriggered = new Map<string, ConfigFileProgramReloadLevel>();
/*@internal*/
/** @internal */
canConfigFileJsonReportNoInputFiles = false;
/** Ref count to the project when opened from external project */
@ -2408,22 +2413,22 @@ export class ConfiguredProject extends Project {
private projectReferences: readonly ProjectReference[] | undefined;
/** Potential project references before the project is actually loaded (read config file) */
/*@internal*/
/** @internal */
potentialProjectReferences: Set<string> | undefined;
/*@internal*/
/** @internal */
projectOptions?: ProjectOptions | true;
/*@internal*/
/** @internal */
isInitialLoadPending: () => boolean = returnTrue;
/*@internal*/
/** @internal */
sendLoadingProjectFinish = false;
/*@internal*/
/** @internal */
private compilerHost?: CompilerHost;
/*@internal*/
/** @internal */
constructor(configFileName: NormalizedPath,
readonly canonicalConfigFilePath: NormalizedPath,
projectService: ProjectService,
@ -2443,22 +2448,22 @@ export class ConfiguredProject extends Project {
);
}
/* @internal */
/** @internal */
setCompilerHost(host: CompilerHost) {
this.compilerHost = host;
}
/* @internal */
/** @internal */
getCompilerHost(): CompilerHost | undefined {
return this.compilerHost;
}
/* @internal */
/** @internal */
useSourceOfProjectReferenceRedirect() {
return this.languageServiceEnabled;
}
/* @internal */
/** @internal */
getParsedCommandLine(fileName: string) {
const configFileName = asNormalizedPath(normalizePath(fileName));
const canonicalConfigFilePath = asNormalizedPath(this.projectService.toCanonicalFileName(configFileName));
@ -2476,12 +2481,12 @@ export class ConfiguredProject extends Project {
return configFileExistenceInfo.exists ? configFileExistenceInfo.config!.parsedCommandLine : undefined;
}
/* @internal */
/** @internal */
onReleaseParsedCommandLine(fileName: string) {
this.releaseParsedConfig(asNormalizedPath(this.projectService.toCanonicalFileName(asNormalizedPath(normalizePath(fileName)))));
}
/* @internal */
/** @internal */
private releaseParsedConfig(canonicalConfigFilePath: NormalizedPath) {
this.projectService.stopWatchingWildCards(canonicalConfigFilePath, this);
this.projectService.releaseParsedConfig(canonicalConfigFilePath, this);
@ -2518,7 +2523,7 @@ export class ConfiguredProject extends Project {
return result;
}
/*@internal*/
/** @internal */
getCachedDirectoryStructureHost() {
return this.directoryStructureHost as CachedDirectoryStructureHost;
}
@ -2536,26 +2541,26 @@ export class ConfiguredProject extends Project {
this.potentialProjectReferences = undefined;
}
/*@internal*/
/** @internal */
setPotentialProjectReference(canonicalConfigPath: NormalizedPath) {
Debug.assert(this.isInitialLoadPending());
(this.potentialProjectReferences || (this.potentialProjectReferences = new Set())).add(canonicalConfigPath);
}
/*@internal*/
/** @internal */
getResolvedProjectReferenceToRedirect(fileName: string): ResolvedProjectReference | undefined {
const program = this.getCurrentProgram();
return program && program.getResolvedProjectReferenceToRedirect(fileName);
}
/*@internal*/
/** @internal */
forEachResolvedProjectReference<T>(
cb: (resolvedProjectReference: ResolvedProjectReference) => T | undefined
): T | undefined {
return this.getCurrentProgram()?.forEachResolvedProjectReference(cb);
}
/*@internal*/
/** @internal */
enablePluginsWithOptions(options: CompilerOptions, pluginConfigOverrides: ESMap<string, any> | undefined): void {
this.plugins.length = 0;
if (!options.plugins?.length && !this.projectService.globalPlugins.length) return;
@ -2609,23 +2614,23 @@ export class ConfiguredProject extends Project {
super.close();
}
/* @internal */
/** @internal */
addExternalProjectReference() {
this.externalProjectRefCount++;
}
/* @internal */
/** @internal */
deleteExternalProjectReference() {
this.externalProjectRefCount--;
}
/* @internal */
/** @internal */
isSolution() {
return this.getRootFilesMap().size === 0 &&
!this.canConfigFileJsonReportNoInputFiles;
}
/* @internal */
/** @internal */
/** Find the configured project from the project references in project which contains the info directly */
getDefaultChildProjectFromProjectWithReferences(info: ScriptInfo) {
return forEachResolvedProjectReferenceProject(
@ -2639,7 +2644,7 @@ export class ConfiguredProject extends Project {
}
/** Returns true if the project is needed by any of the open script info/external project */
/* @internal */
/** @internal */
hasOpenRef() {
if (!!this.externalProjectRefCount) {
return true;
@ -2676,7 +2681,7 @@ export class ConfiguredProject extends Project {
) || false;
}
/*@internal*/
/** @internal */
hasExternalProjectRef() {
return !!this.externalProjectRefCount;
}
@ -2685,7 +2690,7 @@ export class ConfiguredProject extends Project {
return getEffectiveTypeRoots(this.getCompilationSettings(), this.directoryStructureHost) || [];
}
/*@internal*/
/** @internal */
updateErrorOnNoInputFiles(fileNames: string[]) {
updateErrorForNoInputFiles(fileNames, this.getConfigFilePath(), this.getCompilerOptions().configFile!.configFileSpecs!, this.projectErrors!, this.canConfigFileJsonReportNoInputFiles);
}
@ -2697,7 +2702,7 @@ export class ConfiguredProject extends Project {
*/
export class ExternalProject extends Project {
excludedFiles: readonly NormalizedPath[] = [];
/*@internal*/
/** @internal */
constructor(public externalProjectName: string,
projectService: ProjectService,
documentRegistry: DocumentRegistry,
@ -2732,17 +2737,17 @@ export class ExternalProject extends Project {
}
}
/* @internal */
/** @internal */
export function isInferredProject(project: Project): project is InferredProject {
return project.projectKind === ProjectKind.Inferred;
}
/* @internal */
/** @internal */
export function isConfiguredProject(project: Project): project is ConfiguredProject {
return project.projectKind === ProjectKind.Configured;
}
/* @internal */
/** @internal */
export function isExternalProject(project: Project): project is ExternalProject {
return project.projectKind === ProjectKind.External;
}

130
src/server/protocol.ts
View File

@ -15,7 +15,7 @@ import {
export const enum CommandTypes {
JsxClosingTag = "jsxClosingTag",
Brace = "brace",
/* @internal */
/** @internal */
BraceFull = "brace-full",
BraceCompletion = "braceCompletion",
GetSpanOfEnclosingComment = "getSpanOfEnclosingComment",
@ -24,36 +24,36 @@ export const enum CommandTypes {
/** @deprecated Prefer CompletionInfo -- see comment on CompletionsResponse */
Completions = "completions",
CompletionInfo = "completionInfo",
/* @internal */
/** @internal */
CompletionsFull = "completions-full",
CompletionDetails = "completionEntryDetails",
/* @internal */
/** @internal */
CompletionDetailsFull = "completionEntryDetails-full",
CompileOnSaveAffectedFileList = "compileOnSaveAffectedFileList",
CompileOnSaveEmitFile = "compileOnSaveEmitFile",
Configure = "configure",
Definition = "definition",
/* @internal */
/** @internal */
DefinitionFull = "definition-full",
DefinitionAndBoundSpan = "definitionAndBoundSpan",
/* @internal */
/** @internal */
DefinitionAndBoundSpanFull = "definitionAndBoundSpan-full",
Implementation = "implementation",
/* @internal */
/** @internal */
ImplementationFull = "implementation-full",
/* @internal */
/** @internal */
EmitOutput = "emit-output",
Exit = "exit",
FileReferences = "fileReferences",
/* @internal */
/** @internal */
FileReferencesFull = "fileReferences-full",
Format = "format",
Formatonkey = "formatonkey",
/* @internal */
/** @internal */
FormatFull = "format-full",
/* @internal */
/** @internal */
FormatonkeyFull = "formatonkey-full",
/* @internal */
/** @internal */
FormatRangeFull = "formatRange-full",
Geterr = "geterr",
GeterrForProject = "geterrForProject",
@ -61,34 +61,34 @@ export const enum CommandTypes {
SyntacticDiagnosticsSync = "syntacticDiagnosticsSync",
SuggestionDiagnosticsSync = "suggestionDiagnosticsSync",
NavBar = "navbar",
/* @internal */
/** @internal */
NavBarFull = "navbar-full",
Navto = "navto",
/* @internal */
/** @internal */
NavtoFull = "navto-full",
NavTree = "navtree",
NavTreeFull = "navtree-full",
/** @deprecated */
Occurrences = "occurrences",
DocumentHighlights = "documentHighlights",
/* @internal */
/** @internal */
DocumentHighlightsFull = "documentHighlights-full",
Open = "open",
Quickinfo = "quickinfo",
/* @internal */
/** @internal */
QuickinfoFull = "quickinfo-full",
References = "references",
/* @internal */
/** @internal */
ReferencesFull = "references-full",
Reload = "reload",
Rename = "rename",
/* @internal */
/** @internal */
RenameInfoFull = "rename-full",
/* @internal */
/** @internal */
RenameLocationsFull = "renameLocations-full",
Saveto = "saveto",
SignatureHelp = "signatureHelp",
/* @internal */
/** @internal */
SignatureHelpFull = "signatureHelp-full",
FindSourceDefinition = "findSourceDefinition",
Status = "status",
@ -99,65 +99,65 @@ export const enum CommandTypes {
OpenExternalProject = "openExternalProject",
OpenExternalProjects = "openExternalProjects",
CloseExternalProject = "closeExternalProject",
/* @internal */
/** @internal */
SynchronizeProjectList = "synchronizeProjectList",
/* @internal */
/** @internal */
ApplyChangedToOpenFiles = "applyChangedToOpenFiles",
UpdateOpen = "updateOpen",
/* @internal */
/** @internal */
EncodedSyntacticClassificationsFull = "encodedSyntacticClassifications-full",
/* @internal */
/** @internal */
EncodedSemanticClassificationsFull = "encodedSemanticClassifications-full",
/* @internal */
/** @internal */
Cleanup = "cleanup",
GetOutliningSpans = "getOutliningSpans",
/* @internal */
/** @internal */
GetOutliningSpansFull = "outliningSpans", // Full command name is different for backward compatibility purposes
TodoComments = "todoComments",
Indentation = "indentation",
DocCommentTemplate = "docCommentTemplate",
/* @internal */
/** @internal */
CompilerOptionsDiagnosticsFull = "compilerOptionsDiagnostics-full",
/* @internal */
/** @internal */
NameOrDottedNameSpan = "nameOrDottedNameSpan",
/* @internal */
/** @internal */
BreakpointStatement = "breakpointStatement",
CompilerOptionsForInferredProjects = "compilerOptionsForInferredProjects",
GetCodeFixes = "getCodeFixes",
/* @internal */
/** @internal */
GetCodeFixesFull = "getCodeFixes-full",
GetCombinedCodeFix = "getCombinedCodeFix",
/* @internal */
/** @internal */
GetCombinedCodeFixFull = "getCombinedCodeFix-full",
ApplyCodeActionCommand = "applyCodeActionCommand",
GetSupportedCodeFixes = "getSupportedCodeFixes",
GetApplicableRefactors = "getApplicableRefactors",
GetEditsForRefactor = "getEditsForRefactor",
/* @internal */
/** @internal */
GetEditsForRefactorFull = "getEditsForRefactor-full",
OrganizeImports = "organizeImports",
/* @internal */
/** @internal */
OrganizeImportsFull = "organizeImports-full",
GetEditsForFileRename = "getEditsForFileRename",
/* @internal */
/** @internal */
GetEditsForFileRenameFull = "getEditsForFileRename-full",
ConfigurePlugin = "configurePlugin",
SelectionRange = "selectionRange",
/* @internal */
/** @internal */
SelectionRangeFull = "selectionRange-full",
ToggleLineComment = "toggleLineComment",
/* @internal */
/** @internal */
ToggleLineCommentFull = "toggleLineComment-full",
ToggleMultilineComment = "toggleMultilineComment",
/* @internal */
/** @internal */
ToggleMultilineCommentFull = "toggleMultilineComment-full",
CommentSelection = "commentSelection",
/* @internal */
/** @internal */
CommentSelectionFull = "commentSelection-full",
UncommentSelection = "uncommentSelection",
/* @internal */
/** @internal */
UncommentSelectionFull = "uncommentSelection-full",
PrepareCallHierarchy = "prepareCallHierarchy",
ProvideCallHierarchyIncomingCalls = "provideCallHierarchyIncomingCalls",
@ -402,16 +402,18 @@ export interface OutliningSpansResponse extends Response {
/**
* Request to obtain outlining spans in file.
*
* @internal
*/
/* @internal */
export interface OutliningSpansRequestFull extends FileRequest {
command: CommandTypes.GetOutliningSpansFull;
}
/**
* Response to OutliningSpansRequest request.
*
* @internal
*/
/* @internal */
export interface OutliningSpansResponseFull extends Response {
body?: ts.OutliningSpan[];
}
@ -560,8 +562,9 @@ export interface FileLocationRequestArgs extends FileRequestArgs {
/**
* Position (can be specified instead of line/offset pair)
*
* @internal
*/
/* @internal */
position?: number;
}
@ -758,8 +761,9 @@ export interface FileRangeRequestArgs extends FileRequestArgs {
/**
* Position (can be specified instead of line/offset pair)
*
* @internal
*/
/* @internal */
startPosition?: number;
/**
@ -774,8 +778,9 @@ export interface FileRangeRequestArgs extends FileRequestArgs {
/**
* Position (can be specified instead of line/offset pair)
*
* @internal
*/
/* @internal */
endPosition?: number;
}
@ -837,16 +842,18 @@ export interface GetSupportedCodeFixesResponse extends Response {
/**
* A request to get encoded Syntactic classifications for a span in the file
*
* @internal
*/
/** @internal */
export interface EncodedSyntacticClassificationsRequest extends FileRequest {
arguments: EncodedSyntacticClassificationsRequestArgs;
}
/**
* Arguments for EncodedSyntacticClassificationsRequest request.
*
* @internal
*/
/** @internal */
export interface EncodedSyntacticClassificationsRequestArgs extends FileRequestArgs {
/**
* Start position of the span.
@ -1264,13 +1271,13 @@ export interface RenameRequest extends FileLocationRequest {
arguments: RenameRequestArgs;
}
/* @internal */
/** @internal */
export interface RenameFullRequest extends FileLocationRequest {
readonly command: CommandTypes.RenameLocationsFull;
readonly arguments: RenameRequestArgs;
}
/* @internal */
/** @internal */
export interface RenameFullResponse extends Response {
readonly body: readonly RenameLocation[];
}
@ -1424,8 +1431,9 @@ export type ExternalProjectCompilerOptions = CompilerOptions & CompileOnSaveMixi
/**
* Contains information about current project version
*
* @internal
*/
/* @internal */
export interface ProjectVersionInfo {
/**
* Project name
@ -1494,8 +1502,9 @@ export interface ProjectChanges {
* if files is set - then this is the entire set of files in the project
* if changes is set - then this is the set of changes that should be applied to existing project
* otherwise - assume that nothing is changed
*
* @internal
*/
/* @internal */
export interface ProjectFiles {
/**
* Information about project verison
@ -1515,8 +1524,9 @@ export interface ProjectFiles {
/**
* Combines project information with project level errors.
*
* @internal
*/
/* @internal */
export interface ProjectFilesWithDiagnostics extends ProjectFiles {
/**
* List of errors in project
@ -1526,8 +1536,9 @@ export interface ProjectFilesWithDiagnostics extends ProjectFiles {
/**
* Represents set of changes in open file
*
* @internal
*/
/* @internal */
export interface ChangedOpenFile {
/**
* Name of file
@ -1779,16 +1790,18 @@ export interface CloseExternalProjectResponse extends Response {
/**
* Request to check if given list of projects is up-to-date and synchronize them if necessary
*
* @internal
*/
/* @internal */
export interface SynchronizeProjectListRequest extends Request {
arguments: SynchronizeProjectListRequestArgs;
}
/**
* Arguments to SynchronizeProjectListRequest
*
* @internal
*/
/* @internal */
export interface SynchronizeProjectListRequestArgs {
/**
* List of last known projects
@ -1803,16 +1816,18 @@ export interface SynchronizeProjectListRequestArgs {
/**
* Request to synchronize list of open files with the client
*
* @internal
*/
/* @internal */
export interface ApplyChangedToOpenFilesRequest extends Request {
arguments: ApplyChangedToOpenFilesRequestArgs;
}
/**
* Arguments to ApplyChangedToOpenFilesRequest
*
* @internal
*/
/* @internal */
export interface ApplyChangedToOpenFilesRequestArgs {
/**
* List of newly open files
@ -2055,8 +2070,9 @@ export interface FormatRequestArgs extends FileLocationRequestArgs {
/**
* End position of the range for which to format text in file.
*
* @internal
*/
/* @internal */
endPosition?: number;
/**
* Format options to be used.
@ -2968,7 +2984,7 @@ export interface LargeFileReferencedEventBody {
maxFileSize: number;
}
/*@internal*/
/** @internal */
export type AnyEvent =
RequestCompletedEvent
| DiagnosticEvent

46
src/server/scriptInfo.ts
View File

@ -17,7 +17,7 @@ export interface ScriptInfoVersion {
text: number;
}
/* @internal */
/** @internal */
export class TextStorage {
version: ScriptInfoVersion;
@ -290,13 +290,13 @@ export function isDynamicFileName(fileName: NormalizedPath) {
(stringContains(fileName, ":^") && !stringContains(fileName, directorySeparator));
}
/*@internal*/
/** @internal */
export interface DocumentRegistrySourceFileCache {
key: DocumentRegistryBucketKeyWithMode;
sourceFile: SourceFile;
}
/*@internal*/
/** @internal */
export interface SourceMapFileWatcher {
watcher: FileWatcher;
sourceInfos?: Set<Path>;
@ -310,35 +310,35 @@ export class ScriptInfo {
private formatSettings: FormatCodeSettings | undefined;
private preferences: protocol.UserPreferences | undefined;
/* @internal */
/** @internal */
fileWatcher: FileWatcher | undefined;
private textStorage: TextStorage;
/*@internal*/
/** @internal */
readonly isDynamic: boolean;
/*@internal*/
/** @internal */
/** Set to real path if path is different from info.path */
private realpath: Path | undefined;
/*@internal*/
/** @internal */
cacheSourceFile: DocumentRegistrySourceFileCache | undefined;
/*@internal*/
/** @internal */
mTime?: number;
/*@internal*/
/** @internal */
sourceFileLike?: SourceFileLike;
/*@internal*/
/** @internal */
sourceMapFilePath?: Path | SourceMapFileWatcher | false;
// Present on sourceMapFile info
/*@internal*/
/** @internal */
declarationInfoPath?: Path;
/*@internal*/
/** @internal */
sourceInfos?: Set<Path>;
/*@internal*/
/** @internal */
documentPositionMapper?: DocumentPositionMapper | false;
constructor(
@ -360,17 +360,17 @@ export class ScriptInfo {
: getScriptKindFromFileName(fileName);
}
/*@internal*/
/** @internal */
getVersion() {
return this.textStorage.version;
}
/*@internal*/
/** @internal */
getTelemetryFileSize() {
return this.textStorage.getTelemetryFileSize();
}
/*@internal*/
/** @internal */
public isDynamicOrHasMixedContent() {
return this.hasMixedContent || this.isDynamic;
}
@ -423,7 +423,7 @@ export class ScriptInfo {
}
}
/*@internal*/
/** @internal */
getRealpathIfDifferent(): Path | undefined {
return this.realpath && this.realpath !== this.path ? this.realpath : undefined;
}
@ -592,7 +592,7 @@ export class ScriptInfo {
this.host.writeFile(fileName, getSnapshotText(this.textStorage.getSnapshot()));
}
/*@internal*/
/** @internal */
delayReloadNonMixedContentFile() {
Debug.assert(!this.isDynamicOrHasMixedContent());
this.textStorage.delayReloadFromFileIntoText();
@ -614,7 +614,7 @@ export class ScriptInfo {
return false;
}
/*@internal*/
/** @internal */
getAbsolutePositionAndLineText(line: number): AbsolutePositionAndLineText {
return this.textStorage.getAbsolutePositionAndLineText(line);
}
@ -634,7 +634,7 @@ export class ScriptInfo {
return !forEach(this.containingProjects, p => !p.isOrphan());
}
/*@internal*/
/** @internal */
isContainedByBackgroundProject() {
return some(
this.containingProjects,
@ -653,7 +653,7 @@ export class ScriptInfo {
* @param offset 1 based index
*/
lineOffsetToPosition(line: number, offset: number): number;
/*@internal*/
/** @internal */
lineOffsetToPosition(line: number, offset: number, allowEdits?: true): number; // eslint-disable-line @typescript-eslint/unified-signatures
lineOffsetToPosition(line: number, offset: number, allowEdits?: true): number {
return this.textStorage.lineOffsetToPosition(line, offset, allowEdits);
@ -670,12 +670,12 @@ export class ScriptInfo {
return this.scriptKind === ScriptKind.JS || this.scriptKind === ScriptKind.JSX;
}
/*@internal*/
/** @internal */
getLineInfo(): LineInfo {
return this.textStorage.getLineInfo();
}
/*@internal*/
/** @internal */
closeSourceMapFileWatcher() {
if (this.sourceMapFilePath && !isString(this.sourceMapFilePath)) {
closeFileWatcherOf(this.sourceMapFilePath);

2
src/server/session.ts
View File

@ -3531,7 +3531,7 @@ export interface HandlerResponse {
responseRequired?: boolean;
}
/* @internal */ // Exported only for tests
/** @internal */ // Exported only for tests
export function getLocationInNewDocument(oldText: string, renameFilename: string, renameLocation: number, edits: readonly FileTextChanges[]): protocol.Location {
const newText = applyEdits(oldText, renameFilename, edits);
const { line, character } = computeLineAndCharacterOfPosition(computeLineStarts(newText), renameLocation);

2
src/server/types.ts
View File

@ -21,6 +21,6 @@ export interface ServerHost extends System {
gc?(): void;
trace?(s: string): void;
require?(initialPath: string, moduleName: string): ModuleImportResult;
/*@internal*/
/** @internal */
importPlugin?(root: string, moduleName: string): Promise<ModuleImportResult>;
}

2
src/server/typingsCache.ts
View File

@ -86,7 +86,7 @@ function unresolvedImportsChanged(imports1: SortedReadonlyArray<string> | undefi
return !arrayIsEqualTo(imports1, imports2);
}
/*@internal*/
/** @internal */
export class TypingsCache {
private readonly perProjectCache = new Map<string, TypingsCacheEntry>();

7
src/server/utilities.ts
View File

@ -106,8 +106,11 @@ export function indent(str: string): string {
return indentStr + str.replace(/\n/g, indentStr);
}
/** @internal */
/** Put stringified JSON on the next line, indented. */
/**
* Put stringified JSON on the next line, indented.
*
* @internal
*/
export function stringifyIndented(json: {}): string {
return indentStr + JSON.stringify(json);
}

6
src/server/utilitiesPublic.ts
View File

@ -102,7 +102,7 @@ export function createNormalizedPathMap<T>(): NormalizedPathMap<T> {
};
}
/*@internal*/
/** @internal */
export interface ProjectOptions {
configHasExtendsProperty: boolean;
/**
@ -122,12 +122,12 @@ export function makeInferredProjectName(counter: number): string {
return `/dev/null/inferredProject${counter}*`;
}
/*@internal*/
/** @internal */
export function makeAutoImportProviderProjectName(counter: number): string {
return `/dev/null/autoImportProviderProject${counter}*`;
}
/*@internal*/
/** @internal */
export function makeAuxiliaryProjectName(counter: number): string {
return `/dev/null/auxiliaryProject${counter}*`;
}

3
src/services/breakpoints.ts
View File

@ -13,9 +13,10 @@ import {
TypeAssertion, VariableDeclaration, VariableDeclarationList, VariableStatement, WhileStatement, WithStatement,
} from "./_namespaces/ts";
/** @internal */
/**
* Get the breakpoint span in given sourceFile
*
* @internal
*/
export function spanInSourceFileAtLocation(sourceFile: SourceFile, position: number) {
// Cannot set breakpoint in dts file

28
src/services/callHierarchy.ts
View File

@ -244,8 +244,11 @@ function findImplementationOrAllInitialDeclarations(typeChecker: TypeChecker, no
return findAllInitialDeclarations(typeChecker, node) ?? node;
}
/** @internal */
/** Resolves the call hierarchy declaration for a node. */
/**
* Resolves the call hierarchy declaration for a node.
*
* @internal
*/
export function resolveCallHierarchyDeclaration(program: Program, location: Node): CallHierarchyDeclaration | CallHierarchyDeclaration[] | undefined {
// A call hierarchy item must refer to either a SourceFile, Module Declaration, Class Static Block, or something intrinsically callable that has a name:
// - Class Declarations
@ -315,8 +318,11 @@ export function resolveCallHierarchyDeclaration(program: Program, location: Node
}
}
/** @internal */
/** Creates a `CallHierarchyItem` for a call hierarchy declaration. */
/**
* Creates a `CallHierarchyItem` for a call hierarchy declaration.
*
* @internal
*/
export function createCallHierarchyItem(program: Program, node: CallHierarchyDeclaration): CallHierarchyItem {
const sourceFile = node.getSourceFile();
const name = getCallHierarchyItemName(program, node);
@ -365,8 +371,11 @@ function convertCallSiteGroupToIncomingCall(program: Program, entries: readonly
return createCallHierarchyIncomingCall(createCallHierarchyItem(program, entries[0].declaration), map(entries, entry => createTextSpanFromRange(entry.range)));
}
/** @internal */
/** Gets the call sites that call into the provided call hierarchy declaration. */
/**
* Gets the call sites that call into the provided call hierarchy declaration.
*
* @internal
*/
export function getIncomingCalls(program: Program, declaration: CallHierarchyDeclaration, cancellationToken: CancellationToken): CallHierarchyIncomingCall[] {
// Source files and modules have no incoming calls.
if (isSourceFile(declaration) || isModuleDeclaration(declaration) || isClassStaticBlockDeclaration(declaration)) {
@ -575,8 +584,11 @@ function convertCallSiteGroupToOutgoingCall(program: Program, entries: readonly
return createCallHierarchyOutgoingCall(createCallHierarchyItem(program, entries[0].declaration), map(entries, entry => createTextSpanFromRange(entry.range)));
}
/** @internal */
/** Gets the call sites that call out of the provided call hierarchy declaration. */
/**
* Gets the call sites that call out of the provided call hierarchy declaration.
*
* @internal
*/
export function getOutgoingCalls(program: Program, declaration: CallHierarchyDeclaration): CallHierarchyOutgoingCall[] {
if (declaration.flags & NodeFlags.Ambient || isMethodSignature(declaration)) {
return [];

8
src/services/classifier.ts
View File

@ -467,7 +467,7 @@ function classFromKind(token: SyntaxKind): ClassificationType {
}
}
/* @internal */
/** @internal */
export function getSemanticClassifications(typeChecker: TypeChecker, cancellationToken: CancellationToken, sourceFile: SourceFile, classifiableNames: ReadonlySet<__String>, span: TextSpan): ClassifiedSpan[] {
return convertClassificationsToSpans(getEncodedSemanticClassifications(typeChecker, cancellationToken, sourceFile, classifiableNames, span));
}
@ -495,7 +495,7 @@ function checkForClassificationCancellation(cancellationToken: CancellationToken
}
}
/* @internal */
/** @internal */
export function getEncodedSemanticClassifications(typeChecker: TypeChecker, cancellationToken: CancellationToken, sourceFile: SourceFile, classifiableNames: ReadonlySet<__String>, span: TextSpan): Classifications {
const spans: number[] = [];
sourceFile.forEachChild(function cb(node: Node): void {
@ -610,12 +610,12 @@ function convertClassificationsToSpans(classifications: Classifications): Classi
return result;
}
/* @internal */
/** @internal */
export function getSyntacticClassifications(cancellationToken: CancellationToken, sourceFile: SourceFile, span: TextSpan): ClassifiedSpan[] {
return convertClassificationsToSpans(getEncodedSyntacticClassifications(cancellationToken, sourceFile, span));
}
/* @internal */
/** @internal */
export function getEncodedSyntacticClassifications(cancellationToken: CancellationToken, sourceFile: SourceFile, span: TextSpan): Classifications {
const spanStart = span.start;
const spanLength = span.length;

9
src/services/classifier2020.ts
View File

@ -8,8 +8,6 @@ import {
SyntaxKind, TextSpan, textSpanIntersectsWith, Type, TypeChecker, VariableDeclaration,
} from "./_namespaces/ts";
/** @internal */
/** @internal */
export const enum TokenEncodingConsts {
typeOffset = 8,
@ -26,8 +24,11 @@ export const enum TokenModifier {
declaration, static, async, readonly, defaultLibrary, local
}
/** @internal */
/** This is mainly used internally for testing */
/**
* This is mainly used internally for testing
*
* @internal
*/
export function getSemanticClassifications(program: Program, cancellationToken: CancellationToken, sourceFile: SourceFile, span: TextSpan): ClassifiedSpan2020[] {
const classifications = getEncodedSemanticClassifications(program, cancellationToken, sourceFile, span);

9
src/services/codefixes/helpers.ts
View File

@ -18,13 +18,14 @@ import {
} from "../_namespaces/ts";
import { ImportAdder } from "../_namespaces/ts.codefix";
/** @internal */
/**
* Finds members of the resolved type that are missing in the class pointed to by class decl
* and generates source code for the missing members.
* @param possiblyMissingSymbols The collection of symbols to filter and then get insertions for.
* @param importAdder If provided, type annotations will use identifier type references instead of ImportTypeNodes, and the missing imports will be added to the importAdder.
* @returns Empty string iff there are no member insertions.
*
* @internal
*/
export function createMissingMemberNodes(
classDeclaration: ClassLikeDeclaration,
@ -65,10 +66,11 @@ export const enum PreserveOptionalFlags {
All = Method | Property
}
/** @internal */
/**
* `addClassElement` will not be called if we can't figure out a representation for `symbol` in `enclosingDeclaration`.
* @param body If defined, this will be the body of the member node passed to `addClassElement`. Otherwise, the body will default to a stub.
*
* @internal
*/
export function addNewNodeForMemberSymbol(
symbol: Symbol,
@ -729,11 +731,12 @@ export function findJsonProperty(obj: ObjectLiteralExpression, name: string): Pr
return find(obj.properties, (p): p is PropertyAssignment => isPropertyAssignment(p) && !!p.name && isStringLiteral(p.name) && p.name.text === name);
}
/** @internal */
/**
* Given a type node containing 'import("./a").SomeType<import("./b").OtherType<...>>',
* returns an equivalent type reference node with any nested ImportTypeNodes also replaced
* with type references, and a list of symbols that must be imported to use the type reference.
*
* @internal
*/
export function tryGetAutoImportableReferenceFromTypeNode(importTypeNode: TypeNode | undefined, scriptTarget: ScriptTarget) {
let symbols: Symbol[] | undefined;

9
src/services/codefixes/importFixes.ts
View File

@ -67,9 +67,10 @@ registerCodeFix({
},
});
/** @internal */
/**
* Computes multiple import additions to a file and writes them to a ChangeTracker.
*
* @internal
*/
export interface ImportAdder {
hasFixes(): boolean;
@ -266,9 +267,10 @@ function createImportAdderWorker(sourceFile: SourceFile, program: Program, useAu
}
}
/** @internal */
/**
* Computes module specifiers for multiple import additions to a file.
*
* @internal
*/
export interface ImportSpecifierResolver {
getModuleSpecifierForBestExportInfo(
@ -886,10 +888,11 @@ function getUmdSymbol(token: Node, checker: TypeChecker): Symbol | undefined {
: undefined;
}
/** @internal */
/**
* @param forceImportKeyword Indicates that the user has already typed `import`, so the result must start with `import`.
* (In other words, do not allow `const x = require("...")` for JS files.)
*
* @internal
*/
export function getImportKind(importingFile: SourceFile, exportKind: ExportKind, compilerOptions: CompilerOptions, forceImportKeyword?: boolean): ImportKind {
switch (exportKind) {

3
src/services/completions.ts
View File

@ -100,7 +100,6 @@ export const SortText = {
},
};
/** @internal */
/**
* Special values for `CompletionInfo['source']` used to disambiguate
* completion items with the same `name`. (Each completion item must
@ -111,6 +110,8 @@ export const SortText = {
* is the module specifier of the suggestion. To avoid collisions,
* the values here should not be a module specifier we would ever
* generate for an auto-import.
*
* @internal
*/
export enum CompletionSource {
/** Completions that require `this.` insertion text */

2
src/services/documentHighlights.ts
View File

@ -18,7 +18,7 @@ export interface DocumentHighlights {
highlightSpans: HighlightSpan[];
}
/* @internal */
/** @internal */
export namespace DocumentHighlights {
export function getDocumentHighlights(program: Program, cancellationToken: CancellationToken, sourceFile: SourceFile, position: number, sourceFilesToSearch: readonly SourceFile[]): DocumentHighlights[] | undefined {
const node = getTouchingPropertyName(sourceFile, position);

11
src/services/documentRegistry.ts
View File

@ -104,8 +104,9 @@ export interface DocumentRegistry {
* @param fileName The name of the file to be released
* @param compilationSettings The compilation settings used to acquire the file
* @param scriptKind The script kind of the file to be released
*
* @deprecated pass scriptKind and impliedNodeFormat for correctness
*/
/**@deprecated pass scriptKind and impliedNodeFormat for correctness */
releaseDocument(fileName: string, compilationSettings: CompilerOptions, scriptKind?: ScriptKind): void;
/**
* Informs the DocumentRegistry that a file is not needed any longer.
@ -124,13 +125,13 @@ export interface DocumentRegistry {
releaseDocumentWithKey(path: Path, key: DocumentRegistryBucketKey, scriptKind?: ScriptKind): void;
releaseDocumentWithKey(path: Path, key: DocumentRegistryBucketKey, scriptKind: ScriptKind, impliedNodeFormat: SourceFile["impliedNodeFormat"]): void; // eslint-disable-line @typescript-eslint/unified-signatures
/*@internal*/
/** @internal */
getLanguageServiceRefCounts(path: Path, scriptKind: ScriptKind): [string, number | undefined][];
reportStats(): string;
}
/*@internal*/
/** @internal */
export interface ExternalDocumentCache {
setDocument(key: DocumentRegistryBucketKeyWithMode, path: Path, sourceFile: SourceFile): void;
getDocument(key: DocumentRegistryBucketKeyWithMode, path: Path): SourceFile | undefined;
@ -156,9 +157,9 @@ export function createDocumentRegistry(useCaseSensitiveFileNames?: boolean, curr
return createDocumentRegistryInternal(useCaseSensitiveFileNames, currentDirectory);
}
/*@internal*/
/** @internal */
export type DocumentRegistryBucketKeyWithMode = string & { __documentRegistryBucketKeyWithMode: any; };
/*@internal*/
/** @internal */
export function createDocumentRegistryInternal(useCaseSensitiveFileNames?: boolean, currentDirectory = "", externalCache?: ExternalDocumentCache): DocumentRegistry {
// Maps from compiler setting target (ES3, ES5, etc.) to all the cached documents we have
// for those settings.

4
src/services/exportAsModule.ts
View File

@ -3,7 +3,7 @@ import * as ts from "./_namespaces/ts";
// Here we expose the TypeScript services as an external module
// so that it may be consumed easily like a node module.
// @ts-ignore
/* @internal */ declare const module: { exports: {} };
/** @internal */ declare const module: { exports: {} };
if (typeof module !== "undefined" && module.exports) {
module.exports = ts;
}
}

14
src/services/findAllReferences.ts
View File

@ -638,8 +638,11 @@ function isWriteAccessForReference(node: Node): boolean {
return !!decl && declarationIsWriteAccess(decl) || node.kind === SyntaxKind.DefaultKeyword || isWriteAccess(node);
}
/** @internal */
/** Whether a reference, `node`, is a definition of the `target` symbol */
/**
* Whether a reference, `node`, is a definition of the `target` symbol
*
* @internal
*/
export function isDeclarationOfSymbol(node: Node, target: Symbol | undefined): boolean {
if (!target) return false;
const source = getDeclarationFromName(node) ||
@ -712,8 +715,11 @@ function declarationIsWriteAccess(decl: Declaration): boolean {
}
}
/** @internal */
/** Encapsulates the core find-all-references algorithm. */
/**
* Encapsulates the core find-all-references algorithm.
*
* @internal
*/
export namespace Core {
/** Core find-all-references algorithm. Handles special cases before delegating to `getReferencedSymbolsForSymbol`. */
export function getReferencedSymbolsForNode(position: number, node: Node, program: Program, sourceFiles: readonly SourceFile[], cancellationToken: CancellationToken, options: Options = {}, sourceFilesSet: ReadonlySet<string> = new Set(sourceFiles.map(f => f.fileName))): readonly SymbolAndEntries[] | undefined {

4
src/services/formatting/formatting.ts
View File

@ -1316,9 +1316,9 @@ function formatSpanWorker(
const enum LineAction { None, LineAdded, LineRemoved }
/** @internal */
/**
* @param precedingToken pass `null` if preceding token was already computed and result was `undefined`.
*
* @internal
*/
export function getRangeOfEnclosingComment(
sourceFile: SourceFile,

4
src/services/globalThisShim.ts
View File

@ -7,7 +7,7 @@ import { TypeScriptServicesFactory, versionMajorMinor } from "./_namespaces/ts";
// #region The polyfill starts here.
/* eslint-disable no-var */
/* @internal */
/** @internal */
declare global {
// Module transform: converted from ambient declaration
/** @internal */
@ -62,4 +62,4 @@ if (typeof process === "undefined" || process.browser) {
//@ts-ignore
globalThis.toolsVersion = versionMajorMinor;
}
}

7
src/services/goToDefinition.ts
View File

@ -424,8 +424,11 @@ function getDefinitionFromSymbol(typeChecker: TypeChecker, symbol: Symbol, node:
}
}
/** @internal */
/** Creates a DefinitionInfo from a Declaration, using the declaration's name if possible. */
/**
* Creates a DefinitionInfo from a Declaration, using the declaration's name if possible.
*
* @internal
*/
export function createDefinitionInfo(declaration: Declaration, checker: TypeChecker, symbol: Symbol, node: Node, unverified?: boolean, failedAliasResolution?: boolean): DefinitionInfo {
const symbolName = checker.symbolToString(symbol); // Do not get scoped name, just the name of the symbol
const symbolKind = SymbolDisplay.getSymbolKind(checker, symbol, node);

17
src/services/importTracker.ts
View File

@ -29,8 +29,11 @@ export interface ImportsResult {
/** @internal */
export type ImportTracker = (exportSymbol: Symbol, exportInfo: ExportInfo, isForRename: boolean) => ImportsResult;
/** @internal */
/** Creates the imports map and returns an ImportTracker that uses it. Call this lazily to avoid calling `getDirectImportsMap` unnecessarily. */
/**
* Creates the imports map and returns an ImportTracker that uses it. Call this lazily to avoid calling `getDirectImportsMap` unnecessarily.
*
* @internal
*/
export function createImportTracker(sourceFiles: readonly SourceFile[], sourceFilesSet: ReadonlySet<string>, checker: TypeChecker, cancellationToken: CancellationToken | undefined): ImportTracker {
const allDirectImports = getDirectImportsMap(sourceFiles, checker, cancellationToken);
return (exportSymbol, exportInfo, isForRename) => {
@ -39,8 +42,11 @@ export function createImportTracker(sourceFiles: readonly SourceFile[], sourceFi
};
}
/** @internal */
/** Info about an exported symbol to perform recursive search on. */
/**
* Info about an exported symbol to perform recursive search on.
*
* @internal
*/
export interface ExportInfo {
exportingModuleSymbol: Symbol;
exportKind: ExportKind;
@ -479,13 +485,14 @@ export interface ExportedSymbol {
exportInfo: ExportInfo;
}
/** @internal */
/**
* Given a local reference, we might notice that it's an import/export and recursively search for references of that.
* If at an import, look locally for the symbol it imports.
* If at an export, look for all imports of it.
* This doesn't handle export specifiers; that is done in `getReferencesAtExportSpecifier`.
* @param comingFromExport If we are doing a search for all exports, don't bother looking backwards for the imported symbol, since that's the reason we're here.
*
* @internal
*/
export function getImportOrExportSymbol(node: Node, symbol: Symbol, checker: TypeChecker, comingFromExport: boolean): ImportedSymbol | ExportedSymbol | undefined {
return comingFromExport ? getExport() : getExport() || getImport();

3
src/services/jsDoc.ts
View File

@ -337,7 +337,6 @@ export function getJSDocParameterNameCompletionDetails(name: string): Completion
};
}
/** @internal */
/**
* Checks if position points to a valid position to add JSDoc comments, and if so,
* returns the appropriate template. Otherwise returns an empty string.
@ -360,6 +359,8 @@ export function getJSDocParameterNameCompletionDetails(name: string): Completion
* @param fileName The file in which to perform the check.
* @param position The (character-indexed) position in the file where the check should
* be performed.
*
* @internal
*/
export function getDocCommentTemplateAtPosition(newLine: string, sourceFile: SourceFile, position: number, options?: DocCommentTemplateOptions): TextInsertion | undefined {
const tokenAtPos = getTokenAtPosition(sourceFile, position);

16
src/services/organizeImports.ts
View File

@ -10,12 +10,13 @@ import {
tryCast, UserPreferences,
} from "./_namespaces/ts";
/** @internal */
/**
* Organize imports by:
* 1) Removing unused imports
* 2) Coalescing imports from the same module
* 3) Sorting imports
*
* @internal
*/
export function organizeImports(
sourceFile: SourceFile,
@ -244,9 +245,10 @@ function getExternalModuleName(specifier: Expression) {
}
// Internal for testing
/** @internal */
/**
* @param importGroup a list of ImportDeclarations, all with the same module name.
*
* @internal
*/
export function coalesceImports(importGroup: readonly ImportDeclaration[]) {
if (importGroup.length === 0) {
@ -385,9 +387,10 @@ function getCategorizedImports(importGroup: readonly ImportDeclaration[]) {
}
// Internal for testing
/** @internal */
/**
* @param exportGroup a list of ExportDeclarations, all with the same module name.
*
* @internal
*/
export function coalesceExports(exportGroup: readonly ExportDeclaration[]) {
if (exportGroup.length === 0) {
@ -484,8 +487,11 @@ export function compareImportOrExportSpecifiers<T extends ImportOrExportSpecifie
|| compareIdentifiers(s1.name, s2.name);
}
/* internal */ // Exported for testing
/** @internal */
/**
* Exported for testing
*
* @internal
*/
export function compareModuleSpecifiers(m1: Expression | undefined, m2: Expression | undefined) {
const name1 = m1 === undefined ? undefined : getExternalModuleName(m1);
const name2 = m2 === undefined ? undefined : getExternalModuleName(m2);

7
src/services/refactorProvider.ts
View File

@ -7,8 +7,11 @@ import { refactorKindBeginsWith } from "./_namespaces/ts.refactor";
// e.g. nonSuggestableRefactors[refactorCode] -> the refactor you want
const refactors = new Map<string, Refactor>();
/** @internal */
/** @param name An unique code associated with each refactor. Does not have to be human-readable. */
/**
* @param name An unique code associated with each refactor. Does not have to be human-readable.
*
* @internal
*/
export function registerRefactor(name: string, refactor: Refactor) {
refactors.set(name, refactor);
}

15
src/services/refactors/extractSymbol.ts
View File

@ -49,10 +49,11 @@ registerRefactor(refactorName, {
getAvailableActions: getRefactorActionsToExtractSymbol,
});
/** @internal */
/**
* Compute the associated code actions
* Exported for tests.
*
* @internal
*/
export function getRefactorActionsToExtractSymbol(context: RefactorContext): readonly ApplicableRefactorInfo[] {
const requestedRefactor = context.kind;
@ -196,8 +197,11 @@ export function getRefactorActionsToExtractSymbol(context: RefactorContext): rea
}
}
/* Exported for tests */
/** @internal */
/**
* Exported for tests
*
* @internal
*/
export function getRefactorEditsToExtractSymbol(context: RefactorContext, actionName: string): RefactorEditInfo | undefined {
const rangeToExtract = getRangeToExtract(context.file, getRefactorContextSpan(context));
const targetRange = rangeToExtract.targetRange!; // TODO:GH#18217
@ -292,14 +296,15 @@ type RangeToExtract = {
*/
type Scope = FunctionLikeDeclaration | SourceFile | ModuleBlock | ClassLikeDeclaration;
/** @internal */
// exported only for tests
/**
* getRangeToExtract takes a span inside a text file and returns either an expression or an array
* of statements representing the minimum set of nodes needed to extract the entire span. This
* process may fail, in which case a set of errors is returned instead. These errors are shown to
* users if they have the provideRefactorNotApplicableReason option set.
*
* @internal
*/
// exported only for tests
export function getRangeToExtract(sourceFile: SourceFile, span: TextSpan, invoked = true): RangeToExtract {
const { length } = span;
if (length === 0 && !invoked) {

10
src/services/refactors/helpers.ts
View File

@ -1,23 +1,27 @@
/** @internal */
/**
* Returned by refactor functions when some error message needs to be surfaced to users.
*
* @internal
*/
export interface RefactorErrorInfo {
error: string;
}
/** @internal */
/**
* Checks if some refactor info has refactor error info.
*
* @internal
*/
export function isRefactorErrorInfo(info: unknown): info is RefactorErrorInfo {
return (info as RefactorErrorInfo).error !== undefined;
}
/** @internal */
/**
* Checks if string "known" begins with string "requested".
* Used to match requested kinds with a known kind.
*
* @internal
*/
export function refactorKindBeginsWith(known: string, requested: string | undefined): boolean {
if(!requested) return true;

32
src/services/services.ts
View File

@ -473,7 +473,7 @@ class IdentifierObject extends TokenOrIdentifierObject implements Identifier {
_unaryExpressionBrand: any;
_expressionBrand: any;
_declarationBrand: any;
/*@internal*/typeArguments!: NodeArray<TypeNode>;
/** @internal */typeArguments!: NodeArray<TypeNode>;
constructor(_kind: SyntaxKind.Identifier, pos: number, end: number) {
super(pos, end);
}
@ -995,12 +995,12 @@ function getServicesObjectAllocator(): ObjectAllocator {
/// Language Service
/* @internal */
/** @internal */
export interface DisplayPartsSymbolWriter extends EmitTextWriter {
displayParts(): SymbolDisplayPart[];
}
/* @internal */
/** @internal */
export function toEditorSettings(options: FormatCodeOptions | FormatCodeSettings): FormatCodeSettings;
export function toEditorSettings(options: EditorOptions | EditorSettings): EditorSettings;
export function toEditorSettings(optionsAsMap: MapLike<any>): MapLike<any> {
@ -1194,8 +1194,11 @@ class CancellationTokenObject implements CancellationToken {
}
}
/* @internal */
/** A cancellation that throttles calls to the host */
/**
* A cancellation that throttles calls to the host
*
* @internal
*/
export class ThrottledCancellationToken implements CancellationToken {
// Store when we last tried to cancel. Checking cancellation can be expensive (as we have
// to marshall over to the host layer). So we only bother actually checking once enough
@ -2798,8 +2801,11 @@ export function createLanguageService(
return ls;
}
/* @internal */
/** Names in the name table are escaped, so an identifier `__foo` will have a name table entry `___foo`. */
/**
* Names in the name table are escaped, so an identifier `__foo` will have a name table entry `___foo`.
*
* @internal
*/
export function getNameTable(sourceFile: SourceFile): UnderscoreEscapedMap<number> {
if (!sourceFile.nameTable) {
initializeNameTable(sourceFile);
@ -2844,8 +2850,9 @@ function literalIsName(node: StringLiteralLike | NumericLiteral): boolean {
/**
* Returns the containing object literal property declaration given a possible name node, e.g. "a" in x = { "a": 1 }
*
* @internal
*/
/* @internal */
export function getContainingObjectLiteralElement(node: Node): ObjectLiteralElementWithName | undefined {
const element = getContainingObjectLiteralElementWorker(node);
return element && (isObjectLiteralExpression(element.parent) || isJsxAttributes(element.parent)) ? element as ObjectLiteralElementWithName : undefined;
@ -2868,7 +2875,7 @@ function getContainingObjectLiteralElementWorker(node: Node): ObjectLiteralEleme
return undefined;
}
/* @internal */
/** @internal */
export type ObjectLiteralElementWithName = ObjectLiteralElement & { name: PropertyName; parent: ObjectLiteralExpression | JsxAttributes };
function getSymbolAtLocationForQuickInfo(node: Node, checker: TypeChecker): Symbol | undefined {
@ -2883,8 +2890,11 @@ function getSymbolAtLocationForQuickInfo(node: Node, checker: TypeChecker): Symb
return checker.getSymbolAtLocation(node);
}
/** Gets all symbols for one property. Does not get symbols for every property. */
/* @internal */
/**
* Gets all symbols for one property. Does not get symbols for every property.
*
* @internal
*/
export function getPropertySymbolsFromContextualType(node: ObjectLiteralElementWithName, checker: TypeChecker, contextualType: Type, unionSymbolOk: boolean): readonly Symbol[] {
const name = getNameFromPropertyName(node.name);
if (!name) return emptyArray;

23
src/services/shims.ts
View File

@ -28,7 +28,7 @@ import {
// limitations under the License.
//
/* @internal */
/** @internal */
let debugObjectHost: { CollectGarbage(): void } = (function (this: any) { // eslint-disable-line prefer-const
return this;
})();
@ -74,8 +74,11 @@ export interface Logger {
error(s: string): void;
}
/** @internal */
/** Public interface of the host of a language service shim instance. */
/**
* Public interface of the host of a language service shim instance.
*
* @internal
*/
export interface LanguageServiceShimHost extends Logger {
getCompilationSettings(): string;
@ -103,8 +106,11 @@ export interface LanguageServiceShimHost extends Logger {
directoryExists(directoryName: string): boolean;
}
/** @internal */
/** Public interface of the core-services host instance used in managed side */
/**
* Public interface of the core-services host instance used in managed side
*
* @internal
*/
export interface CoreServicesShimHost extends Logger {
directoryExists(directoryName: string): boolean;
fileExists(fileName: string): boolean;
@ -140,8 +146,11 @@ export interface ShimsFileReference {
length: number;
}
/** @internal */
/** Public interface of a language service instance shim. */
/**
* Public interface of a language service instance shim.
*
* @internal
*/
export interface ShimFactory {
registerShim(shim: Shim): void;
unregisterShim(shim: Shim): void;

3
src/services/sourcemaps.ts
View File

@ -142,10 +142,11 @@ export function getSourceMapper(host: SourceMapperHost): SourceMapper {
}
}
/** @internal */
/**
* string | undefined to contents of map file to create DocumentPositionMapper from it
* DocumentPositionMapper | false to give back cached DocumentPositionMapper
*
* @internal
*/
export type ReadMapFile = (mapFileName: string, mapFileNameFromDts: string | undefined) => string | undefined | DocumentPositionMapper | false;

10
src/services/textChanges.ts
View File

@ -110,7 +110,6 @@ function hasCommentsBeforeLineBreak(text: string, start: number) {
return false;
}
/** @internal */
/**
* Usually node.pos points to a position immediately after the previous token.
* If this position is used as a beginning of the span to remove - it might lead to removing the trailing trivia of the previous node, i.e:
@ -123,6 +122,8 @@ function hasCommentsBeforeLineBreak(text: string, start: number) {
* By default when removing nodes we adjust start and end positions to respect specification of the trivia above.
* If pos\end should be interpreted literally (that is, withouth including leading and trailing trivia), `leadingTriviaOption` should be set to `LeadingTriviaOption.Exclude`
* and `trailingTriviaOption` to `TrailingTriviaOption.Exclude`.
*
* @internal
*/
export interface ConfigurableStartEnd extends ConfigurableStart, ConfigurableEnd {}
@ -1635,9 +1636,12 @@ namespace deleteDeclaration {
}
}
/** @internal */
/** Warning: This deletes comments too. See `copyComments` in `convertFunctionToEs6Class`. */
// Exported for tests only! (TODO: improve tests to not need this)
/**
* Warning: This deletes comments too. See `copyComments` in `convertFunctionToEs6Class`.
*
* @internal
*/
export function deleteNode(changes: ChangeTracker, sourceFile: SourceFile, node: Node, options: ConfigurableStartEnd = { leadingTriviaOption: LeadingTriviaOption.IncludeAll }): void {
const startPosition = getAdjustedStartPosition(sourceFile, node, options);
const endPosition = getAdjustedEndPosition(sourceFile, node, options);

7
src/services/transpile.ts
View File

@ -127,8 +127,11 @@ export function transpile(input: string, compilerOptions?: CompilerOptions, file
let commandLineOptionsStringToEnum: CommandLineOptionOfCustomType[];
/** JS users may pass in string values for enum compiler options (such as ModuleKind), so convert. */
/*@internal*/
/**
* JS users may pass in string values for enum compiler options (such as ModuleKind), so convert.
*
* @internal
*/
export function fixupCompilerOptions(options: CompilerOptions, diagnostics: Diagnostic[]): CompilerOptions {
// Lazily create this value to fix module loading errors.
commandLineOptionsStringToEnum = commandLineOptionsStringToEnum ||

96
src/services/types.ts
View File

@ -15,10 +15,10 @@ declare module "../compiler/types" {
getChildCount(sourceFile?: SourceFile): number;
getChildAt(index: number, sourceFile?: SourceFile): Node;
getChildren(sourceFile?: SourceFile): Node[];
/* @internal */
/** @internal */
getChildren(sourceFile?: SourceFileLike): Node[]; // eslint-disable-line @typescript-eslint/unified-signatures
getStart(sourceFile?: SourceFile, includeJsDocComment?: boolean): number;
/* @internal */
/** @internal */
getStart(sourceFile?: SourceFileLike, includeJsDocComment?: boolean): number; // eslint-disable-line @typescript-eslint/unified-signatures
getFullStart(): number;
getEnd(): number;
@ -28,10 +28,10 @@ declare module "../compiler/types" {
getFullText(sourceFile?: SourceFile): string;
getText(sourceFile?: SourceFile): string;
getFirstToken(sourceFile?: SourceFile): Node | undefined;
/* @internal */
/** @internal */
getFirstToken(sourceFile?: SourceFileLike): Node | undefined; // eslint-disable-line @typescript-eslint/unified-signatures
getLastToken(sourceFile?: SourceFile): Node | undefined;
/* @internal */
/** @internal */
getLastToken(sourceFile?: SourceFileLike): Node | undefined; // eslint-disable-line @typescript-eslint/unified-signatures
// See ts.forEachChild for documentation.
forEachChild<T>(cbNode: (node: Node) => T | undefined, cbNodeArray?: (nodes: NodeArray<Node>) => T | undefined): T | undefined;
@ -61,10 +61,10 @@ declare module "../compiler/types" {
getName(): string;
getDeclarations(): Declaration[] | undefined;
getDocumentationComment(typeChecker: TypeChecker | undefined): SymbolDisplayPart[];
/* @internal */
/** @internal */
getContextualDocumentationComment(context: Node | undefined, checker: TypeChecker | undefined): SymbolDisplayPart[]
getJsDocTags(checker?: TypeChecker): JSDocTagInfo[];
/* @internal */
/** @internal */
getContextualJsDocTags(context: Node | undefined, checker: TypeChecker | undefined): JSDocTagInfo[];
}
}
@ -83,8 +83,8 @@ declare module "../compiler/types" {
getNumberIndexType(): Type | undefined;
getBaseTypes(): BaseType[] | undefined;
getNonNullableType(): Type;
/*@internal*/ getNonOptionalType(): Type;
/*@internal*/ isNullableType(): boolean;
/** @internal */ getNonOptionalType(): Type;
/** @internal */ isNullableType(): boolean;
getConstraint(): Type | undefined;
getDefault(): Type | undefined;
@ -124,11 +124,11 @@ declare module "../compiler/types" {
declare module "../compiler/types" {
// Module transform: converted from interface augmentation
export interface SourceFile {
/* @internal */ version: string;
/* @internal */ scriptSnapshot: IScriptSnapshot | undefined;
/* @internal */ nameTable: UnderscoreEscapedMap<number> | undefined;
/** @internal */ version: string;
/** @internal */ scriptSnapshot: IScriptSnapshot | undefined;
/** @internal */ nameTable: UnderscoreEscapedMap<number> | undefined;
/* @internal */ getNamedDeclarations(): ESMap<string, readonly Declaration[]>;
/** @internal */ getNamedDeclarations(): ESMap<string, readonly Declaration[]>;
getLineAndCharacterOfPosition(pos: number): LineAndCharacter;
getLineEndOfPosition(pos: number): number;
@ -136,7 +136,7 @@ declare module "../compiler/types" {
getPositionOfLineAndCharacter(line: number, character: number): number;
update(newText: string, textChangeRange: TextChangeRange): SourceFile;
/* @internal */ sourceMapper?: DocumentPositionMapper;
/** @internal */ sourceMapper?: DocumentPositionMapper;
}
}
@ -226,7 +226,7 @@ export interface InstallPackageOptions {
packageName: string;
}
/* @internal */
/** @internal */
export const enum PackageJsonDependencyGroup {
Dependencies = 1 << 0,
DevDependencies = 1 << 1,
@ -235,7 +235,7 @@ export const enum PackageJsonDependencyGroup {
All = Dependencies | DevDependencies | PeerDependencies | OptionalDependencies,
}
/* @internal */
/** @internal */
export interface ProjectPackageJsonInfo {
fileName: string;
parseable: boolean;
@ -247,12 +247,12 @@ export interface ProjectPackageJsonInfo {
has(dependencyName: string, inGroups?: PackageJsonDependencyGroup): boolean;
}
/* @internal */
/** @internal */
export interface FormattingHost {
getNewLine?(): string;
}
/* @internal */
/** @internal */
export const enum PackageJsonAutoImportPreference {
Off,
On,
@ -326,12 +326,12 @@ export interface LanguageServiceHost extends GetEffectiveTypeRootsHost, MinimalR
resolveModuleNames?(moduleNames: string[], containingFile: string, reusedNames: string[] | undefined, redirectedReference: ResolvedProjectReference | undefined, options: CompilerOptions, containingSourceFile?: SourceFile, resolutionInfo?: ModuleResolutionInfo): (ResolvedModule | undefined)[];
getResolvedModuleWithFailedLookupLocationsFromCache?(modulename: string, containingFile: string, resolutionMode?: ModuleKind.CommonJS | ModuleKind.ESNext): ResolvedModuleWithFailedLookupLocations | undefined;
resolveTypeReferenceDirectives?(typeDirectiveNames: string[] | FileReference[], containingFile: string, redirectedReference: ResolvedProjectReference | undefined, options: CompilerOptions, containingFileMode?: SourceFile["impliedNodeFormat"] | undefined): (ResolvedTypeReferenceDirective | undefined)[];
/* @internal */ hasInvalidatedResolutions?: HasInvalidatedResolutions;
/* @internal */ hasChangedAutomaticTypeDirectiveNames?: HasChangedAutomaticTypeDirectiveNames;
/* @internal */ getGlobalTypingsCacheLocation?(): string | undefined;
/* @internal */ getSymlinkCache?(files?: readonly SourceFile[]): SymlinkCache;
/** @internal */ hasInvalidatedResolutions?: HasInvalidatedResolutions;
/** @internal */ hasChangedAutomaticTypeDirectiveNames?: HasChangedAutomaticTypeDirectiveNames;
/** @internal */ getGlobalTypingsCacheLocation?(): string | undefined;
/** @internal */ getSymlinkCache?(files?: readonly SourceFile[]): SymlinkCache;
/* Lets the Program from a AutoImportProviderProject use its host project's ModuleResolutionCache */
/* @internal */ getModuleResolutionCache?(): ModuleResolutionCache | undefined;
/** @internal */ getModuleResolutionCache?(): ModuleResolutionCache | undefined;
/*
* Required for full import and type reference completions.
@ -348,23 +348,23 @@ export interface LanguageServiceHost extends GetEffectiveTypeRootsHost, MinimalR
installPackage?(options: InstallPackageOptions): Promise<ApplyCodeActionCommandResult>;
writeFile?(fileName: string, content: string): void;
/* @internal */ getDocumentPositionMapper?(generatedFileName: string, sourceFileName?: string): DocumentPositionMapper | undefined;
/* @internal */ getSourceFileLike?(fileName: string): SourceFileLike | undefined;
/* @internal */ getPackageJsonsVisibleToFile?(fileName: string, rootDir?: string): readonly ProjectPackageJsonInfo[];
/* @internal */ getNearestAncestorDirectoryWithPackageJson?(fileName: string): string | undefined;
/* @internal */ getPackageJsonsForAutoImport?(rootDir?: string): readonly ProjectPackageJsonInfo[];
/* @internal */ getCachedExportInfoMap?(): ExportInfoMap;
/* @internal */ getModuleSpecifierCache?(): ModuleSpecifierCache;
/* @internal */ setCompilerHost?(host: CompilerHost): void;
/* @internal */ useSourceOfProjectReferenceRedirect?(): boolean;
/* @internal */ getPackageJsonAutoImportProvider?(): Program | undefined;
/* @internal */ sendPerformanceEvent?(kind: PerformanceEvent["kind"], durationMs: number): void;
/** @internal */ getDocumentPositionMapper?(generatedFileName: string, sourceFileName?: string): DocumentPositionMapper | undefined;
/** @internal */ getSourceFileLike?(fileName: string): SourceFileLike | undefined;
/** @internal */ getPackageJsonsVisibleToFile?(fileName: string, rootDir?: string): readonly ProjectPackageJsonInfo[];
/** @internal */ getNearestAncestorDirectoryWithPackageJson?(fileName: string): string | undefined;
/** @internal */ getPackageJsonsForAutoImport?(rootDir?: string): readonly ProjectPackageJsonInfo[];
/** @internal */ getCachedExportInfoMap?(): ExportInfoMap;
/** @internal */ getModuleSpecifierCache?(): ModuleSpecifierCache;
/** @internal */ setCompilerHost?(host: CompilerHost): void;
/** @internal */ useSourceOfProjectReferenceRedirect?(): boolean;
/** @internal */ getPackageJsonAutoImportProvider?(): Program | undefined;
/** @internal */ sendPerformanceEvent?(kind: PerformanceEvent["kind"], durationMs: number): void;
getParsedCommandLine?(fileName: string): ParsedCommandLine | undefined;
/* @internal */ onReleaseParsedCommandLine?(configFileName: string, oldResolvedRef: ResolvedProjectReference | undefined, optionOptions: CompilerOptions): void;
/* @internal */ getIncompleteCompletionsCache?(): IncompleteCompletionsCache;
/** @internal */ onReleaseParsedCommandLine?(configFileName: string, oldResolvedRef: ResolvedProjectReference | undefined, optionOptions: CompilerOptions): void;
/** @internal */ getIncompleteCompletionsCache?(): IncompleteCompletionsCache;
}
/* @internal */
/** @internal */
export const emptyOptions = {};
export type WithMetadata<T> = T & { metadata?: unknown; };
@ -514,10 +514,10 @@ export interface LanguageService {
getSmartSelectionRange(fileName: string, position: number): SelectionRange;
/*@internal*/
/** @internal */
// eslint-disable-next-line @typescript-eslint/unified-signatures
getDefinitionAtPosition(fileName: string, position: number, searchOtherFilesOnly: false, stopAtAlias: boolean): readonly DefinitionInfo[] | undefined;
/*@internal*/
/** @internal */
// eslint-disable-next-line @typescript-eslint/unified-signatures
getDefinitionAtPosition(fileName: string, position: number, searchOtherFilesOnly: boolean, stopAtAlias: false): readonly DefinitionInfo[] | undefined;
getDefinitionAtPosition(fileName: string, position: number): readonly DefinitionInfo[] | undefined;
@ -590,15 +590,15 @@ export interface LanguageService {
getEmitOutput(fileName: string, emitOnlyDtsFiles?: boolean, forceDtsEmit?: boolean): EmitOutput;
getProgram(): Program | undefined;
/*@internal*/ getCurrentProgram(): Program | undefined;
/** @internal */ getCurrentProgram(): Program | undefined;
/* @internal */ getNonBoundSourceFile(fileName: string): SourceFile;
/* @internal */ getAutoImportProvider(): Program | undefined;
/** @internal */ getNonBoundSourceFile(fileName: string): SourceFile;
/** @internal */ getAutoImportProvider(): Program | undefined;
/// Returns true if a suitable symbol was found in the project.
/// May set isDefinition properties in `referencedSymbols` to false.
/// May add elements to `knownSymbolSpans`.
/* @internal */ updateIsDefinitionOfReferencedSymbols(referencedSymbols: readonly ReferencedSymbol[], knownSymbolSpans: Set<DocumentSpan>): boolean;
/** @internal */ updateIsDefinitionOfReferencedSymbols(referencedSymbols: readonly ReferencedSymbol[], knownSymbolSpans: Set<DocumentSpan>): boolean;
toggleLineComment(fileName: string, textRange: TextRange): TextChange[];
toggleMultilineComment(fileName: string, textRange: TextRange): TextChange[];
@ -844,9 +844,9 @@ export interface CombinedCodeActions {
export type CodeActionCommand = InstallPackageAction;
export interface InstallPackageAction {
/* @internal */ readonly type: "install package";
/* @internal */ readonly file: string;
/* @internal */ readonly packageName: string;
/** @internal */ readonly type: "install package";
/** @internal */ readonly file: string;
/** @internal */ readonly packageName: string;
}
/**
@ -1084,7 +1084,7 @@ export function getDefaultFormatCodeSettings(newLineCharacter?: string): FormatC
};
}
/* @internal */
/** @internal */
export const testFormatSettings = getDefaultFormatCodeSettings("\n");
export interface DefinitionInfo extends DocumentSpan {
@ -1099,8 +1099,8 @@ export interface DefinitionInfo extends DocumentSpan {
* may be "incomplete" if this span has yet to be checked.
*/
isLocal?: boolean;
/* @internal */ isAmbient?: boolean;
/* @internal */ failedAliasResolution?: boolean;
/** @internal */ isAmbient?: boolean;
/** @internal */ failedAliasResolution?: boolean;
}
export interface DefinitionInfoAndBoundSpan {

98
src/services/utilities.ts
View File

@ -60,7 +60,7 @@ import {
unescapeLeadingUnderscores, UserPreferences, VariableDeclaration, visitEachChild, VoidExpression, YieldExpression,
} from "./_namespaces/ts";
/* @internal */ // Don't expose that we use this
/** @internal */ // Don't expose that we use this
// Based on lib.es6.d.ts
declare global {
// Module transform: converted from ambient declaration
@ -71,7 +71,7 @@ declare global {
all<T>(values: (T | PromiseLike<T>)[]): Promise<T[]>;
}
}
/* @internal */
/** @internal */
declare global {
// Module transform: converted from ambient declaration
/** @internal */
@ -640,9 +640,10 @@ export function startEndOverlapsWithStartEnd(start1: number, end1: number, start
return start < end;
}
/** @internal */
/**
* Assumes `candidate.start <= position` holds.
*
* @internal
*/
export function positionBelongsToNode(candidate: Node, position: number, sourceFile: SourceFile): boolean {
Debug.assert(candidate.pos <= position);
@ -1196,43 +1197,50 @@ function getAdjustedLocation(node: Node, forRename: boolean): Node {
return node;
}
/** @internal */
/**
* Adjusts the location used for "find references" and "go to definition" when the cursor was not
* on a property name.
*
* @internal
*/
export function getAdjustedReferenceLocation(node: Node): Node {
return getAdjustedLocation(node, /*forRename*/ false);
}
/** @internal */
/**
* Adjusts the location used for "rename" when the cursor was not on a property name.
*
* @internal
*/
export function getAdjustedRenameLocation(node: Node): Node {
return getAdjustedLocation(node, /*forRename*/ true);
}
/** @internal */
/**
* Gets the token whose text has range [start, end) and
* position >= start and (position < end or (position === end && token is literal or keyword or identifier))
*
* @internal
*/
export function getTouchingPropertyName(sourceFile: SourceFile, position: number): Node {
return getTouchingToken(sourceFile, position, n => isPropertyNameLiteral(n) || isKeyword(n.kind) || isPrivateIdentifier(n));
}
/** @internal */
/**
* Returns the token if position is in [start, end).
* If position === end, returns the preceding token if includeItemAtEndPosition(previousToken) === true
*
* @internal
*/
export function getTouchingToken(sourceFile: SourceFile, position: number, includePrecedingTokenAtEndPosition?: (n: Node) => boolean): Node {
return getTokenAtPositionWorker(sourceFile, position, /*allowPositionInLeadingTrivia*/ false, includePrecedingTokenAtEndPosition, /*includeEndPosition*/ false);
}
/** @internal */
/** Returns a token if position is in [start-of-leading-trivia, end) */
/**
* Returns a token if position is in [start-of-leading-trivia, end)
*
* @internal
*/
export function getTokenAtPosition(sourceFile: SourceFile, position: number): Node {
return getTokenAtPositionWorker(sourceFile, position, /*allowPositionInLeadingTrivia*/ true, /*includePrecedingTokenAtEndPosition*/ undefined, /*includeEndPosition*/ false);
}
@ -1333,10 +1341,11 @@ function getTokenAtPositionWorker(sourceFile: SourceFile, position: number, allo
}
}
/** @internal */
/**
* Returns the first token where position is in [start, end),
* excluding `JsxText` tokens containing only whitespace.
*
* @internal
*/
export function findFirstNonJsxWhitespaceToken(sourceFile: SourceFile, position: number): Node | undefined {
let tokenAtPosition = getTokenAtPosition(sourceFile, position);
@ -1348,7 +1357,6 @@ export function findFirstNonJsxWhitespaceToken(sourceFile: SourceFile, position:
return tokenAtPosition;
}
/** @internal */
/**
* The token on the left of the position is the token that strictly includes the position
* or sits to the left of the cursor if it is on a boundary. For example
@ -1356,6 +1364,8 @@ export function findFirstNonJsxWhitespaceToken(sourceFile: SourceFile, position:
* fo|o -> will return foo
* foo <comment> |bar -> will return foo
*
*
* @internal
*/
export function findTokenOnLeftOfPosition(file: SourceFile, position: number): Node | undefined {
// Ideally, getTokenAtPosition should return a token. However, it is currently
@ -1388,10 +1398,11 @@ export function findNextToken(previousToken: Node, parent: Node, sourceFile: Sou
}
}
/** @internal */
/**
* Finds the rightmost token satisfying `token.end <= position`,
* excluding `JsxText` tokens containing only whitespace.
*
* @internal
*/
export function findPrecedingToken(position: number, sourceFile: SourceFileLike, startNode: Node, excludeJsdoc?: boolean): Node | undefined;
/** @internal */
@ -1517,9 +1528,9 @@ export function isInString(sourceFile: SourceFile, position: number, previousTok
return false;
}
/** @internal */
/**
* returns true if the position is in between the open and close elements of an JSX expression.
*
* @internal
*/
export function isInsideJsxElementOrAttribute(sourceFile: SourceFile, position: number) {
const token = getTokenAtPosition(sourceFile, position);
@ -1795,12 +1806,13 @@ export function getPossibleTypeArgumentsInfo(tokenIn: Node | undefined, sourceFi
return undefined;
}
/** @internal */
/**
* Returns true if the cursor at position in sourceFile is within a comment.
*
* @param tokenAtPosition Must equal `getTokenAtPosition(sourceFile, position)`
* @param predicate Additional predicate to test on the comment range.
*
* @internal
*/
export function isInComment(sourceFile: SourceFile, position: number, tokenAtPosition?: Node): CommentRange | undefined {
return formatting.getRangeOfEnclosingComment(sourceFile, position, /*precedingToken*/ undefined, tokenAtPosition);
@ -2029,14 +2041,20 @@ export function isTypeKeywordTokenOrIdentifier(node: Node) {
return isTypeKeywordToken(node) || isIdentifier(node) && node.text === "type";
}
/** @internal */
/** True if the symbol is for an external module, as opposed to a namespace. */
/**
* True if the symbol is for an external module, as opposed to a namespace.
*
* @internal
*/
export function isExternalModuleSymbol(moduleSymbol: Symbol): boolean {
return !!(moduleSymbol.flags & SymbolFlags.Module) && moduleSymbol.name.charCodeAt(0) === CharacterCodes.doubleQuote;
}
/** @internal */
/** Returns `true` the first time it encounters a node and `false` afterwards. */
/**
* Returns `true` the first time it encounters a node and `false` afterwards.
*
* @internal
*/
export type NodeSeenTracker<T = Node> = (node: T) => boolean;
/** @internal */
export function nodeSeenTracker<T extends Node>(): NodeSeenTracker<T> {
@ -2294,11 +2312,12 @@ export function documentSpansEqual(a: DocumentSpan, b: DocumentSpan): boolean {
return a.fileName === b.fileName && textSpansEqual(a.textSpan, b.textSpan);
}
/** @internal */
/**
* Iterates through 'array' by index and performs the callback on each element of array until the callback
* returns a truthy value, then returns that value.
* If no such value is found, the callback is applied to each element of array and undefined is returned.
*
* @internal
*/
export function forEachUnique<T, U>(array: readonly T[] | undefined, callback: (element: T, index: number) => U): U | undefined {
if (array) {
@ -2635,9 +2654,10 @@ function findLinkNameEnd(text: string) {
}
const carriageReturnLineFeed = "\r\n";
/** @internal */
/**
* The default is CRLF.
*
* @internal
*/
export function getNewLineOrDefaultFromHost(host: FormattingHost, formatSettings?: FormatCodeSettings) {
return formatSettings?.newLineCharacter ||
@ -2747,12 +2767,13 @@ export function getPrecedingNonSpaceCharacterPosition(text: string, position: nu
return position + 1;
}
/** @internal */
/**
* Creates a deep, memberwise clone of a node with no source map location.
*
* WARNING: This is an expensive operation and is only intended to be used in refactorings
* and code fixes (because those are triggered by explicit user actions).
*
* @internal
*/
export function getSynthesizedDeepClone<T extends Node | undefined>(node: T, includeTrivia = true): T {
const clone = node && getSynthesizedDeepCloneWorker(node);
@ -2822,26 +2843,29 @@ export function getSynthesizedDeepClonesWithReplacements<T extends Node>(
return factory.createNodeArray(nodes.map(n => getSynthesizedDeepCloneWithReplacements(n, includeTrivia, replaceNode)), nodes.hasTrailingComma);
}
/** @internal */
/**
* Sets EmitFlags to suppress leading and trailing trivia on the node.
*
* @internal
*/
export function suppressLeadingAndTrailingTrivia(node: Node) {
suppressLeadingTrivia(node);
suppressTrailingTrivia(node);
}
/** @internal */
/**
* Sets EmitFlags to suppress leading trivia on the node.
*
* @internal
*/
export function suppressLeadingTrivia(node: Node) {
addEmitFlagsRecursively(node, EmitFlags.NoLeadingComments, getFirstChild);
}
/** @internal */
/**
* Sets EmitFlags to suppress trailing trivia on the node.
*
* @internal
*/
export function suppressTrailingTrivia(node: Node) {
addEmitFlagsRecursively(node, EmitFlags.NoTrailingComments, getLastChild);
@ -2888,11 +2912,12 @@ export function getUniqueName(baseName: string, sourceFile: SourceFile): string
return nameText;
}
/** @internal */
/**
* @return The index of the (only) reference to the extracted symbol. We want the cursor
* to be on the reference, rather than the declaration, because it's closer to where the
* user was before extracting it.
*
* @internal
*/
export function getRenameLocation(edits: readonly FileTextChanges[], renameFilename: string, name: string, preferLastLocation: boolean): number {
let delta = 0;
@ -2931,13 +2956,14 @@ export function copyTrailingComments(sourceNode: Node, targetNode: Node, sourceF
forEachTrailingCommentRange(sourceFile.text, sourceNode.end, getAddCommentsFunction(targetNode, sourceFile, commentKind, hasTrailingNewLine, addSyntheticTrailingComment));
}
/** @internal */
/**
* This function copies the trailing comments for the token that comes before `sourceNode`, as leading comments of `targetNode`.
* This is useful because sometimes a comment that refers to `sourceNode` will be a leading comment for `sourceNode`, according to the
* notion of trivia ownership, and instead will be a trailing comment for the token before `sourceNode`, e.g.:
* `function foo(\* not leading comment for a *\ a: string) {}`
* The comment refers to `a` but belongs to the `(` token, but we might want to copy it.
*
* @internal
*/
export function copyTrailingAsLeadingComments(sourceNode: Node, targetNode: Node, sourceFile: SourceFile, commentKind?: CommentKind, hasTrailingNewLine?: boolean) {
forEachTrailingCommentRange(sourceFile.text, sourceNode.pos, getAddCommentsFunction(targetNode, sourceFile, commentKind, hasTrailingNewLine, addSyntheticLeadingComment));
@ -2968,7 +2994,7 @@ function indexInTextChange(change: string, name: string): number {
return idx === -1 ? -1 : idx + 1;
}
/* @internal */
/** @internal */
export function needsParentheses(expression: Expression): boolean {
return isBinaryExpression(expression) && expression.operatorToken.kind === SyntaxKind.CommaToken
|| isObjectLiteralExpression(expression)
@ -3528,12 +3554,12 @@ export function getDiagnosticsWithinSpan(span: TextSpan, sortedFileDiagnostics:
return result;
}
/* @internal */
/** @internal */
export function getRefactorContextSpan({ startPosition, endPosition }: RefactorContext): TextSpan {
return createTextSpanFromBounds(startPosition, endPosition === undefined ? startPosition : endPosition);
}
/* @internal */
/** @internal */
export function getFixableErrorSpanExpression(sourceFile: SourceFile, span: TextSpan): Expression | undefined {
const token = getTokenAtPosition(sourceFile, span.start);
// Checker has already done work to determine that await might be possible, and has attached
@ -3549,10 +3575,11 @@ export function getFixableErrorSpanExpression(sourceFile: SourceFile, span: Text
return expression;
}
/** @internal */
/**
* If the provided value is an array, the mapping function is applied to each element; otherwise, the mapping function is applied
* to the provided value itself.
*
* @internal
*/
export function mapOneOrMany<T, U>(valueOrArray: T | readonly T[], f: (x: T, i: number) => U): U | U[];
/** @internal */
@ -3566,9 +3593,10 @@ export function mapOneOrMany<T, U>(valueOrArray: T | readonly T[] | undefined, f
return valueOrArray ? isArray(valueOrArray) ? resultSelector(map(valueOrArray, f)) : f(valueOrArray, 0) : undefined;
}
/** @internal */
/**
* If the provided value is an array, the first element of the array is returned; otherwise, the provided value is returned instead.
*
* @internal
*/
export function firstOrOnly<T>(valueOrArray: T | readonly T[]): T {
return isArray(valueOrArray) ? first(valueOrArray) : valueOrArray;
@ -3618,7 +3646,6 @@ function getSymbolParentOrFail(symbol: Symbol) {
}).join(", ")}.`);
}
/** @internal */
/**
* Useful to check whether a string contains another string at a specific index
* without allocating another string or traversing the entire contents of the outer string.
@ -3636,6 +3663,8 @@ function getSymbolParentOrFail(symbol: Symbol) {
* @param haystack The string that potentially contains `needle`.
* @param needle The string whose content might sit within `haystack`.
* @param startIndex The index within `haystack` to start searching for `needle`.
*
* @internal
*/
export function stringContainsAt(haystack: string, needle: string, startIndex: number) {
const needleLength = needle.length;
@ -3698,9 +3727,10 @@ export function diagnosticToString(diag: DiagnosticAndArguments): string {
: getLocaleSpecificMessage(diag);
}
/** @internal */
/**
* Get format code settings for a code writing context (e.g. when formatting text changes or completions code).
*
* @internal
*/
export function getFormatCodeSettingsForWriting({ options }: formatting.FormatContext, sourceFile: SourceFile): FormatCodeSettings {
const shouldAutoDetectSemicolonPreference = !options.semicolons || options.semicolons === SemicolonPreference.Ignore;

8
src/typingsInstallerCore/typingsInstaller.ts
View File

@ -42,7 +42,7 @@ function typingToFileName(cachePath: string, packageName: string, installTypingH
}
}
/*@internal*/
/** @internal */
export function installNpmPackages(npmPath: string, tsVersion: string, packageNames: string[], install: (command: string) => boolean) {
let hasError = false;
for (let remaining = packageNames.length; remaining > 0;) {
@ -53,7 +53,7 @@ export function installNpmPackages(npmPath: string, tsVersion: string, packageNa
return hasError;
}
/*@internal*/
/** @internal */
export function getNpmCommandForInstallation(npmPath: string, tsVersion: string, packageNames: string[], remaining: number) {
const sliceStart = packageNames.length - remaining;
let command: string, toSlice = remaining;
@ -116,7 +116,7 @@ export abstract class TypingsInstaller {
private inFlightRequestCount = 0;
abstract readonly typesRegistry: ESMap<string, MapLike<string>>;
/*@internal*/
/** @internal */
private readonly watchFactory: WatchFactory<string, ProjectWatchers>;
constructor(
@ -551,7 +551,7 @@ export abstract class TypingsInstaller {
protected readonly latestDistTag = "latest";
}
/* @internal */
/** @internal */
export function typingsName(packageName: string): string {
return `@types/${packageName}@ts${versionMajorMinor}`;
}

2
src/webServer/webServer.ts
View File

@ -226,7 +226,7 @@ export function createWebSystem(host: WebHost, args: string[], getExecutingFileP
// createSHA256Hash // telemetry of the project
// Logging related
// /*@internal*/ bufferFrom?(input: string, encoding?: string): Buffer;
// /** @internal */ bufferFrom?(input: string, encoding?: string): Buffer;
// gc?(): void;
// getMemoryUsage?(): number;
};