Function getDisplayPath

src/platform/common/platform/fs-paths.ts:45–86

(
    filename: Uri | string | undefined,
    workspaceFolders: readonly WorkspaceFolder[] | WorkspaceFolder[] = [],
    homePathUri?: Uri
)

}

export function getDisplayPath(
    filename: Uri | string | undefined,
    workspaceFolders: readonly WorkspaceFolder[] | WorkspaceFolder[] = [],
    homePathUri?: Uri
) {
    homePathUri = homePathUri || getHomeDir();
    let fileUri: Uri | undefined = undefined;
    if (typeof filename && typeof filename === 'string') {
        fileUri = Uri.file(filename);
    }
    if (typeof filename && typeof filename !== 'string') {
        fileUri = filename;
    }
    const relativeToHome = getDisplayPathImpl(fileUri, undefined, homePathUri);
    const workspaceFolderThatOwnsTheFile = workspaceFolders.find(
        (w) => fileUri && uriPath.isEqualOrParent(fileUri, w.uri, true)
    );
    // If there is more than one workspace folder, then we need to display the workspace folder name.
    // This is because we can have two files with the same name in different workspace folders.
    // E.g. .venv/bin/python can exist in multiple workspace folders.
    if (workspaceFolders.length > 1 && workspaceFolderThatOwnsTheFile) {
        return `${workspaceFolderThatOwnsTheFile.name}${path.sep}${getDisplayPathImpl(
            fileUri,
            workspaceFolderThatOwnsTheFile.uri,
            homePathUri
        )}`;
    }

    const relativeToWorkspaceFolders = workspaceFolderThatOwnsTheFile
        ? [getDisplayPathImpl(fileUri, workspaceFolderThatOwnsTheFile.uri, homePathUri)]
        : [];
    // Pick the shortest path for display purposes.
    // As those are most likely relative to some workspace folder.
    let bestDisplayPath = relativeToHome;
    [relativeToHome, ...relativeToWorkspaceFolders].forEach((relativePath) => {
        if (relativePath.length < bestDisplayPath.length) {
            bestDisplayPath = relativePath;
        }
    });

    return bestDisplayPath;
}

function getDisplayPathImpl(file: Uri | undefined, cwd: Uri | undefined, homePath: Uri | undefined): string {
    const isWindows = getOSType() === OSType.Windows;