Add descriptions for commands microsoft#209511 (microsoft#209524)

benibenj · web-flow · commit 87050cad1da3 · 2024-04-04T12:03:15.000+02:00
diff --git a/src/vs/workbench/browser/actions/layoutActions.ts b/src/vs/workbench/browser/actions/layoutActions.ts
@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { localize, localize2 } from 'vs/nls';
+import { ILocalizedString, localize, localize2 } from 'vs/nls';
 import { MenuId, MenuRegistry, registerAction2, Action2 } from 'vs/platform/actions/common/actions';
 import { Categories } from 'vs/platform/action/common/actionCommonCategories';
 import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
@@ -447,12 +447,13 @@ registerAction2(ToggleStatusbarVisibilityAction);
 
 abstract class AbstractSetShowTabsAction extends Action2 {
 
-	constructor(private readonly settingName: string, private readonly value: string, title: ICommandActionTitle, id: string, precondition: ContextKeyExpression) {
+	constructor(private readonly settingName: string, private readonly value: string, title: ICommandActionTitle, id: string, precondition: ContextKeyExpression, description: string | ILocalizedString | undefined) {
 		super({
 			id,
 			title,
 			category: Categories.View,
 			precondition,
+			metadata: description ? { description } : undefined,
 			f1: true
 		});
 	}
@@ -472,7 +473,7 @@ export class HideEditorTabsAction extends AbstractSetShowTabsAction {
 	constructor() {
 		const precondition = ContextKeyExpr.and(ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_TABS_MODE}`, EditorTabsMode.NONE).negate(), InEditorZenModeContext.negate())!;
 		const title = localize2('hideEditorTabs', 'Hide Editor Tabs');
-		super(LayoutSettings.EDITOR_TABS_MODE, EditorTabsMode.NONE, title, HideEditorTabsAction.ID, precondition);
+		super(LayoutSettings.EDITOR_TABS_MODE, EditorTabsMode.NONE, title, HideEditorTabsAction.ID, precondition, localize2('hideEditorTabsDescription', "Hide Tab Bar"));
 	}
 }
 
@@ -483,7 +484,7 @@ export class ZenHideEditorTabsAction extends AbstractSetShowTabsAction {
 	constructor() {
 		const precondition = ContextKeyExpr.and(ContextKeyExpr.equals(`config.${ZenModeSettings.SHOW_TABS}`, EditorTabsMode.NONE).negate(), InEditorZenModeContext)!;
 		const title = localize2('hideEditorTabsZenMode', 'Hide Editor Tabs in Zen Mode');
-		super(ZenModeSettings.SHOW_TABS, EditorTabsMode.NONE, title, ZenHideEditorTabsAction.ID, precondition);
+		super(ZenModeSettings.SHOW_TABS, EditorTabsMode.NONE, title, ZenHideEditorTabsAction.ID, precondition, localize2('hideEditorTabsZenModeDescription', "Hide Tab Bar in Zen Mode"));
 	}
 }
 
@@ -497,7 +498,7 @@ export class ShowMultipleEditorTabsAction extends AbstractSetShowTabsAction {
 		const precondition = ContextKeyExpr.and(ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_TABS_MODE}`, EditorTabsMode.MULTIPLE).negate(), InEditorZenModeContext.negate())!;
 		const title = localize2('showMultipleEditorTabs', 'Show Multiple Editor Tabs');
 
-		super(LayoutSettings.EDITOR_TABS_MODE, EditorTabsMode.MULTIPLE, title, ShowMultipleEditorTabsAction.ID, precondition);
+		super(LayoutSettings.EDITOR_TABS_MODE, EditorTabsMode.MULTIPLE, title, ShowMultipleEditorTabsAction.ID, precondition, localize2('showMultipleEditorTabsDescription', "Show Tab Bar with multiple tabs"));
 	}
 }
 
