product icons: fix schema (fixes microsoft#94215)

aeschli · aeschli · commit 41e9b9567079 · 2020-04-14T15:43:35.000+02:00
diff --git a/src/vs/platform/theme/common/iconRegistry.ts b/src/vs/platform/theme/common/iconRegistry.ts
@@ -8,6 +8,8 @@ import { IJSONSchema, IJSONSchemaMap } from 'vs/base/common/jsonSchema';
 import { ThemeIcon } from 'vs/platform/theme/common/themeService';
 import { Event, Emitter } from 'vs/base/common/event';
 import { localize } from 'vs/nls';
+import { Extensions as JSONExtensions, IJSONContributionRegistry } from 'vs/platform/jsonschemas/common/jsonContributionRegistry';
+import { RunOnceScheduler } from 'vs/base/common/async';
 
 //  ------ API types
 
@@ -18,7 +20,7 @@ export const Extensions = {
 };
 
 export interface IconDefaults {
-	font?: string;
+	fontId?: string;
 	character: string;
 }
 
@@ -69,7 +71,21 @@ class IconRegistry implements IIconRegistry {
 	readonly onDidChangeSchema: Event<void> = this._onDidChangeSchema.event;
 
 	private iconsById: { [key: string]: IconContribution };
-	private iconSchema: IJSONSchema & { properties: IJSONSchemaMap } = { type: 'object', properties: {} };
+	private iconSchema: IJSONSchema & { properties: IJSONSchemaMap } = {
+		definitions: {
+			icons: {
+				type: 'object',
+				properties: {
+					fontId: { type: 'string', description: localize('iconDefintion.fontId', 'The id of the font to use. If not set, the font that is defined first is used.') },
+					fontCharacter: { type: 'string', description: localize('iconDefintion.fontCharacter', 'The font character associated with the icon definition.') }
+				},
+				additionalProperties: false,
+				defaultSnippets: [{ body: { fontCharacter: '\\\\e030' } }]
+			}
+		},
+		type: 'object',
+		properties: {}
+	};
 	private iconReferenceSchema: IJSONSchema & { enum: string[], enumDescriptions: string[] } = { type: 'string', enum: [], enumDescriptions: [] };
 
 	constructor() {
@@ -79,7 +95,7 @@ class IconRegistry implements IIconRegistry {
 	public registerIcon(id: string, defaults: IconDefaults, description: string, deprecationMessage?: string): ThemeIcon {
 		let iconContribution: IconContribution = { id, description, defaults, deprecationMessage };
 		this.iconsById[id] = iconContribution;
-		let propertySchema: IJSONSchema = { type: 'object', description, properties: { font: { type: 'string' }, fontCharacter: { type: 'string' } }, defaultSnippets: [{ body: { fontCharacter: '\\\\e030' } }] };
+		let propertySchema: IJSONSchema = { description, $ref: '#/definitions/icons' };
 		if (deprecationMessage) {
 			propertySchema.deprecationMessage = deprecationMessage;
 		}
@@ -539,5 +555,17 @@ registerIcon('bell-dot', { character: '\f101' }, localize('bell-dot', ''));
 registerIcon('debug-alt-2', { character: '\f102' }, localize('debug-alt-2', ''));
 registerIcon('debug-alt', { character: '\f103' }, localize('debug-alt', ''));
 
+export const iconsSchemaId = 'vscode://schemas/icons';
+
+let schemaRegistry = platform.Registry.as<IJSONContributionRegistry>(JSONExtensions.JSONContribution);
+schemaRegistry.registerSchema(iconsSchemaId, iconRegistry.getIconSchema());
+
+const delayer = new RunOnceScheduler(() => schemaRegistry.notifySchemaChanged(iconsSchemaId), 200);
+iconRegistry.onDidChangeSchema(() => {
+	if (!delayer.isScheduled()) {
+		delayer.schedule();
+	}
+});
+
 
 // setTimeout(_ => console.log(colorRegistry.toString()), 5000);
diff --git a/src/vs/workbench/services/themes/common/productIconThemeSchema.ts b/src/vs/workbench/services/themes/common/productIconThemeSchema.ts
@@ -7,7 +7,7 @@ import * as nls from 'vs/nls';
 import { Registry } from 'vs/platform/registry/common/platform';
 import { Extensions as JSONExtensions, IJSONContributionRegistry } from 'vs/platform/jsonschemas/common/jsonContributionRegistry';
 import { IJSONSchema } from 'vs/base/common/jsonSchema';
-import { getIconRegistry } from 'vs/platform/theme/common/iconRegistry';
+import { iconsSchemaId } from 'vs/platform/theme/common/iconRegistry';
 
 
 const schemaId = 'vscode://schemas/product-icon-theme';
@@ -67,9 +67,8 @@ const schema: IJSONSchema = {
 			}
 		},
 		iconDefinitions: {
-			type: 'object',
-			description: nls.localize('schema.iconDefinitions', 'Assocation of icon name to a font character.'),
-			properties: getIconRegistry().getIconSchema().properties,
+			description: nls.localize('schema.iconDefinitions', 'Association of icon name to a font character.'),
+			$ref: iconsSchemaId,
 			additionalProperties: false
 		}
 	}

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ import * as nls from 'vs/nls';`
`7`	`7`	`import { Registry } from 'vs/platform/registry/common/platform';`
`8`	`8`	`import { Extensions as JSONExtensions, IJSONContributionRegistry } from 'vs/platform/jsonschemas/common/jsonContributionRegistry';`
`9`	`9`	`import { IJSONSchema } from 'vs/base/common/jsonSchema';`
`10`		`-import { getIconRegistry } from 'vs/platform/theme/common/iconRegistry';`
	`10`	`+import { iconsSchemaId } from 'vs/platform/theme/common/iconRegistry';`
`11`	`11`
`12`	`12`
`13`	`13`	`const schemaId = 'vscode://schemas/product-icon-theme';`
`@@ -67,9 +67,8 @@ const schema: IJSONSchema = {`
`67`	`67`	`}`
`68`	`68`	`},`
`69`	`69`	`iconDefinitions: {`
`70`		`- type: 'object',`
`71`		`- description: nls.localize('schema.iconDefinitions', 'Assocation of icon name to a font character.'),`
`72`		`- properties: getIconRegistry().getIconSchema().properties,`
	`70`	`+ description: nls.localize('schema.iconDefinitions', 'Association of icon name to a font character.'),`
	`71`	`+ $ref: iconsSchemaId,`
`73`	`72`	`additionalProperties: false`
`74`	`73`	`}`
`75`	`74`	`}`