tsc-ts 0.0.4 → 0.0.5

package/dist/api/compiler/path.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Path utilities with TypeScript's semantics.
+ *
+ * Paths use `/` as the separator. A root is `/`, `//server/`, `c:/`, `^/` or a URL prefix such as `file:///`.
+ */
+/** A normalized absolute path in canonical case, used as a map key. */
+export type Path = string & {
+    readonly __pathBrand: never;
+};
+export declare const supportedDeclarationExtensions: readonly string[];
+export declare const supportedTSImplementationExtensions: readonly string[];
+export declare const supportedJSExtensionsFlat: readonly string[];
+export declare const supportedTSExtensionsFlat: readonly string[];
+export declare const supportedTSExtensionsWithJsonFlat: readonly string[];
+export declare function normalizeSlashes(path: string): string;
+/** Root length of `path`, bitwise-negated (`~n`) for URLs and 0 for relative paths. */
+export declare function getEncodedRootLength(path: string): number;
+export declare function getRootLength(path: string): number;
+export declare function isUrl(path: string): boolean;
+/** True for `/x`, `c:/x` and other disk roots (not URLs). */
+export declare function isRootedDiskPath(path: string): boolean;
+export declare function pathIsAbsolute(path: string): boolean;
+/** True for `.`, `..`, and paths starting with `./` or `../`. */
+export declare function pathIsRelative(path: string): boolean;
+/** Relative module names and rooted paths are never looked up in `node_modules`. */
+export declare function isExternalModuleNameRelative(moduleName: string): boolean;
+export declare function hasTrailingDirectorySeparator(path: string): boolean;
+export declare function removeTrailingDirectorySeparator(path: string): string;
+export declare function removeTrailingDirectorySeparators(path: string): string;
+export declare function ensureTrailingDirectorySeparator(path: string): string;
+/** Joins `path` onto `base`; an absolute `path` replaces `base`. Does not resolve `.` or `..`. */
+export declare function combinePaths(base: string, path: string): string;
+/** Splits a path into its root followed by its segments, dropping a trailing empty segment. */
+export declare function getPathComponents(path: string, currentDirectory?: string): string[];
+/** Removes `.`, empty and resolvable `..` components. */
+export declare function reducePathComponents(components: readonly string[]): string[];
+export declare function getPathFromPathComponents(components: readonly string[]): string;
+/** The path without its last segment; a root is returned as is. */
+export declare function getDirectoryPath(path: string): string;
+/** The last segment of the path, or `''` for a root. */
+export declare function getBaseFileName(path: string): string;
+/** Resolves `fileName` against `currentDirectory` and removes `.`, `..` and duplicate separators. */
+export declare function getNormalizedAbsolutePath(fileName: string, currentDirectory: string): string;
+/** Removes `.`, `..` and duplicate separators, keeping a trailing separator. */
+export declare function normalizePath(path: string): string;
+/** Combines and normalizes, keeping a trailing separator. */
+export declare function resolvePath(base: string, path: string): string;
+/**
+ * Lower-cases a file name for case-insensitive comparison. `İ` (U+0130) is kept as is since its lower-case form is
+ * two characters.
+ */
+export declare function toFileNameLowerCase(fileName: string): string;
+export declare function getCanonicalFileName(fileName: string, useCaseSensitiveFileNames: boolean): string;
+export declare function toPath(fileName: string, basePath: string, useCaseSensitiveFileNames: boolean): Path;
+/** Compares strings by lower-cased code points. */
+export declare function compareStringsCaseInsensitive(a: string, b: string): number;
+export declare function equateStringsCaseInsensitive(a: string, b: string): boolean;
+/** Compares two paths after resolving them against `currentDirectory`. */
+export declare function comparePaths(a: string, b: string, useCaseSensitiveFileNames: boolean, currentDirectory?: string): number;
+/** Whether `child` is `parent` or inside it. */
+export declare function containsPath(parent: string, child: string, useCaseSensitiveFileNames: boolean, currentDirectory?: string): boolean;
+export declare function getPathComponentsRelativeTo(from: string, to: string, useCaseSensitiveFileNames: boolean, currentDirectory?: string): string[];
+/** The path from directory `from` to `to`; both must be absolute or both relative. */
+export declare function getRelativePathFromDirectory(from: string, to: string, useCaseSensitiveFileNames: boolean, currentDirectory?: string): string;
+/** The path from the directory of file `from` to `to`, prefixed with `./` unless absolute or dot-relative. */
+export declare function getRelativePathFromFile(from: string, to: string, useCaseSensitiveFileNames: boolean, currentDirectory?: string): string;
+/** Prefixes `./` to paths that would otherwise read as module names. */
+export declare function ensurePathIsNonModuleName(path: string): string;
+export declare function fileExtensionIs(path: string, extension: string): boolean;
+export declare function fileExtensionIsOneOf(path: string, extensions: readonly string[]): boolean;
+/** Whether `ext` is a TypeScript extension, including arbitrary `.d.*.ts` declaration extensions. */
+export declare function extensionIsTs(ext: string): boolean;
+/** Removes a known extension (including `.d.ts` forms). */
+export declare function removeFileExtension(path: string): string;
+/** The known extension of `path`, or `''`. */
+export declare function tryGetExtensionFromPath(path: string): string;
+export declare function removeExtension(path: string, extension: string): string;
+/** The TypeScript or declaration extension of `fileName`, or `''`. */
+export declare function tryExtractTSExtension(fileName: string): string;
+export declare function hasTSFileExtension(path: string): boolean;
+export declare function hasImplementationTSFileExtension(path: string): boolean;
+export declare function hasJSFileExtension(path: string): boolean;
+/** `.d.ts`, `.d.mts`, `.d.cts` or `.d.<ext>.ts` of the base name, or `''`. */
+export declare function getDeclarationFileExtension(fileName: string): string;
+export declare function isDeclarationFileName(fileName: string): boolean;
+/** The extension from the last `.` of the base name, or `''`. */
+export declare function getAnyExtensionFromPath(path: string): string;
+/** Replaces a known extension of `path` with `newExtension`. */
+export declare function changeExtension(path: string, newExtension: string): string;
+/** Source extensions that could have produced an output with the extension of `path`. */
+export declare function getPossibleOriginalInputExtensionForExtension(path: string): readonly string[];