@@ -509,7 +510,7 @@ export class ZenShowMultipleEditorTabsAction extends AbstractSetShowTabsAction {
 		const precondition = ContextKeyExpr.and(ContextKeyExpr.equals(`config.${ZenModeSettings.SHOW_TABS}`, EditorTabsMode.MULTIPLE).negate(), InEditorZenModeContext)!;
 		const title = localize2('showMultipleEditorTabsZenMode', 'Show Multiple Editor Tabs in Zen Mode');
 
-		super(ZenModeSettings.SHOW_TABS, EditorTabsMode.MULTIPLE, title, ZenShowMultipleEditorTabsAction.ID, precondition);
+		super(ZenModeSettings.SHOW_TABS, EditorTabsMode.MULTIPLE, title, ZenShowMultipleEditorTabsAction.ID, precondition, localize2('showMultipleEditorTabsZenModeDescription', "Show Tab Bar in Zen Mode"));
 	}
 }
 
@@ -523,7 +524,7 @@ export class ShowSingleEditorTabAction extends AbstractSetShowTabsAction {
 		const precondition = ContextKeyExpr.and(ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_TABS_MODE}`, EditorTabsMode.SINGLE).negate(), InEditorZenModeContext.negate())!;
 		const title = localize2('showSingleEditorTab', 'Show Single Editor Tab');
 
-		super(LayoutSettings.EDITOR_TABS_MODE, EditorTabsMode.SINGLE, title, ShowSingleEditorTabAction.ID, precondition);
+		super(LayoutSettings.EDITOR_TABS_MODE, EditorTabsMode.SINGLE, title, ShowSingleEditorTabAction.ID, precondition, localize2('showSingleEditorTabDescription', "Show Tab Bar with one Tab"));
 	}
 }
 
@@ -535,7 +536,7 @@ export class ZenShowSingleEditorTabAction extends AbstractSetShowTabsAction {
 		const precondition = ContextKeyExpr.and(ContextKeyExpr.equals(`config.${ZenModeSettings.SHOW_TABS}`, EditorTabsMode.SINGLE).negate(), InEditorZenModeContext)!;
 		const title = localize2('showSingleEditorTabZenMode', 'Show Single Editor Tab in Zen Mode');
 
-		super(ZenModeSettings.SHOW_TABS, EditorTabsMode.SINGLE, title, ZenShowSingleEditorTabAction.ID, precondition);
+		super(ZenModeSettings.SHOW_TABS, EditorTabsMode.SINGLE, title, ZenShowSingleEditorTabAction.ID, precondition, localize2('showSingleEditorTabZenModeDescription', "Show Tab Bar in Zen Mode with one Tab"));
 	}
 }
 
@@ -576,6 +577,7 @@ export class EditorActionsTitleBarAction extends Action2 {
 			title: localize2('moveEditorActionsToTitleBar', "Move Editor Actions to Title Bar"),
 			category: Categories.View,
 			precondition: ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_ACTIONS_LOCATION}`, EditorActionsLocation.TITLEBAR).negate(),
+			metadata: { description: localize2('moveEditorActionsToTitleBarDescription', "Move Editor Actions from the tab bar to the title bar") },
 			f1: true
 		});
 	}
@@ -602,6 +604,7 @@ export class EditorActionsDefaultAction extends Action2 {
 				ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_ACTIONS_LOCATION}`, EditorActionsLocation.DEFAULT).negate(),
 				ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_TABS_MODE}`, EditorTabsMode.NONE).negate(),
 			),
+			metadata: { description: localize2('moveEditorActionsToTabBarDescription', "Move Editor Actions from the title bar to the tab bar") },
 			f1: true
 		});
 	}
