@sigx/cli 0.2.8 → 0.3.1

package/dist/commands/scaffold.js

@@ -0,0 +1,165 @@
+import { existsSync, mkdirSync, readFileSync, readdirSync, statSync, writeFileSync } from "fs";
+import { dirname, join, resolve } from "path";
+import { fileURLToPath } from "url";
+//#region src/commands/scaffold.ts
+/**
+* Pure scaffolding helpers shared by the interactive and headless `create`
+* paths — template copy with `{{projectName}}` substitution, gitignore
+* rename, binary-safe asset copy, and workspace dependency patching.
+*/
+var __dirname = dirname(fileURLToPath(import.meta.url));
+var projectTypeOptions = [
+	{
+		value: "basic",
+		label: "Basic SPA",
+		description: "Simple single-page application (web)"
+	},
+	{
+		value: "ssr",
+		label: "SSR",
+		description: "Server-side rendering with Express (web)"
+	},
+	{
+		value: "ssg",
+		label: "SSG",
+		description: "Static site with file-based routing & MDX (web)"
+	},
+	{
+		value: "lynx",
+		label: "Lynx",
+		description: "Native mobile app with Lynx runtime"
+	}
+];
+var webStylingOptions = [
+	{
+		value: "none",
+		label: "None",
+		description: "No CSS framework"
+	},
+	{
+		value: "tailwind",
+		label: "Tailwind CSS",
+		description: "Utility-first CSS framework"
+	},
+	{
+		value: "daisyui",
+		label: "Tailwind + Daisy UI",
+		description: "Tailwind with component library"
+	}
+];
+var lynxStylingOptions = [
+	{
+		value: "none",
+		label: "None",
+		description: "No CSS framework"
+	},
+	{
+		value: "tailwind",
+		label: "Tailwind CSS",
+		description: "Tailwind with Lynx preset"
+	},
+	{
+		value: "daisyui",
+		label: "Tailwind + Daisy UI",
+		description: "Lynx + @sigx/lynx-daisyui components"
+	}
+];
+var TEXT_EXTS = new Set([
+	"ts",
+	"tsx",
+	"js",
+	"jsx",
+	"mjs",
+	"cjs",
+	"mts",
+	"cts",
+	"json",
+	"json5",
+	"jsonc",
+	"md",
+	"mdx",
+	"txt",
+	"html",
+	"htm",
+	"css",
+	"scss",
+	"sass",
+	"less",
+	"yml",
+	"yaml",
+	"toml",
+	"xml",
+	"svg",
+	"gitignore",
+	"gitattributes",
+	"editorconfig",
+	"npmrc",
+	"nvmrc",
+	"env"
+]);
+function isTextExtension(filename) {
+	const ext = filename.startsWith(".") ? filename.slice(1).toLowerCase() : filename.split(".").pop()?.toLowerCase() ?? "";
+	return TEXT_EXTS.has(ext);
+}
+function copyDirectory(src, dest, projectName) {
+	if (!existsSync(dest)) mkdirSync(dest, { recursive: true });
+	const entries = readdirSync(src);
+	for (const entry of entries) {
+		const srcPath = join(src, entry);
+		const destPath = join(dest, entry === "gitignore" ? ".gitignore" : entry);
+		if (statSync(srcPath).isDirectory()) copyDirectory(srcPath, destPath, projectName);
+		else if (isTextExtension(entry)) {
+			let content = readFileSync(srcPath, "utf-8");
+			content = content.replace(/\{\{projectName\}\}/g, projectName);
+			writeFileSync(destPath, content);
+		} else writeFileSync(destPath, readFileSync(srcPath));
+	}
+}
+/**
+* Detect if the target directory is inside a pnpm workspace that includes @sigx packages.
+* If so, rewrite @sigx/* dependency versions to workspace:* in package.json.
+*/
+function patchWorkspaceDeps(targetDir) {
+	const pkgPath = join(targetDir, "package.json");
+	if (!existsSync(pkgPath)) return;
+	let dir = dirname(targetDir);
+	let isWorkspace = false;
+	for (let i = 0; i < 10; i++) {
+		if (existsSync(join(dir, "pnpm-workspace.yaml"))) {
+			isWorkspace = true;
+			break;
+		}
+		const parent = dirname(dir);
+		if (parent === dir) break;
+		dir = parent;
+	}
+	if (!isWorkspace) return;
+	const pkg = JSON.parse(readFileSync(pkgPath, "utf-8"));
+	for (const section of ["dependencies", "devDependencies"]) {
+		if (!pkg[section]) continue;
+		for (const dep of Object.keys(pkg[section])) if (dep.startsWith("@sigx/")) pkg[section][dep] = "workspace:*";
+	}
+	writeFileSync(pkgPath, JSON.stringify(pkg, null, 4) + "\n");
+}
+function scaffoldProject(opts) {
+	const targetDir = resolve(process.cwd(), opts.projectName);
+	let templateName;
+	if (opts.projectType === "lynx") templateName = opts.styling !== "none" ? `lynx-${opts.styling}` : "lynx";
+	else templateName = opts.styling !== "none" ? `${opts.projectType}-${opts.styling}` : opts.projectType;
+	const templateDir = resolve(__dirname, "..", "templates", templateName);
+	if (existsSync(targetDir)) return {
+		ok: false,
+		error: `Directory "${opts.projectName}" already exists!`
+	};
+	if (!existsSync(templateDir)) return {
+		ok: false,
+		error: `Template "${templateName}" not found at ${templateDir}`
+	};
+	copyDirectory(templateDir, targetDir, opts.projectName);
+	patchWorkspaceDeps(targetDir);
+	return { ok: true };
+}
+//#endregion
+export { copyDirectory, isTextExtension, lynxStylingOptions, patchWorkspaceDeps, projectTypeOptions, scaffoldProject, webStylingOptions };
+
+//# sourceMappingURL=scaffold.js.map

