docugate 0.3.0 → 0.3.1

package/dist/banner.d.ts

@@ -1,5 +1,5 @@
 export declare const TAGLINE = "Tours and docs for your codebase";
-/** The wordmark as five plain lines, no color. */
+/** The wordmark as two plain lines, no color. */
 export declare function wordmark(text?: string, gap?: number): string[];
 export declare function packageVersion(): string;
 export type BannerOptions = {

package/dist/banner.js

@@ -1,43 +1,36 @@
 import { readFileSync } from 'node:fs';
-import { colorDepth, fg, logoBanner } from './logo.js';
+import { colorDepth, fg } from './logo.js';
 import { colorOn, isMintty } from './ui.js';
-// The banner: DOCUGATE in block letters, shaded from cream to gold like the
-// owl, with the tagline and version under it. It adapts to where it is drawn:
-// beside the owl in a wide terminal, alone in a normal one, as a single line
-// in a narrow one, and without color when color is off. It is only ever
-// printed to a real terminal, so logs and CI never see it.
+// The banner: DOCUGATE in a compact two-row block font, cream over gold
+// like the owl, with the version beside it. Small on purpose: it sits above
+// the menu, and the menu is what the person came for. A narrow terminal gets
+// one line, and without color it is plain text. It is only ever printed to a
+// person at a terminal, so logs and CI never see it.
 export const TAGLINE = 'Tours and docs for your codebase';
-const SITE = 'https://www.trydocugate.site';
-// A five-row block font, just the letters in the name. Every glyph is five
-// columns wide, so the wordmark's width is simply letters * 5 + gaps.
+// Two rows per letter, three columns wide, drawn with half blocks.
 const GLYPHS = {
-    D: ['████ ', '█   █', '█   █', '█   █', '████ '],
-    O: [' ███ ', '█   █', '█   █', '█   █', ' ███ '],
-    C: [' ████', '█    ', '█    ', '█    ', ' ████'],
-    U: ['█   █', '█   █', '█   █', '█   █', ' ███ '],
-    G: [' ████', '█    ', '█  ██', '█   █', ' ████'],
-    A: [' ███ ', '█   █', '█████', '█   █', '█   █'],
-    T: ['█████', '  █  ', '  █  ', '  █  ', '  █  '],
-    E: ['█████', '█    ', '████ ', '█    ', '█████'],
+    D: ['█▀▄', '█▄▀'],
+    O: ['█▀█', '█▄█'],
+    C: ['█▀▀', '█▄▄'],
+    U: ['█ █', '█▄█'],
+    G: ['█▀▀', '█▄█'],
+    A: ['▄▀█', '█▀█'],
+    T: ['▀█▀', ' █ '],
+    E: ['█▀▀', '██▄'],
 };
-// Cream at the top, through gold, to deep gold at the bottom.
+// Cream on the top row, gold on the bottom.
 const SHADES = [
     [245, 240, 227],
-    [246, 222, 150],
     [244, 196, 63],
-    [230, 175, 46],
-    [217, 154, 30],
 ];
 /** Narrower than this and the wordmark would wrap, so one line is shown. */
-const WORDMARK_MIN_COLUMNS = 60;
-/** Wide enough for the owl beside the wordmark. */
-const OWL_MIN_COLUMNS = 96;
-/** The wordmark as five plain lines, no color. */
-export function wordmark(text = 'DOCUGATE', gap = 2) {
+const WORDMARK_MIN_COLUMNS = 40;
+/** The wordmark as two plain lines, no color. */
+export function wordmark(text = 'DOCUGATE', gap = 1) {
     const letters = [...text.toUpperCase()].map((c) => GLYPHS[c]);
     if (letters.some((g) => !g))
         throw new Error(`The banner font has no glyph for every letter of "${text}".`);
-    return [0, 1, 2, 3, 4].map((row) => letters.map((g) => g[row]).join(' '.repeat(gap)).trimEnd());
+    return [0, 1].map((row) => letters.map((g) => g[row]).join(' '.repeat(gap)).trimEnd());
 }
 export function packageVersion() {
     const pkg = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8'));
@@ -48,15 +41,10 @@ export function banner(options = {}) {
     const { 
     // mintty reports no width to a piped console; COLUMNS, or a usual window, stands in.
     columns = process.stdout.columns ?? (Number(process.env.COLUMNS) || (isMintty() ? 100 : 0)), color = colorOn(), version = packageVersion(), env = process.env, } = options;
-    const dim = (t) => (color ? `\x1b[2m${t}\x1b[0m` : t);
-    if (columns < WORDMARK_MIN_COLUMNS) {
-        const full = `  DocuGate · ${TAGLINE} · v${version}`;
-        return ['', full.length <= columns ? full : `  DocuGate v${version}`, ''];
-    }
+    const dim = (t) => (color ? `${t}` : t);
+    if (columns < WORDMARK_MIN_COLUMNS)
+        return ['', `  DocuGate ${dim(`v${version}`)}`, ''];
     const depth = colorDepth(env);
-    const art = wordmark().map((line, row) => (color ? `${fg(SHADES[row], depth)}${line}\x1b[0m` : line));
-    const text = [...art, '', dim(TAGLINE), dim(`v${version} · ${SITE}`)];
-    if (color && columns >= OWL_MIN_COLUMNS)
-        return logoBanner(text, env);
-    return ['', ...text.map((t) => (t ? `  ${t}` : '')), ''];
+    const [top, bottom] = wordmark().map((line, row) => (color ? `${fg(SHADES[row], depth)}${line}` : line));
+    return ['', `  ${top}`, `  ${bottom}  ${dim(`v${version}`)}`, ''];
 }

package/dist/menu.d.ts

@@ -7,10 +7,23 @@ export type Action = string[];
 export declare function buildChoices(s: Status, now?: Date): Choice<Action>[];
 /** The line under the list: who you are, and the one thing worth doing. */
 export declare function menuNote(s: Status, now?: Date): string;
+/** Who is signed in: the one line the launch screen keeps above the list. */
+export declare function whoNote(s: Status): string;
+export type Section = 'main' | 'tours' | 'more';
+/**
+ * The launch menu, short enough to see at once: the few things people come
+ * for on the first screen, the rest one step away under Tours and More. A step
+ * that cannot run yet is left out rather than shown greyed, so every line is
+ * something to do. Labels and rules come from buildChoices, written once.
+ */
+export declare function buildMenu(s: Status, section: Section): Choice<Action>[];
 export type MenuDeps = {
     pick?: typeof select<Action>;
     /** For terminals that cannot do arrow keys: a numbered list instead. */
     numbered?: boolean;
 };
-/** Shows the menu and returns what was chosen, or null to quit. */
+/**
+ * Shows the menu and returns the command chosen, or null to quit. Tours and
+ * More open their own short list, with Back to return.
+ */
 export declare function runMenu(status: Status, deps?: MenuDeps): Promise<Action | null>;

package/dist/menu.js

@@ -130,26 +130,82 @@ export function menuNote(s, now = new Date()) {
     }
     return dim(bits.join(' · '));
 }
-/** Shows the menu and returns what was chosen, or null to quit. */
+/** Who is signed in: the one line the launch screen keeps above the list. */
+export function whoNote(s) {
+    if (s.account.state === 'signed-in')
+        return `signed in as ${gold(`@${s.account.login}`)}`;
+    return dim(s.account.state === 'offline' ? 'offline' : 'not signed in');
+}
+/** Values that move around the menu rather than run a command. */
+const GO = { tours: ['@tours'], more: ['@more'], back: ['@back'], quit: ['@quit'] };
+/**
+ * The launch menu, short enough to see at once: the few things people come
+ * for on the first screen, the rest one step away under Tours and More. A step
+ * that cannot run yet is left out rather than shown greyed, so every line is
+ * something to do. Labels and rules come from buildChoices, written once.
+ */
+export function buildMenu(s, section) {
+    const all = buildChoices(s);
+    const pick = (...commands) => commands
+        .map((command) => all.find((c) => c.value.join(' ') === command))
+        .filter((c) => Boolean(c && !c.disabled))
+        .map((c) => ({ ...c, status: undefined, recommended: c.recommended }));
+    if (section === 'tours') {
+        return [...pick('tour init', 'tour install', 'tour serve'), { value: [...GO.back], label: 'Back' }];
+    }
+    if (section === 'more') {
+        const hook = all.find((c) => c.value[0] === 'sync' && c.value[1] === 'hook');
+        return [
+            ...pick('sync --dry-run', 'sync init', ...(hook ? [hook.value.join(' ')] : []), 'status', 'openapi', 'help'),
+            { value: [...GO.back], label: 'Back' },
+        ];
+    }
+    const signedIn = s.account.state === 'signed-in';
+    return [
+        ...pick('developers', 'init', 'sync', 'check'),
+        { value: [...GO.tours], label: 'Tours' },
+        { value: [...GO.more], label: 'More' },
+        ...pick(signedIn ? 'logout' : 'login'),
+        { value: [...GO.quit], label: 'Quit' },
+    ];
+}
+/**
+ * Shows the menu and returns the command chosen, or null to quit. Tours and
+ * More open their own short list, with Back to return.
+ */
 export async function runMenu(status, deps = {}) {
-    const choices = buildChoices(status);
-    if (deps.numbered)
-        return numbered(choices, status);
     const pick = deps.pick ?? select;
-    return pick({ title: 'What next?', choices, note: menuNote(status), rows: 8 });
+    let section = 'main';
+    for (;;) {
+        const choices = buildMenu(status, section);
+        const note = section === 'main' ? whoNote(status) : dim(section === 'tours' ? 'Tours' : 'More');
+        const chosen = deps.numbered ? await numbered(choices, note) : await pick({ choices, note, minimal: true });
+        if (!chosen || chosen[0] === GO.quit[0])
+            return null;
+        if (chosen[0] === GO.back[0])
+            section = 'main';
+        else if (chosen[0] === GO.tours[0])
+            section = 'tours';
+        else if (chosen[0] === GO.more[0])
+            section = 'more';
+        else
+            return chosen;
+    }
 }
-async function numbered(choices, status) {
-    const usable = choices.filter((c) => !c.disabled);
-    console.log(`\n  ${bold('What next?')}  ${menuNote(status)}\n`);
-    usable.forEach((c, i) => console.log(`  ${gold(String(i + 1).padStart(2))}  ${c.label}${c.recommended ? gold('  ●') : ''}${c.status ? dim(`  ${c.status}`) : ''}`));
+async function numbered(choices, note) {
+    console.log(`
+  ${note}
+`);
+    choices.forEach((c, i) => console.log(`  ${dim(String(i + 1).padStart(2))}  ${c.label}`));
     const rl = createInterface({ input: process.stdin, output: process.stdout });
     try {
-        const def = Math.max(0, usable.findIndex((c) => c.recommended)) + 1;
-        const answer = (await rl.question(`\n  Choose 1-${usable.length}, or q to quit ${dim(`[${def}]`)}: `)).trim().toLowerCase();
+        const def = Math.max(0, choices.findIndex((c) => c.recommended)) + 1;
+        const answer = (await rl.question(`
+  ${dim(`Choose 1-${choices.length} [${def}]`)}: `)).trim().toLowerCase();
         if (answer === 'q')
             return null;
         const n = answer === '' ? def : Number(answer);
-        return Number.isInteger(n) && usable[n - 1] ? usable[n - 1].value : null;
+        return Number.isInteger(n) && choices[n - 1] ? choices[n - 1].value : null;
     }
     finally {
         rl.close();

package/dist/select.d.ts

@@ -41,7 +41,9 @@ export type KeyResult<T> = {
     state: PickerState;
 };
 /** One key press, applied to the picker's state. */
-export declare function handleKey<T>(choices: Choice<T>[], state: PickerState, str: string | undefined, key: Key, rows: number): KeyResult<T>;
+export declare function handleKey<T>(choices: Choice<T>[], state: PickerState, str: string | undefined, key: Key, rows: number, 
+/** False for a short menu: letters do not search, a number picks, q quits. */
+search?: boolean): KeyResult<T>;
 export type RenderOptions = {
     title?: string;
     width: number;
@@ -49,6 +51,8 @@ export type RenderOptions = {
     footer?: string;
     note?: string;
     legend?: boolean;
+    /** Just the note and a numbered list: no search, rules, description, legend or key hints. */
+    minimal?: boolean;
 };
 /** The picker as lines of text. */
 export declare function renderPicker<T>(choices: Choice<T>[], state: PickerState, o: RenderOptions): string[];
@@ -65,6 +69,8 @@ export type SelectOptions<T> = {
     /** How many choices show at once. */
     rows?: number;
     legend?: boolean;
+    /** The short form: see renderPicker. Every choice shows; a number picks one. */
+    minimal?: boolean;
 };
 /** Whether there is a real terminal to draw a picker in. */
 export declare const canPick: (io?: PickerIO) => boolean;

package/dist/select.js

@@ -43,8 +43,21 @@ function step(list, from, dir) {
     return clamp(from + dir, 0, Math.max(0, list.length - 1));
 }
 /** One key press, applied to the picker's state. */
-export function handleKey(choices, state, str, key, rows) {
+export function handleKey(choices, state, str, key, rows, 
+/** False for a short menu: letters do not search, a number picks, q quits. */
+search = true) {
     const list = filterChoices(choices, state.query);
+    if (!search && str && !key.ctrl && !key.meta) {
+        if (str === 'q')
+            return { done: 'cancelled' };
+        const n = Number(str);
+        if (Number.isInteger(n) && n >= 1 && n <= list.length) {
+            const choice = list[n - 1];
+            return choice.disabled ? { done: 'blocked', reason: choice.disabled, state: { ...state, cursor: n - 1 } } : { done: 'chosen', choice };
+        }
+        if (key.name !== 'return' && key.name !== 'enter')
+            return { state };
+    }
     const move = (cursor) => {
         const c = clamp(cursor, 0, Math.max(0, list.length - 1));
         const top = c < state.top ? c : c >= state.top + rows ? c - rows + 1 : state.top;
@@ -94,9 +107,28 @@ const fit = (text, width) => {
     // Over width: cut the plain text. Color is not worth keeping on a line this long.
     return `${plain.slice(0, Math.max(0, width - 1))}…`;
 };
+/**
+ * The short form: the note, then every choice on its own numbered line. Short
+ * enough never to scroll, and every line cut to the width so none can wrap,
+ * which is what kept the redraw in step with what is on screen.
+ */
+function renderMinimal(list, state, o) {
+    const lines = [];
+    if (o.note)
+        lines.push(`  ${o.note}`, '');
+    list.forEach((c, i) => {
+        const at = i === state.cursor;
+        const n = dim(String(i + 1).padStart(2));
+        const label = at ? bold(gold(c.label)) : c.disabled ? dim(c.label) : c.label;
+        lines.push(`  ${at ? gold('❯') : ' '} ${n}  ${label}`);
+    });
+    return lines.map((l) => fit(l, o.width - 1));
+}
 /** The picker as lines of text. */
 export function renderPicker(choices, state, o) {
     const list = filterChoices(choices, state.query);
+    if (o.minimal)
+        return renderMinimal(list, state, o);
     const rule = dim('─'.repeat(Math.max(10, Math.min(o.width - 4, 78))));
     const lines = [];
     const w = o.width - 2;
@@ -156,7 +188,7 @@ export const canPick = (io = { stdin: process.stdin, stdout: process.stdout }) =
  */
 export function select(options, io = { stdin: process.stdin, stdout: process.stdout }) {
     const { stdin, stdout } = io;
-    const rows = Math.max(3, Math.min(options.rows ?? 8, (stdout.rows ?? 24) - 14));
+    const rows = options.minimal ? options.choices.length : Math.max(3, Math.min(options.rows ?? 8, (stdout.rows ?? 24) - 14));
     const color = colorOn();
     let state = { query: '', cursor: initialCursor(options.choices), top: 0 };
     state.top = Math.max(0, state.cursor - rows + 1);
@@ -171,6 +203,7 @@ export function select(options, io = { stdin: process.stdin, stdout: process.std
             footer: options.footer,
             note,
             legend: options.legend,
+            minimal: options.minimal,
         });
         stdout.write(`${drawn ? `\x1b[${drawn}A\r` : ''}\x1b[0J${hint(lines.join('\n'))}\n`);
         drawn = lines.length;
@@ -193,7 +226,7 @@ export function select(options, io = { stdin: process.stdin, stdout: process.std
             resolve(value);
         };
         const onKey = (str, key = {}) => {
-            const result = handleKey(options.choices, state, str, key, rows);
+            const result = handleKey(options.choices, state, str, key, rows, !options.minimal);
             if ('done' in result) {
                 if (result.done === 'cancelled')
                     return finish(null);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docugate",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Command-line tools for DocuGate: set up, check and prepare the documentation DocuGate reads straight from your repository. Also checks DocuGate API keys from Express, Hono and Fastify.",
   "type": "module",
   "bin": {