@@ -625,6 +628,7 @@ export class HideEditorActionsAction extends Action2 {
 			title: localize2('hideEditorActons', "Hide Editor Actions"),
 			category: Categories.View,
 			precondition: ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_ACTIONS_LOCATION}`, EditorActionsLocation.HIDDEN).negate(),
+			metadata: { description: localize2('hideEditorActonsDescription', "Hide Editor Actions in the tab and title bar") },
 			f1: true
 		});
 	}
@@ -648,6 +652,7 @@ export class ShowEditorActionsAction extends Action2 {
 			title: localize2('showEditorActons', "Show Editor Actions"),
 			category: Categories.View,
 			precondition: ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_ACTIONS_LOCATION}`, EditorActionsLocation.HIDDEN),
+			metadata: { description: localize2('showEditorActonsDescription', "Make Editor Actions visible.") },
 			f1: true
 		});
 	}
@@ -678,6 +683,7 @@ registerAction2(class extends Action2 {
 			title: localize2('toggleSeparatePinnedEditorTabs', "Separate Pinned Editor Tabs"),
 			category: Categories.View,
 			precondition: ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_TABS_MODE}`, EditorTabsMode.MULTIPLE),
+			metadata: { description: localize2('toggleSeparatePinnedEditorTabsDescription', "Toggle whether pinned editor tabs are shown on a separate row above unpinned tabs.") },
 			f1: true
 		});
 	}
diff --git a/src/vs/workbench/browser/actions/listCommands.ts b/src/vs/workbench/browser/actions/listCommands.ts
@@ -917,6 +917,7 @@ registerAction2(class ToggleStickyScroll extends Action2 {
 				mnemonicTitle: localize({ key: 'mitoggleTreeStickyScroll', comment: ['&& denotes a mnemonic'] }, "&&Toggle Tree Sticky Scroll"),
 			},
 			category: 'View',
+			metadata: { description: localize('toggleTreeStickyScrollDescription', "Toggles Sticky Scroll widget at the top of tree structures such as the File Explorer and Debug variables View.") },
 			f1: true
 		});
 	}
diff --git a/src/vs/workbench/browser/parts/titlebar/titlebarActions.ts b/src/vs/workbench/browser/parts/titlebar/titlebarActions.ts
@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { localize, localize2 } from 'vs/nls';
+import { ILocalizedString, localize, localize2 } from 'vs/nls';
 import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
 import { ServicesAccessor } from 'vs/platform/instantiation/common/instantiation';
 import { IStorageService, StorageScope, StorageTarget } from 'vs/platform/storage/common/storage';
@@ -19,11 +19,12 @@ import { CustomTitleBarVisibility, TitleBarSetting, TitlebarStyle } from 'vs/pla
 
 class ToggleConfigAction extends Action2 {
 
-	constructor(private readonly section: string, title: string, order: number, mainWindowOnly: boolean) {
+	constructor(private readonly section: string, title: string, description: string | ILocalizedString | undefined, order: number, mainWindowOnly: boolean) {
 		const when = mainWindowOnly ? IsAuxiliaryWindowFocusedContext.toNegated() : ContextKeyExpr.true();
 		super({
 			id: `toggle.${section}`,
 			title,
+			metadata: description ? { description } : undefined,
 			toggled: ContextKeyExpr.equals(`config.${section}`, true),
 			menu: [
 				{
@@ -51,13 +52,13 @@ class ToggleConfigAction extends Action2 {
 
 registerAction2(class ToggleCommandCenter extends ToggleConfigAction {
 	constructor() {
-		super(LayoutSettings.COMMAND_CENTER, localize('toggle.commandCenter', 'Command Center'), 1, false);
+		super(LayoutSettings.COMMAND_CENTER, localize('toggle.commandCenter', 'Command Center'), localize('toggle.commandCenterDescription', "Toggle visibility of the Command Center in title bar"), 1, false);
 	}
 });
 
 registerAction2(class ToggleLayoutControl extends ToggleConfigAction {
 	constructor() {
-		super('workbench.layoutControl.enabled', localize('toggle.layout', 'Layout Controls'), 2, true);
+		super('workbench.layoutControl.enabled', localize('toggle.layout', 'Layout Controls'), localize('toggle.layoutDescription', "Toggle visibility of the Layout Controls in title bar"), 2, true);
 	}
 });
 

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`* Licensed under the MIT License. See License.txt in the project root for license information.`
`4`	`4`	`--------------------------------------------------------------------------------------------/`
`5`	`5`
`6`		`-import { localize, localize2 } from 'vs/nls';`
	`6`	`+import { ILocalizedString, localize, localize2 } from 'vs/nls';`
`7`	`7`	`import { MenuId, MenuRegistry, registerAction2, Action2 } from 'vs/platform/actions/common/actions';`
`8`	`8`	`import { Categories } from 'vs/platform/action/common/actionCommonCategories';`
`9`	`9`	`import { IConfigurationService } from 'vs/platform/configuration/common/configuration';`
`@@ -447,12 +447,13 @@ registerAction2(ToggleStatusbarVisibilityAction);`
`447`	`447`
`448`	`448`	`abstract class AbstractSetShowTabsAction extends Action2 {`
`449`	`449`
`450`		`- constructor(private readonly settingName: string, private readonly value: string, title: ICommandActionTitle, id: string, precondition: ContextKeyExpression) {`
	`450`	`+ constructor(private readonly settingName: string, private readonly value: string, title: ICommandActionTitle, id: string, precondition: ContextKeyExpression, description: string \| ILocalizedString \| undefined) {`
`451`	`451`	`super({`
`452`	`452`	`id,`
`453`	`453`	`title,`
`454`	`454`	`category: Categories.View,`
`455`	`455`	`precondition,`
	`456`	`+ metadata: description ? { description } : undefined,`
`456`	`457`	`f1: true`
`457`	`458`	`});`
`458`	`459`	`}`
`@@ -472,7 +473,7 @@ export class HideEditorTabsAction extends AbstractSetShowTabsAction {`
`472`	`473`	`constructor() {`
`473`	`474`	const precondition = ContextKeyExpr.and(ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_TABS_MODE}`, EditorTabsMode.NONE).negate(), InEditorZenModeContext.negate())!;
`474`	`475`	`const title = localize2('hideEditorTabs', 'Hide Editor Tabs');`
`475`		`- super(LayoutSettings.EDITOR_TABS_MODE, EditorTabsMode.NONE, title, HideEditorTabsAction.ID, precondition);`
	`476`	`+ super(LayoutSettings.EDITOR_TABS_MODE, EditorTabsMode.NONE, title, HideEditorTabsAction.ID, precondition, localize2('hideEditorTabsDescription', "Hide Tab Bar"));`
`476`	`477`	`}`
`477`	`478`	`}`
`478`	`479`
`@@ -483,7 +484,7 @@ export class ZenHideEditorTabsAction extends AbstractSetShowTabsAction {`
`483`	`484`	`constructor() {`
`484`	`485`	const precondition = ContextKeyExpr.and(ContextKeyExpr.equals(`config.${ZenModeSettings.SHOW_TABS}`, EditorTabsMode.NONE).negate(), InEditorZenModeContext)!;
`485`	`486`	`const title = localize2('hideEditorTabsZenMode', 'Hide Editor Tabs in Zen Mode');`
`486`		`- super(ZenModeSettings.SHOW_TABS, EditorTabsMode.NONE, title, ZenHideEditorTabsAction.ID, precondition);`
	`487`	`+ super(ZenModeSettings.SHOW_TABS, EditorTabsMode.NONE, title, ZenHideEditorTabsAction.ID, precondition, localize2('hideEditorTabsZenModeDescription', "Hide Tab Bar in Zen Mode"));`
`487`	`488`	`}`
`488`	`489`	`}`
`489`	`490`
`@@ -497,7 +498,7 @@ export class ShowMultipleEditorTabsAction extends AbstractSetShowTabsAction {`
`497`	`498`	const precondition = ContextKeyExpr.and(ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_TABS_MODE}`, EditorTabsMode.MULTIPLE).negate(), InEditorZenModeContext.negate())!;
`498`	`499`	`const title = localize2('showMultipleEditorTabs', 'Show Multiple Editor Tabs');`
`499`	`500`
`500`		`- super(LayoutSettings.EDITOR_TABS_MODE, EditorTabsMode.MULTIPLE, title, ShowMultipleEditorTabsAction.ID, precondition);`
	`501`	`+ super(LayoutSettings.EDITOR_TABS_MODE, EditorTabsMode.MULTIPLE, title, ShowMultipleEditorTabsAction.ID, precondition, localize2('showMultipleEditorTabsDescription', "Show Tab Bar with multiple tabs"));`
`501`	`502`	`}`
`502`	`503`	`}`
`503`	`504`
`@@ -509,7 +510,7 @@ export class ZenShowMultipleEditorTabsAction extends AbstractSetShowTabsAction {`
`509`	`510`	const precondition = ContextKeyExpr.and(ContextKeyExpr.equals(`config.${ZenModeSettings.SHOW_TABS}`, EditorTabsMode.MULTIPLE).negate(), InEditorZenModeContext)!;
`510`	`511`	`const title = localize2('showMultipleEditorTabsZenMode', 'Show Multiple Editor Tabs in Zen Mode');`
`511`	`512`
`512`		`- super(ZenModeSettings.SHOW_TABS, EditorTabsMode.MULTIPLE, title, ZenShowMultipleEditorTabsAction.ID, precondition);`
	`513`	`+ super(ZenModeSettings.SHOW_TABS, EditorTabsMode.MULTIPLE, title, ZenShowMultipleEditorTabsAction.ID, precondition, localize2('showMultipleEditorTabsZenModeDescription', "Show Tab Bar in Zen Mode"));`
`513`	`514`	`}`
`514`	`515`	`}`
`515`	`516`
`@@ -523,7 +524,7 @@ export class ShowSingleEditorTabAction extends AbstractSetShowTabsAction {`
`523`	`524`	const precondition = ContextKeyExpr.and(ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_TABS_MODE}`, EditorTabsMode.SINGLE).negate(), InEditorZenModeContext.negate())!;
`524`	`525`	`const title = localize2('showSingleEditorTab', 'Show Single Editor Tab');`
`525`	`526`
`526`		`- super(LayoutSettings.EDITOR_TABS_MODE, EditorTabsMode.SINGLE, title, ShowSingleEditorTabAction.ID, precondition);`
	`527`	`+ super(LayoutSettings.EDITOR_TABS_MODE, EditorTabsMode.SINGLE, title, ShowSingleEditorTabAction.ID, precondition, localize2('showSingleEditorTabDescription', "Show Tab Bar with one Tab"));`
