make DecorationData a class and rename it to Decoration, #54938

extensions/git/src/decorationProvider.ts

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { window, workspace, Uri, Disposable, Event, EventEmitter, DecorationData, DecorationProvider, ThemeColor } from 'vscode';
+import { window, workspace, Uri, Disposable, Event, EventEmitter, Decoration, DecorationProvider, ThemeColor } from 'vscode';
 import * as path from 'path';
 import { Repository, GitResourceGroup } from './repository';
 import { Model } from './model';
@@ -29,7 +29,7 @@ class GitIgnoreDecorationProvider implements DecorationProvider {
 		this.disposables.push(window.registerDecorationProvider(this));
 	}
 
-	provideDecoration(uri: Uri): Promise<DecorationData | undefined> {
+	provideDecoration(uri: Uri): Promise<Decoration | undefined> {
 		const repository = this.model.getRepository(uri);
 
 		if (!repository) {
@@ -48,7 +48,7 @@ class GitIgnoreDecorationProvider implements DecorationProvider {
 			this.checkIgnoreSoon();
 		}).then(ignored => {
 			if (ignored) {
-				return <DecorationData>{
+				return <Decoration>{
 					priority: 3,
 					color: new ThemeColor('gitDecoration.ignoredResourceForeground')
 				};
@@ -89,7 +89,7 @@ class GitIgnoreDecorationProvider implements DecorationProvider {
 
 class GitDecorationProvider implements DecorationProvider {
 
-	private static SubmoduleDecorationData: DecorationData = {
+	private static SubmoduleDecorationData: Decoration = {
 		title: 'Submodule',
 		letter: 'S',
 		color: new ThemeColor('gitDecoration.submoduleResourceForeground')
@@ -99,7 +99,7 @@ class GitDecorationProvider implements DecorationProvider {
 	readonly onDidChangeDecorations: Event<Uri[]> = this._onDidChangeDecorations.event;
 
 	private disposables: Disposable[] = [];
-	private decorations = new Map<string, DecorationData>();
+	private decorations = new Map<string, Decoration>();
 
 	constructor(private repository: Repository) {
 		this.disposables.push(
@@ -109,7 +109,7 @@ class GitDecorationProvider implements DecorationProvider {
 	}
 
 	private onDidRunGitStatus(): void {
-		let newDecorations = new Map<string, DecorationData>();
+		let newDecorations = new Map<string, Decoration>();
 
 		this.collectSubmoduleDecorationData(newDecorations);
 		this.collectDecorationData(this.repository.indexGroup, newDecorations);
@@ -121,7 +121,7 @@ class GitDecorationProvider implements DecorationProvider {
 		this._onDidChangeDecorations.fire([...uris.values()].map(value => Uri.parse(value, true)));
 	}
 
-	private collectDecorationData(group: GitResourceGroup, bucket: Map<string, DecorationData>): void {
+	private collectDecorationData(group: GitResourceGroup, bucket: Map<string, Decoration>): void {
 		group.resourceStates.forEach(r => {
 			if (r.resourceDecoration) {
 				// not deleted and has a decoration
@@ -130,13 +130,13 @@ class GitDecorationProvider implements DecorationProvider {
 		});
 	}
 
-	private collectSubmoduleDecorationData(bucket: Map<string, DecorationData>): void {
+	private collectSubmoduleDecorationData(bucket: Map<string, Decoration>): void {
 		for (const submodule of this.repository.submodules) {
 			bucket.set(Uri.file(path.join(this.repository.root, submodule.path)).toString(), GitDecorationProvider.SubmoduleDecorationData);
 		}
 	}
 
-	provideDecoration(uri: Uri): DecorationData | undefined {
+	provideDecoration(uri: Uri): Decoration | undefined {
 		return this.decorations.get(uri.toString());
 	}
 

extensions/git/src/repository.ts

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { commands, Uri, Command, EventEmitter, Event, scm, SourceControl, SourceControlInputBox, SourceControlResourceGroup, SourceControlResourceState, SourceControlResourceDecorations, SourceControlInputBoxValidation, Disposable, ProgressLocation, window, workspace, WorkspaceEdit, ThemeColor, DecorationData, Memento, SourceControlInputBoxValidationType, OutputChannel, LogLevel, env, ProgressOptions, CancellationToken } from 'vscode';
+import { commands, Uri, Command, EventEmitter, Event, scm, SourceControl, SourceControlInputBox, SourceControlResourceGroup, SourceControlResourceState, SourceControlResourceDecorations, SourceControlInputBoxValidation, Disposable, ProgressLocation, window, workspace, WorkspaceEdit, ThemeColor, Decoration, Memento, SourceControlInputBoxValidationType, OutputChannel, LogLevel, env, ProgressOptions, CancellationToken } from 'vscode';
 import { Repository as BaseRepository, Commit, Stash, GitError, Submodule, CommitOptions, ForcePushMode } from './git';
 import { anyEvent, filterEvent, eventToPromise, dispose, find, isDescendant, IDisposable, onceEvent, EmptyDisposable, debounceEvent, combinedDisposable } from './util';
 import { memoize, throttle, debounce } from './decorators';
@@ -244,7 +244,7 @@ export class Resource implements SourceControlResourceState {
 		}
 	}
 
-	get resourceDecoration(): DecorationData {
+	get resourceDecoration(): Decoration {
 		const title = this.tooltip;
 		const letter = this.letter;
 		const color = this.color;

src/vs/vscode.proposed.d.ts

@@ -556,8 +556,7 @@ declare module 'vscode' {
 
 	//#region Joh: decorations
 
-	//todo@joh -> make class
-	export interface DecorationData {
+	export class Decoration {
 		letter?: string;
 		title?: string;
 		color?: ThemeColor;
@@ -567,7 +566,7 @@ declare module 'vscode' {
 
 	export interface DecorationProvider {
 		onDidChangeDecorations: Event<undefined | Uri | Uri[]>;
-		provideDecoration(uri: Uri, token: CancellationToken): ProviderResult<DecorationData>;
+		provideDecoration(uri: Uri, token: CancellationToken): ProviderResult<Decoration>;
 	}
 
 	export namespace window {

src/vs/workbench/api/common/extHost.api.impl.ts

@@ -890,7 +890,8 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
 			WorkspaceEdit: extHostTypes.WorkspaceEdit,
 			// proposed
 			CallHierarchyDirection: extHostTypes.CallHierarchyDirection,
-			CallHierarchyItem: extHostTypes.CallHierarchyItem
+			CallHierarchyItem: extHostTypes.CallHierarchyItem,
+			Decoration: extHostTypes.Decoration
 		};
 	};
 }

src/vs/workbench/api/common/extHostDecorations.ts

@@ -6,7 +6,7 @@
 import * as vscode from 'vscode';
 import { URI } from 'vs/base/common/uri';
 import { MainContext, ExtHostDecorationsShape, MainThreadDecorationsShape, DecorationData, DecorationRequest, DecorationReply } from 'vs/workbench/api/common/extHost.protocol';
-import { Disposable } from 'vs/workbench/api/common/extHostTypes';
+import { Disposable, Decoration } from 'vs/workbench/api/common/extHostTypes';
 import { CancellationToken } from 'vs/base/common/cancellation';
 import { ExtensionIdentifier } from 'vs/platform/extensions/common/extensions';
 import { asArray } from 'vs/base/common/arrays';
@@ -59,12 +59,14 @@ export class ExtHostDecorations implements IExtHostDecorations {
 			}
 			const { provider, extensionId } = entry;
 			return Promise.resolve(provider.provideDecoration(URI.revive(uri), token)).then(data => {
-				if (data && data.letter && data.letter.length !== 1) {
-					console.warn(`INVALID decoration from extension '${extensionId.value}'. The 'letter' must be set and be one character, not '${data.letter}'.`);
+				if (!data) {
+					return;
 				}
-				if (data) {
+				try {
+					Decoration.validate(data);
 					result[id] = <DecorationData>[data.priority, data.bubble, data.title, data.letter, data.color];
-
+				} catch (e) {
+					console.warn(`INVALID decoration from extension '${extensionId.value}': ${e}`);
 				}
 			}, err => {
 				console.error(err);

src/vs/workbench/api/common/extHostTypes.ts

@@ -2349,3 +2349,21 @@ export enum ExtensionKind {
 	UI = 1,
 	Workspace = 2
 }
+
+export class Decoration {
+
+	static validate(d: Decoration): void {
+		if (d.letter && d.letter.length !== 1) {
+			throw new Error(`The 'letter'-property must be undefined or a single character`);
+		}
+		if (!d.bubble && !d.color && !d.letter && !d.priority && !d.title) {
+			throw new Error(`The decoration is empty`);
+		}
+	}
+
+	letter?: string;
+	title?: string;
+	color?: vscode.ThemeColor;
+	priority?: number;
+	bubble?: boolean;
+}