flagstaff 0.0.1 → 0.2.0

package/dist/table.js

@@ -0,0 +1,69 @@
+import { width } from 'linegauge';
+import { wrap } from 'linegauge/wrap';
+import { heading, muted } from 'roundel/tokens';
+const DEFAULT_WIDTH = 80;
+const CHROME_PER_COLUMN = 3;
+const CHROME_FIXED = 1;
+const MIN_COLUMN = 3;
+const V = '│';
+const H = '─';
+const CORNERS = { topLeft: '┌', topRight: '┐', bottomLeft: '└', bottomRight: '┘', top: '┬', bottom: '┴', left: '├', right: '┤', cross: '┼' };
+const padTo = (line, cells, align) => {
+    const gap = ' '.repeat(Math.max(0, cells - width(line)));
+    return align === 'right' ? gap + line : line + gap;
+};
+function naturalWidths(rows, columns) {
+    const widths = Array.from({ length: columns }, () => 0);
+    for (const row of rows) {
+        for (let index = 0; index < columns; index += 1)
+            widths[index] = Math.max(widths[index] ?? 0, width(row[index] ?? ''));
+    }
+    return widths;
+}
+function fitWidths(natural, available) {
+    const widths = [...natural];
+    let total = widths.reduce((sum, w) => sum + w, 0);
+    while (total > available) {
+        let widest = 0;
+        for (let index = 1; index < widths.length; index += 1)
+            if ((widths[index] ?? 0) > (widths[widest] ?? 0))
+                widest = index;
+        if ((widths[widest] ?? 0) <= MIN_COLUMN)
+            break;
+        widths[widest] = (widths[widest] ?? 0) - 1;
+        total -= 1;
+    }
+    return widths;
+}
+function layoutRow(row, widths, align) {
+    const cells = widths.map((w, index) => wrap(row[index] ?? '', w, { hard: true, trim: false }).split('\n'));
+    const height = Math.max(1, ...cells.map((lines) => lines.length));
+    return Array.from({ length: height }, (_, line) => `${V} ${widths.map((w, index) => padTo(cells[index]?.[line] ?? '', w, align[index] ?? 'left')).join(` ${V} `)} ${V}`);
+}
+const rule = (widths, left, mid, right) => left + widths.map((w) => H.repeat(w + 2)).join(mid) + right;
+export function table(rows, options = {}) {
+    const columns = Math.max(options.head?.length ?? 0, ...rows.map((row) => row.length), 1);
+    const total = options.width ?? DEFAULT_WIDTH;
+    const align = options.align ?? [];
+    const available = Math.max(columns * MIN_COLUMN, total - columns * CHROME_PER_COLUMN - CHROME_FIXED);
+    const all = options.head === undefined ? rows : [options.head, ...rows];
+    const widths = fitWidths(naturalWidths(all, columns), available);
+    const out = [rule(widths, CORNERS.topLeft, CORNERS.top, CORNERS.topRight)];
+    if (options.head !== undefined) {
+        out.push(...layoutRow(options.head.map((cell) => heading(cell)), widths, align), rule(widths, CORNERS.left, CORNERS.cross, CORNERS.right));
+    }
+    for (const row of rows)
+        out.push(...layoutRow(row, widths, align));
+    out.push(rule(widths, CORNERS.bottomLeft, CORNERS.bottom, CORNERS.bottomRight));
+    return out.join('\n');
+}
+export function tableComponent(options = {}) {
+    return {
+        name: 'table',
+        static: (state) => {
+            const head = state.head ?? options.head;
+            return state.rows.map((row) => (head === undefined ? row.join('\t') : row.map((cell, index) => `${head[index] ?? index}: ${cell}`).join(', '))).join('\n');
+        },
+        frame: (_t, state) => muted(table(state.rows, state.head === undefined ? options : { ...options, head: state.head })),
+    };
+}

package/dist/tasks.d.ts

@@ -0,0 +1,18 @@
+import { type Component } from './plugin.js';
+export type TaskStatus = 'pending' | 'running' | 'ok' | 'fail' | 'warn' | 'info';
+export interface Task {
+    title: string;
+    /** `pending` when omitted. */
+    status?: TaskStatus;
+    /** A line under the title — the step's current detail, shown only on a terminal. */
+    detail?: string;
+}
+export interface TasksState {
+    tasks: Task[];
+}
+export interface TasksOptions {
+    /** The spinner style the running task is drawn with. Default `dots`. */
+    spinner?: string;
+}
+/** A task list: settled tasks one line each off a terminal, the whole list drawn on one. */
+export declare function tasks({ spinner }?: TasksOptions): Component<TasksState>;

package/dist/tasks.js