package/dist/commands/scaffold.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffold.js","names":[],"sources":["../../src/commands/scaffold.ts"],"sourcesContent":["/**\n * Pure scaffolding helpers shared by the interactive and headless `create`\n * paths — template copy with `{{projectName}}` substitution, gitignore\n * rename, binary-safe asset copy, and workspace dependency patching.\n */\nimport { existsSync, mkdirSync, readdirSync, statSync, writeFileSync, readFileSync } from 'fs';\nimport { dirname, resolve, join } from 'path';\nimport { fileURLToPath } from 'url';\n\nconst __dirname = dirname(fileURLToPath(import.meta.url));\n\nexport type ProjectType = 'basic' | 'ssr' | 'ssg' | 'lynx';\nexport type Styling = 'none' | 'tailwind' | 'daisyui';\n\nexport const projectTypeOptions = [\n    { value: 'basic' as ProjectType, label: 'Basic SPA', description: 'Simple single-page application (web)' },\n    { value: 'ssr' as ProjectType, label: 'SSR', description: 'Server-side rendering with Express (web)' },\n    { value: 'ssg' as ProjectType, label: 'SSG', description: 'Static site with file-based routing & MDX (web)' },\n    { value: 'lynx' as ProjectType, label: 'Lynx', description: 'Native mobile app with Lynx runtime' },\n];\n\nexport const webStylingOptions = [\n    { value: 'none' as Styling, label: 'None', description: 'No CSS framework' },\n    { value: 'tailwind' as Styling, label: 'Tailwind CSS', description: 'Utility-first CSS framework' },\n    { value: 'daisyui' as Styling, label: 'Tailwind + Daisy UI', description: 'Tailwind with component library' },\n];\n\nexport const lynxStylingOptions = [\n    { value: 'none' as Styling, label: 'None', description: 'No CSS framework' },\n    { value: 'tailwind' as Styling, label: 'Tailwind CSS', description: 'Tailwind with Lynx preset' },\n    { value: 'daisyui' as Styling, label: 'Tailwind + Daisy UI', description: 'Lynx + @sigx/lynx-daisyui components' },\n];\n\nconst TEXT_EXTS = new Set([\n    'ts', 'tsx', 'js', 'jsx', 'mjs', 'cjs', 'mts', 'cts',\n    'json', 'json5', 'jsonc',\n    'md', 'mdx', 'txt',\n    'html', 'htm', 'css', 'scss', 'sass', 'less',\n    'yml', 'yaml', 'toml', 'xml', 'svg',\n    'gitignore', 'gitattributes', 'editorconfig', 'npmrc', 'nvmrc', 'env',\n]);\n\nexport function isTextExtension(filename: string): boolean {\n    // Dotfiles: name after leading dot (.gitignore → \"gitignore\").\n    const ext = filename.startsWith('.')\n        ? filename.slice(1).toLowerCase()\n        : filename.split('.').pop()?.toLowerCase() ?? '';\n    return TEXT_EXTS.has(ext);\n}\n\nexport function copyDirectory(src: string, dest: string, projectName: string) {\n    if (!existsSync(dest)) {\n        mkdirSync(dest, { recursive: true });\n    }\n\n    const entries = readdirSync(src);\n    for (const entry of entries) {\n        const srcPath = join(src, entry);\n        // Templates ship `gitignore` (no leading dot) because npm strips\n        // `.gitignore` from the published tarball. Rename on copy so the\n        // generated project has a real `.gitignore`.\n        const destName = entry === 'gitignore' ? '.gitignore' : entry;\n        const destPath = join(dest, destName);\n        const stat = statSync(srcPath);\n\n        if (stat.isDirectory()) {\n            copyDirectory(srcPath, destPath, projectName);\n        } else if (isTextExtension(entry)) {\n            let content = readFileSync(srcPath, 'utf-8');\n            content = content.replace(/\\{\\{projectName\\}\\}/g, projectName);\n            writeFileSync(destPath, content);\n        } else {\n            // Binary asset — copy bytes verbatim. Reading as UTF-8 would corrupt\n            // non-ASCII bytes (e.g. PNG magic 0x89 → U+FFFD).\n            writeFileSync(destPath, readFileSync(srcPath));\n        }\n    }\n}\n\n/**\n * Detect if the target directory is inside a pnpm workspace that includes @sigx packages.\n * If so, rewrite @sigx/* dependency versions to workspace:* in package.json.\n */\nexport function patchWorkspaceDeps(targetDir: string) {\n    const pkgPath = join(targetDir, 'package.json');\n    if (!existsSync(pkgPath)) return;\n\n    // Walk up to find pnpm-workspace.yaml\n    let dir = dirname(targetDir);\n    let isWorkspace = false;\n    for (let i = 0; i < 10; i++) {\n        if (existsSync(join(dir, 'pnpm-workspace.yaml'))) {\n            isWorkspace = true;\n            break;\n        }\n        const parent = dirname(dir);\n        if (parent === dir) break;\n        dir = parent;\n    }\n    if (!isWorkspace) return;\n\n    const pkg = JSON.parse(readFileSync(pkgPath, 'utf-8'));\n    for (const section of ['dependencies', 'devDependencies'] as const) {\n        if (!pkg[section]) continue;\n        for (const dep of Object.keys(pkg[section])) {\n            if (dep.startsWith('@sigx/')) {\n                pkg[section][dep] = 'workspace:*';\n            }\n        }\n    }\n    writeFileSync(pkgPath, JSON.stringify(pkg, null, 4) + '\\n');\n}\n\nexport function scaffoldProject(opts: {\n    projectName: string;\n    projectType: ProjectType;\n    styling: Styling;\n}): { ok: true } | { ok: false; error: string } {\n    const targetDir = resolve(process.cwd(), opts.projectName);\n    let templateName: string;\n    if (opts.projectType === 'lynx') {\n        templateName = opts.styling !== 'none' ? `lynx-${opts.styling}` : 'lynx';\n    } else {\n        templateName = opts.styling !== 'none' ? `${opts.projectType}-${opts.styling}` : opts.projectType;\n    }\n    const templateDir = resolve(__dirname, '..', 'templates', templateName);\n    if (existsSync(targetDir)) return { ok: false, error: `Directory \"${opts.projectName}\" already exists!` };\n    if (!existsSync(templateDir)) return { ok: false, error: `Template \"${templateName}\" not found at ${templateDir}` };\n    copyDirectory(templateDir, targetDir, opts.projectName);\n    patchWorkspaceDeps(targetDir);\n    return { ok: true };\n}\n"],"mappings":";;;;;;;;;AASA,IAAM,YAAY,QAAQ,cAAc,OAAO,KAAK,IAAI,CAAC;AAKzD,IAAa,qBAAqB;CAC9B;EAAE,OAAO;EAAwB,OAAO;EAAa,aAAa;EAAwC;CAC1G;EAAE,OAAO;EAAsB,OAAO;EAAO,aAAa;EAA4C;CACtG;EAAE,OAAO;EAAsB,OAAO;EAAO,aAAa;EAAmD;CAC7G;EAAE,OAAO;EAAuB,OAAO;EAAQ,aAAa;EAAuC;CACtG;AAED,IAAa,oBAAoB;CAC7B;EAAE,OAAO;EAAmB,OAAO;EAAQ,aAAa;EAAoB;CAC5E;EAAE,OAAO;EAAuB,OAAO;EAAgB,aAAa;EAA+B;CACnG;EAAE,OAAO;EAAsB,OAAO;EAAuB,aAAa;EAAmC;CAChH;AAED,IAAa,qBAAqB;CAC9B;EAAE,OAAO;EAAmB,OAAO;EAAQ,aAAa;EAAoB;CAC5E;EAAE,OAAO;EAAuB,OAAO;EAAgB,aAAa;EAA6B;CACjG;EAAE,OAAO;EAAsB,OAAO;EAAuB,aAAa;EAAwC;CACrH;AAED,IAAM,YAAY,IAAI,IAAI;CACtB;CAAM;CAAO;CAAM;CAAO;CAAO;CAAO;CAAO;CAC/C;CAAQ;CAAS;CACjB;CAAM;CAAO;CACb;CAAQ;CAAO;CAAO;CAAQ;CAAQ;CACtC;CAAO;CAAQ;CAAQ;CAAO;CAC9B;CAAa;CAAiB;CAAgB;CAAS;CAAS;CACnE,CAAC;AAEF,SAAgB,gBAAgB,UAA2B;CAEvD,MAAM,MAAM,SAAS,WAAW,IAAI,GAC9B,SAAS,MAAM,EAAE,CAAC,aAAa,GAC/B,SAAS,MAAM,IAAI,CAAC,KAAK,EAAE,aAAa,IAAI;CAClD,OAAO,UAAU,IAAI,IAAI;;AAG7B,SAAgB,cAAc,KAAa,MAAc,aAAqB;CAC1E,IAAI,CAAC,WAAW,KAAK,EACjB,UAAU,MAAM,EAAE,WAAW,MAAM,CAAC;CAGxC,MAAM,UAAU,YAAY,IAAI;CAChC,KAAK,MAAM,SAAS,SAAS;EACzB,MAAM,UAAU,KAAK,KAAK,MAAM;EAKhC,MAAM,WAAW,KAAK,MADL,UAAU,cAAc,eAAe,MACnB;EAGrC,IAFa,SAAS,QAElB,CAAK,aAAa,EAClB,cAAc,SAAS,UAAU,YAAY;OAC1C,IAAI,gBAAgB,MAAM,EAAE;GAC/B,IAAI,UAAU,aAAa,SAAS,QAAQ;GAC5C,UAAU,QAAQ,QAAQ,wBAAwB,YAAY;GAC9D,cAAc,UAAU,QAAQ;SAIhC,cAAc,UAAU,aAAa,QAAQ,CAAC;;;;;;;AAS1D,SAAgB,mBAAmB,WAAmB;CAClD,MAAM,UAAU,KAAK,WAAW,eAAe;CAC/C,IAAI,CAAC,WAAW,QAAQ,EAAE;CAG1B,IAAI,MAAM,QAAQ,UAAU;CAC5B,IAAI,cAAc;CAClB,KAAK,IAAI,IAAI,GAAG,IAAI,IAAI,KAAK;EACzB,IAAI,WAAW,KAAK,KAAK,sBAAsB,CAAC,EAAE;GAC9C,cAAc;GACd;;EAEJ,MAAM,SAAS,QAAQ,IAAI;EAC3B,IAAI,WAAW,KAAK;EACpB,MAAM;;CAEV,IAAI,CAAC,aAAa;CAElB,MAAM,MAAM,KAAK,MAAM,aAAa,SAAS,QAAQ,CAAC;CACtD,KAAK,MAAM,WAAW,CAAC,gBAAgB,kBAAkB,EAAW;EAChE,IAAI,CAAC,IAAI,UAAU;EACnB,KAAK,MAAM,OAAO,OAAO,KAAK,IAAI,SAAS,EACvC,IAAI,IAAI,WAAW,SAAS,EACxB,IAAI,SAAS,OAAO;;CAIhC,cAAc,SAAS,KAAK,UAAU,KAAK,MAAM,EAAE,GAAG,KAAK;;AAG/D,SAAgB,gBAAgB,MAIgB;CAC5C,MAAM,YAAY,QAAQ,QAAQ,KAAK,EAAE,KAAK,YAAY;CAC1D,IAAI;CACJ,IAAI,KAAK,gBAAgB,QACrB,eAAe,KAAK,YAAY,SAAS,QAAQ,KAAK,YAAY;MAElE,eAAe,KAAK,YAAY,SAAS,GAAG,KAAK,YAAY,GAAG,KAAK,YAAY,KAAK;CAE1F,MAAM,cAAc,QAAQ,WAAW,MAAM,aAAa,aAAa;CACvE,IAAI,WAAW,UAAU,EAAE,OAAO;EAAE,IAAI;EAAO,OAAO,cAAc,KAAK,YAAY;EAAoB;CACzG,IAAI,CAAC,WAAW,YAAY,EAAE,OAAO;EAAE,IAAI;EAAO,OAAO,aAAa,aAAa,iBAAiB;EAAe;CACnH,cAAc,aAAa,WAAW,KAAK,YAAY;CACvD,mBAAmB,UAAU;CAC7B,OAAO,EAAE,IAAI,MAAM"}

package/dist/index.d.ts

@@ -1,2 +1,2 @@
 export { definePlugin } from './plugin.js';
-export type { SigxPlugin, PluginCommand, CommandContext, ArgDef, Logger } from './plugin.js';
+export type { SigxPlugin, PluginCommand, CommandContext, ArgDef, Logger, ShellNode, StatusItem, ShellTab, SlashCommand, Shortcut, ShellLogStore, ShellHandle, TuiContribution } from './plugin.js';

package/dist/plugin.d.ts

@@ -7,6 +7,10 @@ export interface CommandContext {
     cwd: string;
     args: Record<string, unknown>;
     logger: Logger;
+    /** All plugins discovered for this project (for runShell({ plugins })). */
+    plugins?: SigxPlugin[];
+    /** The running CLI binary's version — for plugin feature detection. */
+    cliVersion?: string;
 }
 export interface Logger {
     log: (msg: string) => void;
@@ -18,9 +22,61 @@ export interface PluginCommand {
     args?: Record<string, ArgDef>;
     run: (ctx: CommandContext) => Promise<void>;
 }
+/** Opaque renderable returned by a tab's render() — author with JSX. */
+export type ShellNode = unknown;
+export interface StatusItem {
+    label: string;
+    value: string;
+    /** Theme token, e.g. 'success' | 'warn' | 'danger' | 'dim' | 'accent' */
+    tone?: string;
+}
+export interface ShellTab {
+    id: string;
+    label: string;
+    render: () => ShellNode;
+}
+export interface SlashCommand {
+    /** Includes the leading slash, e.g. '/reload'. */
+    name: string;
+    description: string;
+    run: (shell: ShellHandle) => void | Promise<void>;
+}
+export interface Shortcut {
+    /** Single key, active only while the command input is empty. */
+    key: string;
+    label: string;
+    run: (shell: ShellHandle) => void | Promise<void>;
+}
+export interface ShellLogStore {
+    push: (chunk: string) => void;
+}
+export interface ShellHandle {
+    isInteractive: boolean;
+    say: (text?: string) => void;
+    store: ShellLogStore;
+    setStatus: (items: StatusItem[]) => void;
+    switchTab: (id: string) => void;
+    pushView: (id: string) => void;
+    popView: () => void;
+    /** Register teardown (runs on exit()/Ctrl+C/SIGTERM/SIGHUP/SIGINT,
+     *  after the host's onExit, most-recent-first). Returns unsubscribe. */
+    onExit: (cb: () => void | Promise<void>) => () => void;
+    exit: (code?: number) => void;
+}
+export interface TuiContribution {
+    tabs?: ShellTab[];
+    commands?: SlashCommand[];
+    shortcuts?: Shortcut[];
+    status?: () => StatusItem[];
+    /** Called once when the hosting shell comes up; a returned function is
+     *  registered as teardown. Start servers/watchers here. */
+    setup?: (shell: ShellHandle) => void | (() => void | Promise<void>) | Promise<void | (() => void | Promise<void>)>;
+}
 export interface SigxPlugin {
     name: string;
     detect: (cwd: string) => boolean;
     commands: Record<string, PluginCommand>;
+    /** Optional TUI contributions merged into any plugin-hosted shell. */
+    tui?: TuiContribution;
 }
 export declare function definePlugin(plugin: SigxPlugin): SigxPlugin;

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","names":[],"sources":["../src/plugin.ts"],"sourcesContent":["/**\n * Plugin interface for the sigx CLI.\n *\n * Packages that want to extend the CLI declare a `\"sigx-cli\"` field\n * in their package.json pointing to a module that default-exports\n * a SigxPlugin created with `definePlugin()`.\n */\n\nexport interface ArgDef {\n    type: 'string' | 'boolean';\n    description?: string;\n    default?: string | boolean;\n}\n\nexport interface CommandContext {\n    cwd: string;\n    args: Record<string, unknown>;\n    logger: Logger;\n}\n\nexport interface Logger {\n    log: (msg: string) => void;\n    warn: (msg: string) => void;\n    error: (msg: string) => void;\n}\n\nexport interface PluginCommand {\n    description: string;\n    args?: Record<string, ArgDef>;\n    run: (ctx: CommandContext) => Promise<void>;\n}\n\nexport interface SigxPlugin {\n    /** Unique plugin name (e.g. 'ssg', 'lynx') */\n    name: string;\n    /** Return true if this plugin handles the current project */\n    detect: (cwd: string) => boolean;\n    /** Commands this plugin provides */\n    commands: Record<string, PluginCommand>;\n}\n\n/**\n * Define a sigx CLI plugin. Identity function for type safety.\n */\nexport function definePlugin(plugin: SigxPlugin): SigxPlugin {\n    return plugin;\n}\n"],"mappings":";;;;AA4CA,SAAgB,aAAa,QAAgC;CACzD,OAAO"}
+{"version":3,"file":"plugin.js","names":[],"sources":["../src/plugin.ts"],"sourcesContent":["/**\n * Plugin interface for the sigx CLI.\n *\n * Packages that want to extend the CLI declare a `\"sigx-cli\"` field\n * in their package.json pointing to a module that default-exports\n * a SigxPlugin created with `definePlugin()`.\n *\n * This module is deliberately dependency-free: plugins import it via\n * `@sigx/cli/plugin` without pulling the TUI stack. The TUI types below\n * (`ShellTab`, `ShellHandle`, …) are structural contracts consumed by\n * `runShell` from `@sigx/cli/shell`.\n */\n\nexport interface ArgDef {\n    type: 'string' | 'boolean';\n    description?: string;\n    default?: string | boolean;\n}\n\nexport interface CommandContext {\n    cwd: string;\n    args: Record<string, unknown>;\n    logger: Logger;\n    /**\n     * All plugins discovered for this project — lets a shell-hosting command\n     * (e.g. lynx `dev`) merge peer plugins' TUI contributions via\n     * `runShell({ plugins })` from `@sigx/cli/shell`.\n     */\n    plugins?: SigxPlugin[];\n    /** The running CLI binary's version — for plugin feature detection. */\n    cliVersion?: string;\n}\n\nexport interface Logger {\n    log: (msg: string) => void;\n    warn: (msg: string) => void;\n    error: (msg: string) => void;\n}\n\nexport interface PluginCommand {\n    description: string;\n    args?: Record<string, ArgDef>;\n    run: (ctx: CommandContext) => Promise<void>;\n}\n\n/**\n * Opaque renderable returned by a tab's `render()`. Author it with JSX\n * (`@jsxImportSource @sigx/terminal`); typed as `unknown` so this module\n * stays dependency-free — the shell passes it straight to the renderer.\n */\nexport type ShellNode = unknown;\n\n/** One entry in the shell's status line. `tone` is a theme token. */\nexport interface StatusItem {\n    label: string;\n    value: string;\n    /** e.g. 'success' | 'warn' | 'danger' | 'dim' | 'accent' */\n    tone?: string;\n}\n\n/** A tab in the shell's tab strip. */\nexport interface ShellTab {\n    id: string;\n    label: string;\n    render: () => ShellNode;\n}\n\n/** A `/command` offered in the shell input's intellisense. */\nexport interface SlashCommand {\n    /** Includes the leading slash, e.g. '/reload'. */\n    name: string;\n    description: string;\n    run: (shell: ShellHandle) => void | Promise<void>;\n}\n\n/** A single-key shortcut, active only while the command input is empty. */\nexport interface Shortcut {\n    key: string;\n    label: string;\n    run: (shell: ShellHandle) => void | Promise<void>;\n}\n\n/** Structural subset of @sigx/terminal's LogStore — keeps this module dep-free. */\nexport interface ShellLogStore {\n    push: (chunk: string) => void;\n}\n\n/**\n * Handle to a running shell, passed to slash commands, shortcuts, and the\n * host's onReady. In non-TTY environments (`isInteractive: false`) the shell\n * never mounts: `say` writes plain lines, the store streams through, and the\n * navigation methods are no-ops — callers keep a single code path.\n */\nexport interface ShellHandle {\n    isInteractive: boolean;\n    /** Print a permanent transcript line above the live region. */\n    say: (text?: string) => void;\n    /** The main streaming log store (feeds the host's Logs tab). */\n    store: ShellLogStore;\n    setStatus: (items: StatusItem[]) => void;\n    switchTab: (id: string) => void;\n    pushView: (id: string) => void;\n    popView: () => void;\n    /**\n     * Register teardown to run BEFORE the process exits — on `exit()`,\n     * Ctrl+C/q, and external SIGTERM/SIGHUP/SIGINT. Subscribers run after\n     * the host's onExit, most-recently-registered first. Returns an\n     * unsubscribe. Use this for servers, watchers, locks.\n     */\n    onExit: (cb: () => void | Promise<void>) => () => void;\n    exit: (code?: number) => void;\n}\n\n/**\n * TUI contributions a plugin offers to whichever plugin hosts the shell:\n * tabs, slash commands, shortcuts, and status-line items.\n */\nexport interface TuiContribution {\n    tabs?: ShellTab[];\n    commands?: SlashCommand[];\n    shortcuts?: Shortcut[];\n    status?: () => StatusItem[];\n    /**\n     * Lifecycle: called once when the hosting shell comes up (interactive or\n     * plain). Start servers/watchers here; an optionally returned function is\n     * registered as teardown (equivalent to `shell.onExit(fn)`).\n     */\n    setup?: (shell: ShellHandle) => void | (() => void | Promise<void>) | Promise<void | (() => void | Promise<void>)>;\n}\n\nexport interface SigxPlugin {\n    /** Unique plugin name (e.g. 'ssg', 'lynx') */\n    name: string;\n    /** Return true if this plugin handles the current project */\n    detect: (cwd: string) => boolean;\n    /** Commands this plugin provides */\n    commands: Record<string, PluginCommand>;\n    /** Optional TUI contributions merged into any plugin-hosted shell. */\n    tui?: TuiContribution;\n}\n\n/**\n * Define a sigx CLI plugin. Identity function for type safety.\n */\nexport function definePlugin(plugin: SigxPlugin): SigxPlugin {\n    return plugin;\n}\n"],"mappings":";;;;AAgJA,SAAgB,aAAa,QAAgC;CACzD,OAAO"}

package/dist/shell/index.d.ts

@@ -0,0 +1,23 @@
+import type { SigxPlugin, ShellTab, SlashCommand, Shortcut, StatusItem, ShellHandle, TuiContribution, Logger } from '../plugin.js';
+export type { ShellTab, SlashCommand, Shortcut, StatusItem, ShellHandle, TuiContribution } from '../plugin.js';
+export interface ShellConfig {
+    /** 'fullscreen': alt-screen dashboard (title bar, tabs, palette);
+     *  'inline' (default): transcript shape with bottom-anchored input. */
+    mode?: 'inline' | 'fullscreen';
+    /** Design theme (themed canvas in fullscreen). Default 'obsidian'. */
+    theme?: string;
+    title: string;
+    version?: string;
+    logo?: { rows: string[]; palette: Record<string, string> };
+    tabs: ShellTab[];
+    commands?: SlashCommand[];
+    shortcuts?: Shortcut[];
+    status?: () => StatusItem[];
+    plugins?: SigxPlugin[];
+    onReady?: (shell: ShellHandle) => void | Promise<void>;
+    onExit?: () => void | Promise<void>;
+}
+export declare function runShell(config: ShellConfig, opts?: { interactive?: boolean }): Promise<ShellHandle>;
+export declare function createShellLogger(shell: ShellHandle): Logger;
+export declare function collectTuiContributions(plugins: SigxPlugin[]): TuiContribution[];
+export declare function mergeShellConfig(config: ShellConfig, contributions: TuiContribution[], logger?: Logger): ShellConfig;