Merge pull request microsoft#205911 from microsoft/merogge/fix-signal-bugs

fix accessibility signal validation warning, add go to settings file action when button is triggered

Author: meganrogge

src/vs/workbench/contrib/accessibility/browser/accessibilityConfiguration.ts

@@ -115,7 +115,7 @@ export const announcementFeatureBase: IConfigurationPropertySchema = {
 const defaultNoAnnouncement: IConfigurationPropertySchema = {
 	'type': 'object',
 	'tags': ['accessibility'],
-	additionalProperties: true,
+	additionalProperties: false,
 	'default': {
 		'sound': 'auto',
 	}
@@ -536,7 +536,6 @@ const configuration: IConfigurationNode = {
 		},
 		'accessibility.signals.chatResponseReceived': {
 			...defaultNoAnnouncement,
-			additionalProperties: false,
 			'description': localize('accessibility.signals.chatResponseReceived', "Indicates when the response has been received."),
 			'properties': {
 				'sound': {
@@ -562,7 +561,7 @@ const configuration: IConfigurationNode = {
 		'accessibility.signals.save': {
 			'type': 'object',
 			'tags': ['accessibility'],
-			additionalProperties: true,
+			additionalProperties: false,
 			'markdownDescription': localize('accessibility.signals.save', "Plays a signal when a file is saved."),
 			'properties': {
 				'sound': {
@@ -596,7 +595,7 @@ const configuration: IConfigurationNode = {
 		'accessibility.signals.format': {
 			'type': 'object',
 			'tags': ['accessibility'],
-			additionalProperties: true,
+			additionalProperties: false,
 			'markdownDescription': localize('accessibility.signals.format', "Plays a signal when a file or notebook is formatted."),
 			'properties': {
 				'sound': {
@@ -621,6 +620,10 @@ const configuration: IConfigurationNode = {
 						localize('accessibility.signals.format.announcement.never', "Never announces.")
 					],
 				},
+			},
+			default: {
+				'sound': 'never',
+				'announcement': 'never'
 			}
 		},
 	}
@@ -831,7 +834,7 @@ Registry.as<IConfigurationMigrationRegistry>(WorkbenchExtensions.ConfigurationMi
 	})));
 
 Registry.as<IConfigurationMigrationRegistry>(WorkbenchExtensions.ConfigurationMigration)
-	.registerConfigurationMigrations(AccessibilitySignal.allAccessibilitySignals.filter(i => !!i.announcementMessage).map(item => ({
+	.registerConfigurationMigrations(AccessibilitySignal.allAccessibilitySignals.filter(i => !!i.legacyAnnouncementSettingsKey).map(item => ({
 		key: item.legacyAnnouncementSettingsKey!,
 		migrateFn: (announcement, accessor) => {
 			const configurationKeyValuePairs: ConfigurationKeyValuePairs = [];

src/vs/workbench/contrib/accessibilitySignals/browser/commands.ts

@@ -12,6 +12,7 @@ import { AccessibilitySignal, IAccessibilitySignalService } from 'vs/platform/ac
 import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
 import { ServicesAccessor } from 'vs/platform/instantiation/common/instantiation';
 import { IQuickInputService, IQuickPickItem } from 'vs/platform/quickinput/common/quickInput';
+import { IPreferencesService } from 'vs/workbench/services/preferences/common/preferences';
 
 export class ShowSignalSoundHelp extends Action2 {
 	static readonly ID = 'signals.sounds.help';
@@ -32,6 +33,7 @@ export class ShowSignalSoundHelp extends Action2 {
 		const quickInputService = accessor.get(IQuickInputService);
 		const configurationService = accessor.get(IConfigurationService);
 		const accessibilityService = accessor.get(IAccessibilityService);
+		const preferencesService = accessor.get(IPreferencesService);
 		const userGestureSignals = [AccessibilitySignal.save, AccessibilitySignal.format];
 		const items: (IQuickPickItem & { signal: AccessibilitySignal })[] = AccessibilitySignal.allAccessibilitySignals.map((signal, idx) => ({
 			label: userGestureSignals.includes(signal) ? `${signal.name} (${configurationService.getValue(signal.settingsKey + '.sound')})` : signal.name,
@@ -68,6 +70,9 @@ export class ShowSignalSoundHelp extends Action2 {
 			}
 			qp.hide();
 		});
+		qp.onDidTriggerItemButton(e => {
+			preferencesService.openUserSettings({ jsonEditor: true, revealSetting: { key: e.item.signal.settingsKey, edit: true } });
+		});
 		qp.onDidChangeActive(() => {
 			accessibilitySignalService.playSound(qp.activeItems[0].signal.sound.getSound(true), true);
 		});
@@ -96,22 +101,23 @@ export class ShowAccessibilityAnnouncementHelp extends Action2 {
 		const quickInputService = accessor.get(IQuickInputService);
 		const configurationService = accessor.get(IConfigurationService);
 		const accessibilityService = accessor.get(IAccessibilityService);
+		const preferencesService = accessor.get(IPreferencesService);
 		const userGestureSignals = [AccessibilitySignal.save, AccessibilitySignal.format];
-		const items: (IQuickPickItem & { signal: AccessibilitySignal })[] = AccessibilitySignal.allAccessibilitySignals.filter(c => !!c.announcementMessage).map((signal, idx) => ({
+		const items: (IQuickPickItem & { signal: AccessibilitySignal })[] = AccessibilitySignal.allAccessibilitySignals.filter(c => !!c.legacyAnnouncementSettingsKey).map((signal, idx) => ({
 			label: userGestureSignals.includes(signal) ? `${signal.name} (${configurationService.getValue(signal.settingsKey + '.announcement')})` : signal.name,
 			signal,
 			buttons: userGestureSignals.includes(signal) ? [{
 				iconClass: ThemeIcon.asClassName(Codicon.settingsGear),
 				tooltip: localize('announcement.help.settings', 'Enable/Disable Announcement'),
-				alwaysVisible: true
+				alwaysVisible: true,
 			}] : []
 		}));
 		const qp = quickInputService.createQuickPick<IQuickPickItem & { signal: AccessibilitySignal }>();
 		qp.items = items;
 		qp.selectedItems = items.filter(i => accessibilitySignalService.isAnnouncementEnabled(i.signal) || userGestureSignals.includes(i.signal) && configurationService.getValue(i.signal.settingsKey + '.announcement') !== 'never');
 		qp.onDidAccept(() => {
 			const enabledAnnouncements = qp.selectedItems.map(i => i.signal);
-			const disabledAnnouncements = AccessibilitySignal.allAccessibilitySignals.filter(cue => !enabledAnnouncements.includes(cue));
+			const disabledAnnouncements = AccessibilitySignal.allAccessibilitySignals.filter(cue => !!cue.legacyAnnouncementSettingsKey && !enabledAnnouncements.includes(cue));
 			for (const signal of enabledAnnouncements) {
 				let { sound, announcement } = configurationService.getValue<{ sound: string; announcement?: string }>(signal.settingsKey);
 				announcement = userGestureSignals.includes(signal) ? 'userGesture' : signal.announcementMessage && accessibilityService.isScreenReaderOptimized() ? 'auto' : undefined;
@@ -124,6 +130,9 @@ export class ShowAccessibilityAnnouncementHelp extends Action2 {
 			}
 			qp.hide();
 		});
+		qp.onDidTriggerItemButton(e => {
+			preferencesService.openUserSettings({ jsonEditor: true, revealSetting: { key: e.item.signal.settingsKey, edit: true } });
+		});
 		qp.placeholder = localize('announcement.help.placeholder', 'Select an announcement to configure');
 		qp.canSelectMany = true;
 		await qp.show();