`527`	`528`	`}`
`528`	`529`	`}`
`529`	`530`
`@@ -535,7 +536,7 @@ export class ZenShowSingleEditorTabAction extends AbstractSetShowTabsAction {`
`535`	`536`	const precondition = ContextKeyExpr.and(ContextKeyExpr.equals(`config.${ZenModeSettings.SHOW_TABS}`, EditorTabsMode.SINGLE).negate(), InEditorZenModeContext)!;
`536`	`537`	`const title = localize2('showSingleEditorTabZenMode', 'Show Single Editor Tab in Zen Mode');`
`537`	`538`
`538`		`- super(ZenModeSettings.SHOW_TABS, EditorTabsMode.SINGLE, title, ZenShowSingleEditorTabAction.ID, precondition);`
	`539`	`+ super(ZenModeSettings.SHOW_TABS, EditorTabsMode.SINGLE, title, ZenShowSingleEditorTabAction.ID, precondition, localize2('showSingleEditorTabZenModeDescription', "Show Tab Bar in Zen Mode with one Tab"));`
`539`	`540`	`}`
`540`	`541`	`}`
`541`	`542`
`@@ -576,6 +577,7 @@ export class EditorActionsTitleBarAction extends Action2 {`
`576`	`577`	`title: localize2('moveEditorActionsToTitleBar', "Move Editor Actions to Title Bar"),`
`577`	`578`	`category: Categories.View,`
`578`	`579`	precondition: ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_ACTIONS_LOCATION}`, EditorActionsLocation.TITLEBAR).negate(),
	`580`	`+ metadata: { description: localize2('moveEditorActionsToTitleBarDescription', "Move Editor Actions from the tab bar to the title bar") },`
`579`	`581`	`f1: true`
`580`	`582`	`});`
`581`	`583`	`}`
`@@ -602,6 +604,7 @@ export class EditorActionsDefaultAction extends Action2 {`
`602`	`604`	ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_ACTIONS_LOCATION}`, EditorActionsLocation.DEFAULT).negate(),
`603`	`605`	ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_TABS_MODE}`, EditorTabsMode.NONE).negate(),
`604`	`606`	`),`
	`607`	`+ metadata: { description: localize2('moveEditorActionsToTabBarDescription', "Move Editor Actions from the title bar to the tab bar") },`
`605`	`608`	`f1: true`
`606`	`609`	`});`
`607`	`610`	`}`
`@@ -625,6 +628,7 @@ export class HideEditorActionsAction extends Action2 {`
`625`	`628`	`title: localize2('hideEditorActons', "Hide Editor Actions"),`
`626`	`629`	`category: Categories.View,`
`627`	`630`	precondition: ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_ACTIONS_LOCATION}`, EditorActionsLocation.HIDDEN).negate(),
	`631`	`+ metadata: { description: localize2('hideEditorActonsDescription', "Hide Editor Actions in the tab and title bar") },`