@@ -0,0 +1,31 @@
+import { error, hint, muted, ok, warn } from 'roundel/tokens';
+import { glyph, lookupSpinner } from './plugin.js';
+const PAINT = { ok, fail: error, warn, info: hint };
+const PENDING = ' ';
+const settled = (status) => status !== 'pending' && status !== 'running';
+export function tasks({ spinner = 'dots' } = {}) {
+    const style = lookupSpinner(spinner);
+    const symbol = (status, t) => {
+        if (settled(status))
+            return PAINT[status](glyph(status));
+        if (status === 'pending')
+            return muted(PENDING);
+        const at = Math.floor(t / style.interval) % style.frames.length;
+        return style.frames[at] ?? '';
+    };
+    return {
+        name: 'tasks',
+        interval: style.interval,
+        static: (state) => state.tasks
+            .filter((task) => settled(task.status ?? 'pending'))
+            .map((task) => `${PAINT[task.status](glyph(task.status))} ${task.title}`)
+            .join('\n'),
+        frame: (t, state) => state.tasks
+            .flatMap((task) => {
+            const status = task.status ?? 'pending';
+            const title = `${symbol(status, t)} ${status === 'pending' ? muted(task.title) : task.title}`;
+            return task.detail === undefined || status !== 'running' ? [title] : [title, `  ${muted(task.detail)}`];
+        })
+            .join('\n'),
+    };
+}

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "flagstaff",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "The staff the flag flies from. A terminal frame loop with a static projection for agents and screen readers, and a plugin host for spinners, progress, boxes and tables. Drop-in paths for ora, log-update, boxen and cli-table3. Zero dependencies.",
   "license": "MIT",
   "type": "module",
+  "sideEffects": false,
   "engines": {
     "node": ">=24"
   },
@@ -12,17 +13,83 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "default": "./dist/index.js"
+    },
+    "./ora": {
+      "types": "./dist/ora.d.ts",
+      "import": "./dist/ora.js",
+      "default": "./dist/ora.js"
+    },
+    "./boxen": {
+      "types": "./dist/boxen.d.ts",
+      "import": "./dist/boxen.js",
+      "default": "./dist/boxen.js"
+    },
+    "./cli-table3": {
+      "types": "./dist/cli-table3.d.ts",
+      "import": "./dist/cli-table3.js",
+      "default": "./dist/cli-table3.js"
+    },
+    "./log-update": {
+      "types": "./dist/log-update.d.ts",
+      "import": "./dist/log-update.js",
+      "default": "./dist/log-update.js"
+    },
+    "./loop": {
+      "types": "./dist/loop.d.ts",
+      "import": "./dist/loop.js",
+      "default": "./dist/loop.js"
+    },
+    "./schema.json": "./dist/schema.json",
+    "./plugin": {
+      "types": "./dist/plugin.d.ts",
+      "import": "./dist/plugin.js",
+      "default": "./dist/plugin.js"
+    },
+    "./import": {
+      "types": "./dist/import.d.ts",
+      "import": "./dist/import.js",
+      "default": "./dist/import.js"
+    },
+    "./spinner": {
+      "types": "./dist/spinner.d.ts",
+      "import": "./dist/spinner.js",
+      "default": "./dist/spinner.js"
+    },
+    "./progress": {
+      "types": "./dist/progress.d.ts",
+      "import": "./dist/progress.js",
+      "default": "./dist/progress.js"
+    },
+    "./tasks": {
+      "types": "./dist/tasks.d.ts",
+      "import": "./dist/tasks.js",
+      "default": "./dist/tasks.js"
+    },
+    "./box": {
+      "types": "./dist/box.d.ts",
+      "import": "./dist/box.js",
+      "default": "./dist/box.js"
+    },
+    "./table": {
+      "types": "./dist/table.d.ts",
+      "import": "./dist/table.js",
+      "default": "./dist/table.js"
     }
   },
+  "bin": {
+    "flagstaff": "./dist/cli.js"
+  },
   "files": [
     "dist",
     "!dist/**/*.map",
-    "!dist/**/*.test.*"
+    "!dist/**/*.test.*",
+    "THIRD-PARTY.md"
   ],
   "scripts": {
-    "build": "tsc -p tsconfig.build.json",
+    "build": "tsc -p tsconfig.build.json && node ../../scripts/strip-comments.mjs dist",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "test": "vitest run --passWithNoTests",
+    "coverage": "vitest run --coverage.enabled",
     "lint": "eslint src"
   },
   "repository": {
@@ -47,7 +114,13 @@
     "cli-table3",
     "plugins"
   ],
+  "dependencies": {
+    "linegauge": "^0.1.0",
+    "roundel": "^0.2.0"
+  },
   "devDependencies": {
-    "vitest": "^4.0.0"
+    "cli-boxes": "^4.0.1",
+    "cli-spinners": "^3.2.0",
+    "vitest": "^5.0.0"
   }
 }