Barebones 'start work' command for hacking/experimenting

(#3621, #3698)

Author: axosoft-ramint

package.json

@@ -5899,6 +5899,12 @@
 				"category": "GitLens",
 				"icon": "$(rocket)"
 			},
+			{
+				"command": "gitlens.startWork",
+				"title": "Start Work",
+				"category": "GitLens",
+				"icon": "$(rocket)"
+			},
 			{
 				"command": "gitlens.showLaunchpadView",
 				"title": "Show Launchpad View",
@@ -10336,6 +10342,10 @@
 					"command": "gitlens.showLaunchpad",
 					"when": "gitlens:enabled"
 				},
+				{
+					"command": "gitlens.startWork",
+					"when": "gitlens:enabled"
+				},
 				{
 					"command": "gitlens.showLaunchpadView",
 					"when": "gitlens:enabled"

src/commands/quickWizard.ts

@@ -1,17 +1,18 @@
 import { Commands } from '../constants.commands';
 import type { Container } from '../container';
 import type { LaunchpadCommandArgs } from '../plus/launchpad/launchpad';
+import type { StartWorkCommandArgs } from '../plus/startWork/startWork';
 import { command } from '../system/vscode/command';
 import type { CommandContext } from './base';
 import type { QuickWizardCommandArgsWithCompletion } from './quickWizard.base';
 import { QuickWizardCommandBase } from './quickWizard.base';
 
-export type QuickWizardCommandArgs = LaunchpadCommandArgs;
+export type QuickWizardCommandArgs = LaunchpadCommandArgs | StartWorkCommandArgs;
 
 @command()
 export class QuickWizardCommand extends QuickWizardCommandBase {
 	constructor(container: Container) {
-		super(container, [Commands.ShowLaunchpad]);
+		super(container, [Commands.ShowLaunchpad, Commands.StartWork]);
 	}
 
 	protected override preExecute(
@@ -22,6 +23,9 @@ export class QuickWizardCommand extends QuickWizardCommandBase {
 			case Commands.ShowLaunchpad:
 				return this.execute({ command: 'launchpad', ...args });
 
+			case Commands.StartWork:
+				return this.execute({ command: 'startWork', ...args });
+
 			default:
 				return this.execute(args);
 		}

src/commands/quickWizard.utils.ts

@@ -1,6 +1,7 @@
 import type { StoredRecentUsage } from '../constants.storage';
 import type { Container } from '../container';
 import { LaunchpadCommand } from '../plus/launchpad/launchpad';
+import { StartWorkCommand } from '../plus/startWork/startWork';
 import { configuration } from '../system/vscode/configuration';
 import { getContext } from '../system/vscode/context';
 import { BranchGitCommand } from './git/branch';
@@ -112,6 +113,10 @@ export class QuickWizardRootStep implements QuickPickStep<QuickCommand> {
 		if (args?.command === 'launchpad') {
 			this.hiddenItems.push(new LaunchpadCommand(container, args));
 		}
+
+		if (args?.command === 'startWork') {
+			this.hiddenItems.push(new StartWorkCommand(container));
+		}
 	}
 
 	private _command: QuickCommand | undefined;

src/constants.commands.ts

@@ -223,6 +223,7 @@ export const enum Commands {
 	ShowTimelineView = 'gitlens.showTimelineView',
 	ShowWorktreesView = 'gitlens.showWorktreesView',
 	ShowWorkspacesView = 'gitlens.showWorkspacesView',
+	StartWork = 'gitlens.startWork',
 	StashApply = 'gitlens.stashApply',
 	StashSave = 'gitlens.stashSave',
 	StashSaveFiles = 'gitlens.stashSaveFiles',

src/plus/startWork/startWork.ts

@@ -0,0 +1,187 @@
+import type { QuickInputButton } from 'vscode';
+import { ThemeIcon, Uri } from 'vscode';
+import type {
+	PartialStepState,
+	StepGenerator,
+	StepResultGenerator,
+	StepSelection,
+	StepState,
+} from '../../commands/quickCommand';
+import {
+	canPickStepContinue,
+	createPickStep,
+	endSteps,
+	QuickCommand,
+	StepResultBreak,
+} from '../../commands/quickCommand';
+import { proBadge } from '../../constants';
+import { HostingIntegrationId } from '../../constants.integrations';
+import type { Container } from '../../container';
+import type { SearchedIssue } from '../../git/models/issue';
+import type { QuickPickItemOfT } from '../../quickpicks/items/common';
+import { createDirectiveQuickPickItem, Directive } from '../../quickpicks/items/directive';
+import { fromNow } from '../../system/date';
+
+export type StartWorkItem = {
+	item: SearchedIssue;
+};
+
+export const StartWorkQuickInputButton: QuickInputButton = {
+	iconPath: new ThemeIcon('beaker'),
+	tooltip: 'Start Work on this Item',
+};
+
+export type StartWorkResult = { items: StartWorkItem[] };
+
+interface Context {
+	result: StartWorkResult;
+	title: string;
+}
+
+interface State {
+	item?: StartWorkItem;
+	action?: StartWorkAction;
+}
+
+type StartWorkStepState<T extends State = State> = RequireSome<StepState<T>, 'item'>;
+
+export type StartWorkAction = 'start';
+
+export interface StartWorkCommandArgs {
+	readonly command: 'startWork';
+}
+
+function assertsStartWorkStepState(state: StepState<State>): asserts state is StartWorkStepState {
+	if (state.item != null) return;
+
+	debugger;
+	throw new Error('Missing item');
+}
+
+export class StartWorkCommand extends QuickCommand<State> {
+	constructor(container: Container) {
+		super(container, 'startWork', 'startWork', `Start Work\u00a0\u00a0${proBadge}`, {
+			description: 'Start work on an issue',
+		});
+
+		this.initialState = {
+			counter: 0,
+		};
+	}
+
+	protected async *steps(state: PartialStepState<State>): StepGenerator {
+		if (this.container.git.isDiscoveringRepositories) {
+			await this.container.git.isDiscoveringRepositories;
+		}
+
+		const context: Context = {
+			result: { items: [] },
+			title: this.title,
+		};
+
+		while (this.canStepsContinue(state)) {
+			context.title = this.title;
+
+			await updateContextItems(this.container, context);
+
+			if (state.counter < 1 || state.item == null) {
+				const result = yield* this.pickIssueStep(state, context);
+				if (result === StepResultBreak) continue;
+				state.item = result;
+			}
+
+			assertsStartWorkStepState(state);
+			state.action = 'start';
+
+			if (typeof state.action === 'string') {
+				switch (state.action) {
+					case 'start':
+						startWork(state.item.item);
+						break;
+				}
+			}
+
+			endSteps(state);
+		}
+
+		return state.counter < 0 ? StepResultBreak : undefined;
+	}
+
+	private *pickIssueStep(state: StepState<State>, context: Context): StepResultGenerator<StartWorkItem> {
+		const buildIssueItem = (i: StartWorkItem) => {
+			const buttons = [StartWorkQuickInputButton];
+			return {
+				label:
+					i.item.issue.title.length > 60 ? `${i.item.issue.title.substring(0, 60)}...` : i.item.issue.title,
+				// description: `${i.repoAndOwner}#${i.id}, by @${i.author}`,
+				description: `\u00a0 ${i.item.issue.repository?.owner ?? ''}/${i.item.issue.repository?.repo ?? ''}#${
+					i.item.issue.id
+				} \u00a0`,
+				detail: `      ${fromNow(i.item.issue.updatedDate)} by @${i.item.issue.author.name}`,
+				buttons: buttons,
+				iconPath: i.item.issue.author?.avatarUrl != null ? Uri.parse(i.item.issue.author.avatarUrl) : undefined,
+				item: i,
+				picked: i.item.issue.id === state.item?.item?.issue.id,
+			};
+		};
+
+		const getItems = (result: StartWorkResult) => {
+			const items: QuickPickItemOfT<StartWorkItem>[] = [];
+
+			if (result.items?.length) {
+				items.push(...result.items.map(buildIssueItem));
+			}
+
+			return items;
+		};
+
+		function getItemsAndPlaceholder() {
+			if (!context.result.items.length) {
+				return {
+					placeholder: 'All done! Take a vacation',
+					items: [createDirectiveQuickPickItem(Directive.Cancel, undefined, { label: 'OK' })],
+				};
+			}
+
+			return {
+				placeholder: 'Choose an item to focus on',
+				items: getItems(context.result),
+			};
+		}
+
+		const { items, placeholder } = getItemsAndPlaceholder();
+
+		const step = createPickStep({
+			title: context.title,
+			placeholder: placeholder,
+			matchOnDescription: true,
+			matchOnDetail: true,
+			items: items,
+			onDidClickItemButton: (_quickpick, button, { item }) => {
+				if (button === StartWorkQuickInputButton) {
+					startWork(item.item);
+				}
+			},
+		});
+
+		const selection: StepSelection<typeof step> = yield step;
+		if (!canPickStepContinue(step, state, selection)) {
+			return StepResultBreak;
+		}
+		const element = selection[0];
+		return { ...element.item };
+	}
+}
+
+async function updateContextItems(container: Container, context: Context) {
+	context.result = {
+		items:
+			(await container.integrations.getMyIssues([HostingIntegrationId.GitHub]))?.map(i => ({
+				item: i,
+			})) ?? [],
+	};
+}
+
+function startWork(_issue: SearchedIssue) {
+	// TODO: Hack here
+}