label: getUriLabel get an option bag since it is cleaner

isidorn · isidorn · commit 2a263ba0d8cd · 2018-09-18T16:51:31.000+02:00
diff --git a/src/vs/editor/contrib/referenceSearch/referencesWidget.ts b/src/vs/editor/contrib/referenceSearch/referencesWidget.ts
@@ -318,7 +318,7 @@ class FileReferencesTemplate {
 
 	set(element: FileReferences) {
 		let parent = dirname(element.uri);
-		this.file.setValue(getBaseLabel(element.uri), parent ? this._uriLabel.getUriLabel(parent, true) : undefined, { title: this._uriLabel.getUriLabel(element.uri) });
+		this.file.setValue(getBaseLabel(element.uri), parent ? this._uriLabel.getUriLabel(parent, { relative: true }) : undefined, { title: this._uriLabel.getUriLabel(element.uri) });
 		const len = element.children.length;
 		this.badge.setCount(len);
 		if (element.failure) {
@@ -771,7 +771,7 @@ export class ReferenceWidget extends PeekViewWidget {
 
 		// Update widget header
 		if (reference.uri.scheme !== Schemas.inMemory) {
-			this.setTitle(basenameOrAuthority(reference.uri), this._uriLabel.getUriLabel(dirname(reference.uri), false));
+			this.setTitle(basenameOrAuthority(reference.uri), this._uriLabel.getUriLabel(dirname(reference.uri)));
 		} else {
 			this.setTitle(nls.localize('peekView.alternateTitle', "References"));
 		}
diff --git a/src/vs/editor/standalone/browser/simpleServices.ts b/src/vs/editor/standalone/browser/simpleServices.ts
@@ -602,7 +602,7 @@ export class SimpleUriLabelService implements ILabelService {
 	private readonly _onDidRegisterFormatter: Emitter<RegisterFormatterEvent> = new Emitter<RegisterFormatterEvent>();
 	public readonly onDidRegisterFormatter: Event<RegisterFormatterEvent> = this._onDidRegisterFormatter.event;
 
-	public getUriLabel(resource: URI, relative?: boolean): string {
+	public getUriLabel(resource: URI, options?: { relative?: boolean, forceNoTildify?: boolean }): string {
 		if (resource.scheme === 'file') {
 			return resource.fsPath;
 		}
diff --git a/src/vs/platform/label/common/label.ts b/src/vs/platform/label/common/label.ts
@@ -26,7 +26,7 @@ export interface RegisterFormatterEvent {
 
 export interface ILabelService {
 	_serviceBrand: any;
-	getUriLabel(resource: URI, relative?: boolean, forceNoTildify?: boolean): string;
+	getUriLabel(resource: URI, options?: { relative?: boolean, forceNoTildify?: boolean }): string;
 	getWorkspaceLabel(workspace: (IWorkspaceIdentifier | ISingleFolderWorkspaceIdentifier | IWorkspace), options?: { verbose: boolean }): string;
 	registerFormatter(schema: string, formatter: LabelRules): IDisposable;
 	onDidRegisterFormatter: Event<RegisterFormatterEvent>;
@@ -67,24 +67,24 @@ export class LabelService implements ILabelService {
 		return this._onDidRegisterFormatter.event;
 	}
 
-	getUriLabel(resource: URI, relative?: boolean, forceNoTildify?: boolean): string {
+	getUriLabel(resource: URI, options: { relative?: boolean, forceNoTildify?: boolean } = {}): string {
 		if (!resource) {
 			return undefined;
 		}
 		const formatter = this.formatters.get(resource.scheme);
 		if (!formatter) {
-			return getPathLabel(resource.path, this.environmentService, relative ? this.contextService : undefined);
+			return getPathLabel(resource.path, this.environmentService, options.relative ? this.contextService : undefined);
 		}
 
-		if (relative) {
+		if (options.relative) {
 			const baseResource = this.contextService && this.contextService.getWorkspaceFolder(resource);
 			if (baseResource) {
 				let relativeLabel: string;
 				if (isEqual(baseResource.uri, resource, !isLinux)) {
 					relativeLabel = ''; // no label if resources are identical
 				} else {
-					const baseResourceLabel = this.formatUri(baseResource.uri, formatter, forceNoTildify);
-					relativeLabel = ltrim(this.formatUri(resource, formatter, forceNoTildify).substring(baseResourceLabel.length), formatter.uri.separator);
+					const baseResourceLabel = this.formatUri(baseResource.uri, formatter, options.forceNoTildify);
+					relativeLabel = ltrim(this.formatUri(resource, formatter, options.forceNoTildify).substring(baseResourceLabel.length), formatter.uri.separator);
 				}
 
 				const hasMultipleRoots = this.contextService.getWorkspace().folders.length > 1;
@@ -97,7 +97,7 @@ export class LabelService implements ILabelService {
 			}
 		}
 
-		return this.formatUri(resource, formatter, forceNoTildify);
+		return this.formatUri(resource, formatter, options.forceNoTildify);
 	}
 
 	getWorkspaceLabel(workspace: (IWorkspaceIdentifier | ISingleFolderWorkspaceIdentifier | IWorkspace), options?: { verbose: boolean }): string {
diff --git a/src/vs/platform/label/test/label.test.ts b/src/vs/platform/label/test/label.test.ts
@@ -31,11 +31,11 @@ suite('URI Label', () => {
 		});
 
 		const uri1 = TestWorkspace.folders[0].uri.with({ path: TestWorkspace.folders[0].uri.path.concat('/a/b/c/d') });
-		assert.equal(labelService.getUriLabel(uri1, true), isWindows ? 'a\\b\\c\\d' : 'a/b/c/d');
-		assert.equal(labelService.getUriLabel(uri1, false), isWindows ? 'C:\\testWorkspace\\a\\b\\c\\d' : '/testWorkspace/a/b/c/d');
+		assert.equal(labelService.getUriLabel(uri1, { relative: true }), isWindows ? 'a\\b\\c\\d' : 'a/b/c/d');
+		assert.equal(labelService.getUriLabel(uri1, { relative: false }), isWindows ? 'C:\\testWorkspace\\a\\b\\c\\d' : '/testWorkspace/a/b/c/d');
 
 		const uri2 = URI.file('c:\\1/2/3');
-		assert.equal(labelService.getUriLabel(uri2, false), isWindows ? 'C:\\1\\2\\3' : '/c:\\1/2/3');
+		assert.equal(labelService.getUriLabel(uri2, { relative: false }), isWindows ? 'C:\\1\\2\\3' : '/c:\\1/2/3');
 	});
 
 	test('custom scheme', function () {
@@ -49,6 +49,6 @@ suite('URI Label', () => {
 		});
 
 		const uri1 = URI.parse('vscode://microsoft.com/1/2/3/4/5');
-		assert.equal(labelService.getUriLabel(uri1, false), 'LABEL//1/2/3/4/5/microsoft.com/END');
+		assert.equal(labelService.getUriLabel(uri1, { relative: false }), 'LABEL//1/2/3/4/5/microsoft.com/END');
 	});
 });
diff --git a/src/vs/workbench/browser/actions/workspaceCommands.ts b/src/vs/workbench/browser/actions/workspaceCommands.ts
@@ -177,7 +177,7 @@ CommandsRegistry.registerCommand(PICK_WORKSPACE_FOLDER_COMMAND_ID, function (acc
 	const folderPicks = folders.map(folder => {
 		return {
 			label: folder.name,
-			description: labelService.getUriLabel(resources.dirname(folder.uri), true),
+			description: labelService.getUriLabel(resources.dirname(folder.uri), { relative: true }),
 			folder,
 			iconClasses: getIconClasses(modelService, modeService, folder.uri, FileKind.ROOT_FOLDER)
 		} as IQuickPickItem;
diff --git a/src/vs/workbench/browser/labels.ts b/src/vs/workbench/browser/labels.ts
@@ -302,7 +302,7 @@ export class FileLabel extends ResourceLabel {
 		let description: string;
 		const hidePath = (options && options.hidePath) || (resource.scheme === Schemas.untitled && !this.untitledEditorService.hasAssociatedFilePath(resource));
 		if (!hidePath) {
-			description = this.labelService.getUriLabel(resources.dirname(resource), true);
+			description = this.labelService.getUriLabel(resources.dirname(resource), { relative: true });
 		}
 
 		this.setLabel({ resource, name, description }, options);
diff --git a/src/vs/workbench/browser/parts/quickopen/quickOpenController.ts b/src/vs/workbench/browser/parts/quickopen/quickOpenController.ts
@@ -727,7 +727,7 @@ export class EditorHistoryEntry extends EditorQuickOpenEntry {
 			const resourceInput = input as IResourceInput;
 			this.resource = resourceInput.resource;
 			this.label = resources.basenameOrAuthority(resourceInput.resource);
-			this.description = labelService.getUriLabel(resources.dirname(this.resource), true);
+			this.description = labelService.getUriLabel(resources.dirname(this.resource), { relative: true });
 			this.dirty = this.resource && this.textFileService.isDirty(this.resource);
 
 			if (this.dirty && this.textFileService.getAutoSaveMode() === AutoSaveMode.AFTER_SHORT_DELAY) {
diff --git a/src/vs/workbench/common/editor/untitledEditorInput.ts b/src/vs/workbench/common/editor/untitledEditorInput.ts
@@ -84,7 +84,7 @@ export class UntitledEditorInput extends EditorInput implements IEncodingSupport
 
 	@memoize
 	private get mediumDescription(): string {
-		return this.labelService.getUriLabel(resources.dirname(this.resource), true);
+		return this.labelService.getUriLabel(resources.dirname(this.resource), { relative: true });
 	}
 
 	@memoize
@@ -121,7 +121,7 @@ export class UntitledEditorInput extends EditorInput implements IEncodingSupport
 
 	@memoize
 	private get mediumTitle(): string {
-		return this.labelService.getUriLabel(this.resource, true);
+		return this.labelService.getUriLabel(this.resource, { relative: true });
 	}
 
 	@memoize
diff --git a/src/vs/workbench/parts/debug/browser/breakpointsView.ts b/src/vs/workbench/parts/debug/browser/breakpointsView.ts
@@ -337,7 +337,7 @@ class BreakpointsRenderer implements IRenderer<IBreakpoint, IBreakpointTemplateD
 		if (breakpoint.column) {
 			data.lineNumber.textContent += `:${breakpoint.column}`;
 		}
-		data.filePath.textContent = this.labelService.getUriLabel(resources.dirname(breakpoint.uri), true);
+		data.filePath.textContent = this.labelService.getUriLabel(resources.dirname(breakpoint.uri), { relative: true });
 		data.checkbox.checked = breakpoint.enabled;
 
 		const { message, className } = getBreakpointMessageAndClassName(this.debugService, breakpoint);
diff --git a/src/vs/workbench/parts/files/common/editors/fileEditorInput.ts b/src/vs/workbench/parts/files/common/editors/fileEditorInput.ts
@@ -137,12 +137,12 @@ export class FileEditorInput extends EditorInput implements IFileEditorInput {
 
 	@memoize
 	private get mediumDescription(): string {
-		return this.labelService.getUriLabel(resources.dirname(this.resource), true);
+		return this.labelService.getUriLabel(resources.dirname(this.resource), { relative: true });
 	}
 
 	@memoize
 	private get longDescription(): string {
-		return this.labelService.getUriLabel(resources.dirname(this.resource), true);
+		return this.labelService.getUriLabel(resources.dirname(this.resource), { relative: true });
 	}
 
 	getDescription(verbosity: Verbosity = Verbosity.MEDIUM): string {
@@ -170,7 +170,7 @@ export class FileEditorInput extends EditorInput implements IFileEditorInput {
 
 	@memoize
 	private get mediumTitle(): string {
-		return this.labelService.getUriLabel(this.resource, true);
+		return this.labelService.getUriLabel(this.resource, { relative: true });
 	}
 
 	@memoize
diff --git a/src/vs/workbench/parts/files/electron-browser/fileCommands.ts b/src/vs/workbench/parts/files/electron-browser/fileCommands.ts
@@ -392,7 +392,7 @@ function resourcesToClipboard(resources: URI[], relative: boolean, clipboardServ
 	if (resources.length) {
 		const lineDelimiter = isWindows ? '\r\n' : '\n';
 
-		const text = resources.map(resource => labelService.getUriLabel(resource, relative, true))
+		const text = resources.map(resource => labelService.getUriLabel(resource, { relative, forceNoTildify: true }))
 			.join(lineDelimiter);
 		clipboardService.writeText(text);
 	} else {
diff --git a/src/vs/workbench/parts/localizations/electron-browser/localizationsActions.ts b/src/vs/workbench/parts/localizations/electron-browser/localizationsActions.ts
@@ -49,7 +49,7 @@ export class ConfigureLocaleAction extends Action {
 				resource: stat.resource
 			});
 		}, (error) => {
-			throw new Error(localize('fail.createSettings', "Unable to create '{0}' ({1}).", this.labelService.getUriLabel(file, true), error));
+			throw new Error(localize('fail.createSettings', "Unable to create '{0}' ({1}).", this.labelService.getUriLabel(file, { relative: true }), error));
 		});
 	}
 }
diff --git a/src/vs/workbench/parts/markers/electron-browser/markersTreeViewer.ts b/src/vs/workbench/parts/markers/electron-browser/markersTreeViewer.ts
@@ -225,7 +225,7 @@ export class Renderer implements IRenderer {
 		if (templateData.resourceLabel instanceof FileLabel) {
 			templateData.resourceLabel.setFile(element.uri, { matches: element.uriMatches });
 		} else {
-			templateData.resourceLabel.setLabel({ name: element.name, description: this.labelService.getUriLabel(dirname(element.uri), true), resource: element.uri }, { matches: element.uriMatches });
+			templateData.resourceLabel.setLabel({ name: element.name, description: this.labelService.getUriLabel(dirname(element.uri), { relative: true }), resource: element.uri }, { matches: element.uriMatches });
 		}
 		(<IResourceMarkersTemplateData>templateData).count.setCount(element.filteredCount);
 	}
@@ -251,7 +251,7 @@ export class Renderer implements IRenderer {
 
 	private renderRelatedInfoElement(tree: ITree, element: RelatedInformation, templateData: IRelatedInformationTemplateData) {
 		templateData.resourceLabel.set(paths.basename(element.raw.resource.fsPath), element.uriMatches);
-		templateData.resourceLabel.element.title = this.labelService.getUriLabel(element.raw.resource, true);
+		templateData.resourceLabel.element.title = this.labelService.getUriLabel(element.raw.resource, { relative: true });
 		templateData.lnCol.textContent = Messages.MARKERS_PANEL_AT_LINE_COL_NUMBER(element.raw.startLineNumber, element.raw.startColumn);
 		templateData.description.set(element.raw.message, element.messageMatches);
 		templateData.description.element.title = element.raw.message;
@@ -295,7 +295,7 @@ export class MarkersTreeAccessibilityProvider implements IAccessibilityProvider
 
 	public getAriaLabel(tree: ITree, element: any): string {
 		if (element instanceof ResourceMarkers) {
-			const path = this.labelServie.getUriLabel(element.uri, true) || element.uri.fsPath;
+			const path = this.labelServie.getUriLabel(element.uri, { relative: true }) || element.uri.fsPath;
 			return Messages.MARKERS_TREE_ARIA_LABEL_RESOURCE(element.filteredCount, element.name, paths.dirname(path));
 		}
 		if (element instanceof Marker) {
diff --git a/src/vs/workbench/parts/search/browser/openFileHandler.ts b/src/vs/workbench/parts/search/browser/openFileHandler.ts
@@ -181,7 +181,7 @@ export class OpenFileHandler extends QuickOpenHandler {
 					const fileMatch = complete.results[i];
 
 					const label = paths.basename(fileMatch.resource.fsPath);
-					const description = this.labelService.getUriLabel(resources.dirname(fileMatch.resource), true);
+					const description = this.labelService.getUriLabel(resources.dirname(fileMatch.resource), { relative: true });
 
 					results.push(this.instantiationService.createInstance(FileEntry, fileMatch.resource, label, description, iconClass));
 				}
diff --git a/src/vs/workbench/parts/search/browser/openSymbolHandler.ts b/src/vs/workbench/parts/search/browser/openSymbolHandler.ts
@@ -54,7 +54,7 @@ class SymbolEntry extends EditorQuickOpenEntry {
 				return `${containerName} — ${basename(this.bearing.location.uri.fsPath)}`;
 			}
 
-			return this.labelService.getUriLabel(this.bearing.location.uri, true);
+			return this.labelService.getUriLabel(this.bearing.location.uri, { relative: true });
 		}
 
 		return containerName;
diff --git a/src/vs/workbench/parts/search/browser/searchResultsView.ts b/src/vs/workbench/parts/search/browser/searchResultsView.ts
@@ -341,7 +341,7 @@ export class SearchAccessibilityProvider implements IAccessibilityProvider {
 		}
 
 		if (element instanceof FileMatch) {
-			const path = this.labelService.getUriLabel(element.resource(), true) || element.resource().fsPath;
+			const path = this.labelService.getUriLabel(element.resource(), { relative: true }) || element.resource().fsPath;
 
 			return nls.localize('fileMatchAriaLabel', "{0} matches in file {1} of folder {2}, Search result", element.count(), element.name(), paths.dirname(path));
 		}
diff --git a/src/vs/workbench/services/bulkEdit/electron-browser/bulkEditService.ts b/src/vs/workbench/services/bulkEdit/electron-browser/bulkEditService.ts
@@ -341,7 +341,7 @@ export class BulkEdit {
 
 		const conflicts = edits
 			.filter(edit => recording.hasChanged(edit.resource))
-			.map(edit => this._uriLabelServie.getUriLabel(edit.resource, true));
+			.map(edit => this._uriLabelServie.getUriLabel(edit.resource, { relative: true }));
 
 		recording.stop();
 
diff --git a/src/vs/workbench/services/editor/browser/editorService.ts b/src/vs/workbench/services/editor/browser/editorService.ts
@@ -563,7 +563,7 @@ export class EditorService extends Disposable implements EditorServiceImpl {
 		}
 
 		// Otherwise: for diff labels prefer to see the path as part of the label
-		return this.labelService.getUriLabel(res, true);
+		return this.labelService.getUriLabel(res, { relative: true });
 	}
 
 	//#endregion
diff --git a/src/vs/workbench/services/preferences/browser/preferencesService.ts b/src/vs/workbench/services/preferences/browser/preferencesService.ts
@@ -502,7 +502,7 @@ export class PreferencesService extends Disposable implements IPreferencesServic
 		return this.fileService.resolveContent(resource, { acceptTextOnly: true }).then(null, error => {
 			if ((<FileOperationError>error).fileOperationResult === FileOperationResult.FILE_NOT_FOUND) {
 				return this.fileService.updateContent(resource, contents).then(null, error => {
-					return TPromise.wrapError(new Error(nls.localize('fail.createSettings', "Unable to create '{0}' ({1}).", this.labelService.getUriLabel(resource, true), error)));
+					return TPromise.wrapError(new Error(nls.localize('fail.createSettings', "Unable to create '{0}' ({1}).", this.labelService.getUriLabel(resource, { relative: true }), error)));
 				});
 			}
 

Original file line number	Diff line number	Diff line change
`@@ -602,7 +602,7 @@ export class SimpleUriLabelService implements ILabelService {`
`602`	`602`	`private readonly _onDidRegisterFormatter: Emitter<RegisterFormatterEvent> = new Emitter<RegisterFormatterEvent>();`
`603`	`603`	`public readonly onDidRegisterFormatter: Event<RegisterFormatterEvent> = this._onDidRegisterFormatter.event;`
`604`	`604`
`605`		`- public getUriLabel(resource: URI, relative?: boolean): string {`
	`605`	`+ public getUriLabel(resource: URI, options?: { relative?: boolean, forceNoTildify?: boolean }): string {`
`606`	`606`	`if (resource.scheme === 'file') {`
`607`	`607`	`return resource.fsPath;`
`608`	`608`	`}`
Original file line number	Diff line number	Diff line change
`@@ -302,7 +302,7 @@ export class FileLabel extends ResourceLabel {`
`302`	`302`	`let description: string;`
`303`	`303`	`const hidePath = (options && options.hidePath) \|\| (resource.scheme === Schemas.untitled && !this.untitledEditorService.hasAssociatedFilePath(resource));`
`304`	`304`	`if (!hidePath) {`
`305`		`- description = this.labelService.getUriLabel(resources.dirname(resource), true);`
	`305`	`+ description = this.labelService.getUriLabel(resources.dirname(resource), { relative: true });`
`306`	`306`	`}`
`307`	`307`
`308`	`308`	`this.setLabel({ resource, name, description }, options);`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ export class UntitledEditorInput extends EditorInput implements IEncodingSupport`
`84`	`84`
`85`	`85`	`@memoize`
`86`	`86`	`private get mediumDescription(): string {`
`87`		`- return this.labelService.getUriLabel(resources.dirname(this.resource), true);`
	`87`	`+ return this.labelService.getUriLabel(resources.dirname(this.resource), { relative: true });`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`@memoize`
`@@ -121,7 +121,7 @@ export class UntitledEditorInput extends EditorInput implements IEncodingSupport`
`121`	`121`
`122`	`122`	`@memoize`
`123`	`123`	`private get mediumTitle(): string {`
`124`		`- return this.labelService.getUriLabel(this.resource, true);`
	`124`	`+ return this.labelService.getUriLabel(this.resource, { relative: true });`
`125`	`125`	`}`
`126`	`126`
`127`	`127`	`@memoize`
Original file line number	Diff line number	Diff line change
`@@ -337,7 +337,7 @@ class BreakpointsRenderer implements IRenderer<IBreakpoint, IBreakpointTemplateD`
`337`	`337`	`if (breakpoint.column) {`
`338`	`338`	data.lineNumber.textContent += `:${breakpoint.column}`;
`339`	`339`	`}`
`340`		`- data.filePath.textContent = this.labelService.getUriLabel(resources.dirname(breakpoint.uri), true);`
	`340`	`+ data.filePath.textContent = this.labelService.getUriLabel(resources.dirname(breakpoint.uri), { relative: true });`
`341`	`341`	`data.checkbox.checked = breakpoint.enabled;`
`342`	`342`
`343`	`343`	`const { message, className } = getBreakpointMessageAndClassName(this.debugService, breakpoint);`
Original file line number	Diff line number	Diff line change
`@@ -137,12 +137,12 @@ export class FileEditorInput extends EditorInput implements IFileEditorInput {`
`137`	`137`
`138`	`138`	`@memoize`
`139`	`139`	`private get mediumDescription(): string {`
`140`		`- return this.labelService.getUriLabel(resources.dirname(this.resource), true);`
	`140`	`+ return this.labelService.getUriLabel(resources.dirname(this.resource), { relative: true });`
`141`	`141`	`}`
`142`	`142`
`143`	`143`	`@memoize`
`144`	`144`	`private get longDescription(): string {`
`145`		`- return this.labelService.getUriLabel(resources.dirname(this.resource), true);`
	`145`	`+ return this.labelService.getUriLabel(resources.dirname(this.resource), { relative: true });`
`146`	`146`	`}`
`147`	`147`
`148`	`148`	`getDescription(verbosity: Verbosity = Verbosity.MEDIUM): string {`
`@@ -170,7 +170,7 @@ export class FileEditorInput extends EditorInput implements IFileEditorInput {`
`170`	`170`
`171`	`171`	`@memoize`
`172`	`172`	`private get mediumTitle(): string {`
`173`		`- return this.labelService.getUriLabel(this.resource, true);`
	`173`	`+ return this.labelService.getUriLabel(this.resource, { relative: true });`
`174`	`174`	`}`
`175`	`175`
`176`	`176`	`@memoize`