Adds command deep links (#3679)

Closes #3677 and #3678

Author: axosoft-ramint

docs/links.md

@@ -22,6 +22,10 @@ This document covers the various VSCode link formats that work with GitLens, alo
 
 - [Login](#login 'Jump to Login')
 
+### Other Links
+
+- [Command](#command 'Jump to Command')
+
 ## Notation
 
 The following are used in link notation in this document:
@@ -249,3 +253,27 @@ _vscode://eamodio.gitlens/login?code={code}(&state={state})(&context={context})_
 #### Example Usage
 
 External sources, such as GitKraken web pages, can use these links internally to get you into GitLens and logged in to your GitKraken account.
+
+## Other Links
+
+### Command
+
+#### Description
+
+Used to run a GitLens command.
+
+#### Format
+
+_{prefix}/command/{command}_
+
+#### References
+
+- _{command}_ is the name of the command to run. Currently supported values include:
+
+  - _launchpad_ - Runs the `GitLens: Show Launchpad` command.
+
+  - _walkthrough_ - Runs the `GitLens: Open Walkthrough` command.
+
+#### Example Usage
+
+External sources, such as GitKraken web pages, can use these links to directly run a GitLens command - for example, to show the Launchpad.

src/uris/deepLinks/deepLink.ts

@@ -1,4 +1,5 @@
 import type { Uri } from 'vscode';
+import { Commands } from '../../constants.commands';
 import type { GitReference } from '../../git/models/reference';
 import type { GitRemote } from '../../git/models/remote';
 import type { Repository } from '../../git/models/repository';
@@ -8,6 +9,7 @@ export type UriTypes = 'link';
 
 export enum DeepLinkType {
 	Branch = 'b',
+	Command = 'command',
 	Commit = 'c',
 	Comparison = 'compare',
 	Draft = 'drafts',
@@ -17,6 +19,20 @@ export enum DeepLinkType {
 	Workspace = 'workspace',
 }
 
+export enum DeepLinkCommandType {
+	Launchpad = 'launchpad',
+	Walkthrough = 'walkthrough',
+}
+
+export function isDeepLinkCommandType(type: string): type is DeepLinkCommandType {
+	return Object.values(DeepLinkCommandType).includes(type as DeepLinkCommandType);
+}
+
+export const DeepLinkCommandTypeToCommand = new Map<DeepLinkCommandType, Commands>([
+	[DeepLinkCommandType.Launchpad, Commands.ShowLaunchpad],
+	[DeepLinkCommandType.Walkthrough, Commands.OpenWalkthrough],
+]);
+
 export enum DeepLinkActionType {
 	Switch = 'switch',
 	SwitchToPullRequest = 'switch-to-pr',
@@ -31,6 +47,8 @@ export function deepLinkTypeToString(type: DeepLinkType): string {
 	switch (type) {
 		case DeepLinkType.Branch:
 			return 'Branch';
+		case DeepLinkType.Command:
+			return 'Command';
 		case DeepLinkType.Commit:
 			return 'Commit';
 		case DeepLinkType.Comparison:
@@ -169,14 +187,20 @@ export function parseDeepLinkUri(uri: Uri): DeepLink | undefined {
 				params: urlParams,
 			};
 		}
-
-		case DeepLinkType.Workspace:
+		case DeepLinkType.Workspace: {
 			return {
 				type: DeepLinkType.Workspace,
 				mainId: mainId,
 				params: urlParams,
 			};
-
+		}
+		case DeepLinkType.Command: {
+			return {
+				type: DeepLinkType.Command,
+				mainId: mainId,
+				params: urlParams,
+			};
+		}
 		default:
 			return undefined;
 	}
@@ -206,6 +230,7 @@ export const enum DeepLinkServiceState {
 	OpenFile,
 	OpenInspect,
 	SwitchToRef,
+	RunCommand,
 }
 
 export const enum DeepLinkServiceAction {
@@ -215,6 +240,7 @@ export const enum DeepLinkServiceAction {
 	DeepLinkResolved,
 	DeepLinkStored,
 	DeepLinkErrored,
+	LinkIsCommandType,
 	LinkIsRepoType,
 	LinkIsDraftType,
 	LinkIsWorkspaceType,
@@ -282,6 +308,7 @@ export const deepLinkStateTransitionTable: Record<string, Record<string, DeepLin
 	[DeepLinkServiceState.TypeMatch]: {
 		[DeepLinkServiceAction.DeepLinkErrored]: DeepLinkServiceState.Idle,
 		[DeepLinkServiceAction.DeepLinkCancelled]: DeepLinkServiceState.Idle,
+		[DeepLinkServiceAction.LinkIsCommandType]: DeepLinkServiceState.RunCommand,
 		[DeepLinkServiceAction.LinkIsRepoType]: DeepLinkServiceState.RepoMatch,
 		[DeepLinkServiceAction.LinkIsDraftType]: DeepLinkServiceState.OpenDraft,
 		[DeepLinkServiceAction.LinkIsWorkspaceType]: DeepLinkServiceState.OpenWorkspace,
@@ -392,6 +419,11 @@ export const deepLinkStateTransitionTable: Record<string, Record<string, DeepLin
 		[DeepLinkServiceAction.DeepLinkErrored]: DeepLinkServiceState.Idle,
 		[DeepLinkServiceAction.DeepLinkCancelled]: DeepLinkServiceState.Idle,
 	},
+	[DeepLinkServiceState.RunCommand]: {
+		[DeepLinkServiceAction.DeepLinkResolved]: DeepLinkServiceState.Idle,
+		[DeepLinkServiceAction.DeepLinkErrored]: DeepLinkServiceState.Idle,
+		[DeepLinkServiceAction.DeepLinkCancelled]: DeepLinkServiceState.Idle,
+	},
 };
 
 export interface DeepLinkProgress {
@@ -422,4 +454,5 @@ export const deepLinkStateToProgress: Record<string, DeepLinkProgress> = {
 	[DeepLinkServiceState.OpenFile]: { message: 'Opening file...', increment: 90 },
 	[DeepLinkServiceState.OpenInspect]: { message: 'Opening inspect...', increment: 90 },
 	[DeepLinkServiceState.SwitchToRef]: { message: 'Switching to ref...', increment: 90 },
+	[DeepLinkServiceState.RunCommand]: { message: 'Running command...', increment: 90 },
 };

src/uris/deepLinks/deepLinkService.ts

@@ -33,12 +33,14 @@ import type { DeepLink, DeepLinkProgress, DeepLinkRepoOpenType, DeepLinkServiceC
 import {
 	AccountDeepLinkTypes,
 	DeepLinkActionType,
+	DeepLinkCommandTypeToCommand,
 	DeepLinkServiceAction,
 	DeepLinkServiceState,
 	deepLinkStateToProgress,
 	deepLinkStateTransitionTable,
 	DeepLinkType,
 	deepLinkTypeToString,
+	isDeepLinkCommandType,
 	PaidDeepLinkTypes,
 	parseDeepLinkUri,
 } from './deepLink';
@@ -659,6 +661,9 @@ export class DeepLinkService implements Disposable {
 						case DeepLinkType.Workspace:
 							action = DeepLinkServiceAction.LinkIsWorkspaceType;
 							break;
+						case DeepLinkType.Command:
+							action = DeepLinkServiceAction.LinkIsCommandType;
+							break;
 						default:
 							action = DeepLinkServiceAction.LinkIsRepoType;
 							break;
@@ -1384,6 +1389,24 @@ export class DeepLinkService implements Disposable {
 					action = DeepLinkServiceAction.DeepLinkResolved;
 					break;
 				}
+				case DeepLinkServiceState.RunCommand: {
+					if (mainId == null || !isDeepLinkCommandType(mainId)) {
+						action = DeepLinkServiceAction.DeepLinkErrored;
+						message = 'Invalid command type.';
+						break;
+					}
+
+					const command = DeepLinkCommandTypeToCommand.get(mainId);
+					if (command == null) {
+						action = DeepLinkServiceAction.DeepLinkErrored;
+						message = 'Invalid command.';
+						break;
+					}
+
+					await executeCommand(command, { source: 'deeplink' });
+					action = DeepLinkServiceAction.DeepLinkResolved;
+					break;
+				}
 				default: {
 					action = DeepLinkServiceAction.DeepLinkErrored;
 					message = 'Unknown state.';