1
>
/*---------------------------------------------------------------------------------------------
labels.ts
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import { hasDriveLetter, toSlashes } from './extpath.js';
7
>
import { posix, sep, win32 } from './path.js';
8
>
import { isMacintosh, isWindows, OperatingSystem, OS } from './platform.js';
9
>
import { extUri, extUriIgnorePathCase } from './resources.js';
10
>
import { rtrim, startsWithIgnoreCase } from './strings.js';
11
>
import { URI } from './uri.js';
12
>
13
>
export interface IPathLabelFormatting {
14
>
15
>
/**
16
>
* The OS the path label is from to produce a label
17
>
* that matches OS expectations.
18
>
*/
19
>
readonly os: OperatingSystem;
20
>
21
>
/**
22
>
* Whether to add a `~` when the path is in the
23
>
* user home directory.
24
>
*
25
>
* Note: this only applies to Linux, macOS but not
26
>
* Windows.
27
>
*/
28
>
readonly tildify?: IUserHomeProvider;
29
>
30
>
/**
31
>
* Whether to convert to a relative path if the path
32
>
* is within any of the opened workspace folders.
33
>
*/
34
>
readonly relative?: IRelativePathProvider;
35
>
}
36
>
37
>
export interface IRelativePathProvider {
38
>
39
>
/**
40
>
* Whether to not add a prefix when in multi-root workspace.
41
>
*/
42
>
readonly noPrefix?: boolean;
43
>
44
>
getWorkspace(): { folders: { uri: URI; name?: string }[] };
45
>
getWorkspaceFolder(resource: URI): { uri: URI; name?: string } | null;
46
>
}
47
>
48
>
export interface IUserHomeProvider {
49
>
userHome: URI;
50
>
}
51
>
52
>
export function getPathLabel(resource: URI, formatting: IPathLabelFormatting): string {
53
const { os, tildify: tildifier, relative: relatifier } = formatting;
54