mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-19 21:46:49 +00:00
jubnl
80 lines
3.7 KiB
TypeScript
80 lines
3.7 KiB
TypeScript
/**
|
|
* The top-level menu shown when `trek-plugin-sdk` is run with no command in a
|
|
* terminal (#plugins). It only picks WHICH command to run — the dispatcher then
|
|
* runs it through the same interactive path a named command would take, so each
|
|
* command still prompts for whatever it needs.
|
|
*/
|
|
import { intro, outro, promptSelect } from './ui.js';
|
|
|
|
export interface MenuItem {
|
|
value: string;
|
|
label: string;
|
|
hint: string;
|
|
}
|
|
|
|
/**
|
|
* The path, in the order you walk it — create, then dev, then status, then publish. The menu is
|
|
* often the first thing a new author ever sees, so its ORDER is the only documentation some of
|
|
* them will read. `validate` and `pack` moved to Advanced: `status` says everything `validate`
|
|
* says and tells you what to do about it, and `publish` packs for you.
|
|
*/
|
|
export const PRIMARY_MENU: MenuItem[] = [
|
|
{ value: 'create', label: 'Create a plugin', hint: 'Scaffold a new plugin' },
|
|
{ value: 'dev', label: 'Run the dev server', hint: 'Live-reload your plugin locally' },
|
|
{ value: 'status', label: 'Status', hint: "Where am I? What's left before I can publish?" },
|
|
{ value: 'shot', label: 'Screenshot', hint: 'Capture docs/screenshot.png (the registry needs one)' },
|
|
{ value: 'publish', label: 'Publish', hint: 'Check → release → open the registry PR' },
|
|
{ value: 'advanced', label: 'Advanced…', hint: 'Validate, pack, signing, registry entry' },
|
|
{ value: 'exit', label: 'Exit', hint: '' },
|
|
];
|
|
|
|
/** Real commands, just not ones you need in order to publish a plugin. */
|
|
export const ADVANCED_MENU: MenuItem[] = [
|
|
{ value: 'validate', label: 'Validate', hint: 'The gate: same checks as status, but it exits non-zero' },
|
|
{ value: 'pack', label: 'Pack', hint: 'Build plugin.zip without releasing it' },
|
|
{ value: 'keygen', label: 'Generate a signing key', hint: 'Create an Ed25519 signing key' },
|
|
{ value: 'sign', label: 'Sign an artifact', hint: 'Print a signature + public key' },
|
|
{ value: 'rotate-key', label: 'Rotate signing key', hint: 'Re-sign every published version with a NEW key' },
|
|
{ value: 'entry', label: 'Registry entry', hint: 'Print the ready-to-PR registry JSON' },
|
|
{ value: 'preflight', label: 'Preflight', hint: 'The registry checks that need the release to exist' },
|
|
{ value: 'submit', label: 'Submit', hint: 'Open the registry PR' },
|
|
{ value: 'release', label: 'Release', hint: 'Pack → GitHub release → print entry' },
|
|
{ value: 'unrelease', label: 'Unrelease', hint: 'Delete a stranded tag + release (never a published one)' },
|
|
{ value: 'back', label: '← Back', hint: '' },
|
|
];
|
|
|
|
/** Every value the menu can yield, control entries included. */
|
|
const MENU_VALUES = new Set([...PRIMARY_MENU, ...ADVANCED_MENU].map((m) => m.value));
|
|
|
|
/** Pure: a menu value maps to itself when known, else `undefined`. Unit-tested. */
|
|
export function resolveMenuChoice(value: string): string | undefined {
|
|
return MENU_VALUES.has(value) ? value : undefined;
|
|
}
|
|
|
|
const toOptions = (items: MenuItem[]) =>
|
|
items.map(({ value, label, hint }) => (hint ? { value, label, hint } : { value, label }));
|
|
|
|
/**
|
|
* Show the menu and return the chosen command name for the dispatcher to run,
|
|
* or `null` if the user chose Exit. Loops back from the Advanced submenu.
|
|
*/
|
|
export async function runMenu(): Promise<string | null> {
|
|
intro('trek-plugin-sdk');
|
|
for (;;) {
|
|
const choice = await promptSelect<string>({
|
|
message: 'What would you like to do?',
|
|
options: toOptions(PRIMARY_MENU),
|
|
});
|
|
if (choice === 'exit') {
|
|
outro('Nothing to do — bye!');
|
|
return null;
|
|
}
|
|
if (choice === 'advanced') {
|
|
const adv = await promptSelect<string>({ message: 'Advanced commands', options: toOptions(ADVANCED_MENU) });
|
|
if (adv === 'back') continue;
|
|
return adv;
|
|
}
|
|
return choice;
|
|
}
|
|
}
|