@zzzen/pyright-internal 1.1.254

package/dist/common/pathUtils.d.ts

@@ -0,0 +1,170 @@
+/// <reference types="node" />
+import type { Dirent } from 'fs';
+import { Comparison, GetCanonicalFileName } from './core';
+import { FileSystem, Stats } from './fileSystem';
+export interface FileSpec {
+    wildcardRoot: string;
+    regExp: RegExp;
+}
+export declare namespace FileSpec {
+    function is(value: any): value is FileSpec;
+}
+export interface FileSystemEntries {
+    files: string[];
+    directories: string[];
+}
+export declare function forEachAncestorDirectory(directory: string, callback: (directory: string) => string | undefined): string | undefined;
+export declare function getDirectoryPath(pathString: string): string;
+export declare function getRootLength(pathString: string): number;
+export declare function getPathComponents(pathString: string): string[];
+export declare function reducePathComponents(components: readonly string[]): string[];
+export declare function combinePathComponents(components: string[]): string;
+export declare function getRelativePath(dirPath: string, relativeTo: string): string | undefined;
+export declare function makeDirectories(fs: FileSystem, dirPath: string, startingFromDirPath: string): void;
+export declare function getFileSize(fs: FileSystem, path: string): number;
+export declare function fileExists(fs: FileSystem, path: string): boolean;
+export declare function directoryExists(fs: FileSystem, path: string): boolean;
+export declare function normalizeSlashes(pathString: string, sep?: string): string;
+/**
+ * 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.
+ *
+ * ```ts
+ * resolvePath("/path", "to", "file.ext") === "path/to/file.ext"
+ * resolvePath("/path", "to", "file.ext/") === "path/to/file.ext/"
+ * resolvePath("/path", "dir", "..", "to", "file.ext") === "path/to/file.ext"
+ * ```
+ */
+export declare function resolvePaths(path: string, ...paths: (string | undefined)[]): string;
+export declare function combinePaths(pathString: string, ...paths: (string | undefined)[]): string;
+/**
+ * Compare two paths using the provided case sensitivity.
+ */
+export declare function comparePaths(a: string, b: string, ignoreCase?: boolean): Comparison;
+export declare function comparePaths(a: string, b: string, currentDirectory: string, ignoreCase?: boolean): Comparison;
+/**
+ * Determines whether a `parent` path contains a `child` path using the provide case sensitivity.
+ */
+export declare function containsPath(parent: string, child: string, ignoreCase?: boolean): boolean;
+export declare function containsPath(parent: string, child: string, currentDirectory: string, ignoreCase?: boolean): boolean;
+/**
+ * Changes the extension of a path to the provided extension.
+ *
+ * ```ts
+ * changeAnyExtension("/path/to/file.ext", ".js") === "/path/to/file.js"
+ * ```
+ */
+export declare function changeAnyExtension(path: string, ext: string): string;
+/**
+ * Changes the extension of a path to the provided extension if it has one of the provided extensions.
+ *
+ * ```ts
+ * changeAnyExtension("/path/to/file.ext", ".js", ".ext") === "/path/to/file.js"
+ * changeAnyExtension("/path/to/file.ext", ".js", ".ts") === "/path/to/file.ext"
+ * changeAnyExtension("/path/to/file.ext", ".js", [".ext", ".ts"]) === "/path/to/file.js"
+ * ```
+ */
+export declare function changeAnyExtension(path: string, ext: string, extensions: string | readonly string[], ignoreCase: boolean): string;
+/**
+ * Gets the file extension for a path.
+ *
+ * ```ts
+ * getAnyExtensionFromPath("/path/to/file.ext") === ".ext"
+ * getAnyExtensionFromPath("/path/to/file.ext/") === ".ext"
+ * getAnyExtensionFromPath("/path/to/file") === ""
+ * getAnyExtensionFromPath("/path/to.ext/file") === ""
+ * ```
+ */
+export declare function getAnyExtensionFromPath(path: string): string;
+/**
+ * Gets the file extension for a path, provided it is one of the provided extensions.
+ *
+ * ```ts
+ * getAnyExtensionFromPath("/path/to/file.ext", ".ext", true) === ".ext"
+ * getAnyExtensionFromPath("/path/to/file.js", ".ext", true) === ""
+ * getAnyExtensionFromPath("/path/to/file.js", [".ext", ".js"], true) === ".js"
+ * getAnyExtensionFromPath("/path/to/file.ext", ".EXT", false) === ""
+ */
+export declare function getAnyExtensionFromPath(path: string, extensions: string | readonly string[], ignoreCase: boolean): string;
+/**
+ * Returns the path except for its containing directory name.
+ * Semantics align with NodeJS's `path.basename` except that we support URLs as well.
+ *
+ * ```ts
+ * // POSIX
+ * getBaseFileName("/path/to/file.ext") === "file.ext"
+ * getBaseFileName("/path/to/") === "to"
+ * getBaseFileName("/") === ""
+ * // DOS
+ * getBaseFileName("c:/path/to/file.ext") === "file.ext"
+ * getBaseFileName("c:/path/to/") === "to"
+ * getBaseFileName("c:/") === ""
+ * getBaseFileName("c:") === ""
+ * ```
+ */
+export declare function getBaseFileName(pathString: string): string;
+/**
+ * Gets the portion of a path following the last (non-terminal) separator (`/`).
+ * Semantics align with NodeJS's `path.basename` except that we support URLs as well.
+ * If the base name has any one of the provided extensions, it is removed.
+ *
+ * ```ts
+ * getBaseFileName("/path/to/file.ext", ".ext", true) === "file"
+ * getBaseFileName("/path/to/file.js", ".ext", true) === "file.js"
+ * getBaseFileName("/path/to/file.js", [".ext", ".js"], true) === "file"
+ * getBaseFileName("/path/to/file.ext", ".EXT", false) === "file.ext"
+ * ```
+ */
+export declare function getBaseFileName(pathString: string, extensions: string | readonly string[], ignoreCase: boolean): string;
+/**
+ * Gets a relative path that can be used to traverse between `from` and `to`.
+ */
+export declare function getRelativePathFromDirectory(from: string, to: string, ignoreCase: boolean): string;
+/**
+ * Gets a relative path that can be used to traverse between `from` and `to`.
+ */
+export declare function getRelativePathFromDirectory(fromDirectory: string, to: string, getCanonicalFileName: GetCanonicalFileName): string;
+export declare function getRelativePathComponentsFromDirectory(fromDirectory: string, to: string, getCanonicalFileNameOrIgnoreCase: GetCanonicalFileName | boolean): string[];
+/**
+ * Performs a case-sensitive comparison of two paths. Path roots are always compared case-insensitively.
+ */
+export declare function comparePathsCaseSensitive(a: string, b: string): Comparison;
+/**
+ * Performs a case-insensitive comparison of two paths.
+ */
+export declare function comparePathsCaseInsensitive(a: string, b: string): Comparison;
+export declare function ensureTrailingDirectorySeparator(pathString: string): string;
+export declare function hasTrailingDirectorySeparator(pathString: string): boolean;
+export declare function stripTrailingDirectorySeparator(pathString: string): string;
+export declare function getFileExtension(fileName: string, multiDotExtension?: boolean): string;
+export declare function getFileName(pathString: string): string;
+export declare function stripFileExtension(fileName: string, multiDotExtension?: boolean): string;
+export declare function normalizePath(pathString: string): string;
+export declare function isDirectory(fs: FileSystem, path: string): boolean;
+export declare function isFile(fs: FileSystem, path: string, treatZipDirectoryAsFile?: boolean): boolean;
+export declare function tryStat(fs: FileSystem, path: string): Stats | undefined;
+export declare function tryRealpath(fs: FileSystem, path: string): string | undefined;
+export declare function getFileSystemEntries(fs: FileSystem, path: string): FileSystemEntries;
+export declare function getFileSystemEntriesFromDirEntries(dirEntries: Dirent[], fs: FileSystem, path: string): FileSystemEntries;
+export declare function getWildcardRegexPattern(rootPath: string, fileSpec: string): string;
+export declare function getWildcardRoot(rootPath: string, fileSpec: string): string;
+export declare function hasPythonExtension(path: string): boolean;
+export declare function getFileSpec(fs: FileSystem, rootPath: string, fileSpec: string): FileSpec;
+export declare function getRegexEscapedSeparator(): "/" | "\\\\";
+/**
+ * Determines whether a path is an absolute disk path (e.g. starts with `/`, or a dos path
+ * like `c:`, `c:\` or `c:/`).
+ */
+export declare function isRootedDiskPath(path: string): boolean;
+/**
+ * Determines whether a path consists only of a path root.
+ */
+export declare function isDiskPathRoot(path: string): boolean;
+export declare function convertUriToPath(fs: FileSystem, uriString: string): string;
+export declare function extractPathFromUri(uriString: string): string;
+export declare function convertPathToUri(fs: FileSystem, path: string): string;
+export declare function normalizePathCase(fs: FileSystem, path: string): string;
+export declare function isFileSystemCaseSensitive(fs: FileSystem): boolean;
+export declare function isFileSystemCaseSensitiveInternal(fs: FileSystem): boolean;
+export declare function getLibraryPathWithoutExtension(libraryFilePath: string): string;
+export declare function getDirectoryChangeKind(fs: FileSystem, oldDirectory: string, newDirectory: string): 'Same' | 'Renamed' | 'Moved';