`628`	`632`	`f1: true`
`629`	`633`	`});`
`630`	`634`	`}`
`@@ -648,6 +652,7 @@ export class ShowEditorActionsAction extends Action2 {`
`648`	`652`	`title: localize2('showEditorActons', "Show Editor Actions"),`
`649`	`653`	`category: Categories.View,`
`650`	`654`	precondition: ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_ACTIONS_LOCATION}`, EditorActionsLocation.HIDDEN),
	`655`	`+ metadata: { description: localize2('showEditorActonsDescription', "Make Editor Actions visible.") },`
`651`	`656`	`f1: true`
`652`	`657`	`});`
`653`	`658`	`}`
`@@ -678,6 +683,7 @@ registerAction2(class extends Action2 {`
`678`	`683`	`title: localize2('toggleSeparatePinnedEditorTabs', "Separate Pinned Editor Tabs"),`
`679`	`684`	`category: Categories.View,`
`680`	`685`	precondition: ContextKeyExpr.equals(`config.${LayoutSettings.EDITOR_TABS_MODE}`, EditorTabsMode.MULTIPLE),
	`686`	`+ metadata: { description: localize2('toggleSeparatePinnedEditorTabsDescription', "Toggle whether pinned editor tabs are shown on a separate row above unpinned tabs.") },`
`681`	`687`	`f1: true`
`682`	`688`	`});`
`683`	`689`	`}`
Original file line number	Diff line number	Diff line change
`@@ -917,6 +917,7 @@ registerAction2(class ToggleStickyScroll extends Action2 {`
`917`	`917`	`mnemonicTitle: localize({ key: 'mitoggleTreeStickyScroll', comment: ['&& denotes a mnemonic'] }, "&&Toggle Tree Sticky Scroll"),`
`918`	`918`	`},`
`919`	`919`	`category: 'View',`
	`920`	`+ metadata: { description: localize('toggleTreeStickyScrollDescription', "Toggles Sticky Scroll widget at the top of tree structures such as the File Explorer and Debug variables View.") },`
`920`	`921`	`f1: true`
`921`	`922`	`});`
`922`	`923`	`}`