@pablozaiden/terminatui 0.3.0-beta-1 → 0.3.0

package/guides/08-complete-application.md

@@ -1,507 +0,0 @@
-# Guide 8: Building a Complete Application (Complex)
-
-Bring together everything to build a production-ready CLI application with multiple commands, services, logging, and a polished TUI.
-
-## What You'll Build
-
-A task management CLI with:
-- Multiple commands: list, add, complete, stats
-- Shared services (database, notifications)
-- Logging with configurable verbosity
-- Full TUI support with custom result rendering
-- Config validation and type safety
-
-```bash
-tasks add "Write documentation" --priority high
-tasks list --filter pending
-tasks complete abc123
-tasks stats
-tasks --tui  # Interactive mode
-```
-
-## Project Structure
-
-```
-src/
-├── index.ts              # Application entry
-├── services/
-│   ├── database.ts       # Task storage
-│   └── notifications.ts  # Task notifications
-├── commands/
-│   ├── add.ts
-│   ├── list.ts
-│   ├── complete.ts
-│   └── stats.ts
-└── types.ts              # Shared types
-```
-
-## Step 1: Define Shared Types
-
-Create `src/types.ts`:
-
-```typescript
-export interface Task {
-  id: string;
-  title: string;
-  priority: "low" | "medium" | "high";
-  status: "pending" | "completed";
-  createdAt: Date;
-  completedAt?: Date;
-}
-
-export interface TaskStats {
-  total: number;
-  pending: number;
-  completed: number;
-  byPriority: Record<string, number>;
-}
-```
-
-## Step 2: Create Services
-
-Create `src/services/database.ts`:
-
-```typescript
-import type { Task, TaskStats } from "../types";
-
-// In-memory database (replace with real DB in production)
-const tasks: Map<string, Task> = new Map();
-
-export class Database {
-  async addTask(title: string, priority: Task["priority"]): Promise<Task> {
-    const id = Math.random().toString(36).substring(7);
-    const task: Task = {
-      id,
-      title,
-      priority,
-      status: "pending",
-      createdAt: new Date(),
-    };
-    tasks.set(id, task);
-    return task;
-  }
-
-  async getTask(id: string): Promise<Task | undefined> {
-    return tasks.get(id);
-  }
-
-  async listTasks(filter?: "pending" | "completed" | "all"): Promise<Task[]> {
-    const all = Array.from(tasks.values());
-    if (!filter || filter === "all") return all;
-    return all.filter((t) => t.status === filter);
-  }
-
-  async completeTask(id: string): Promise<Task | undefined> {
-    const task = tasks.get(id);
-    if (task) {
-      task.status = "completed";
-      task.completedAt = new Date();
-      tasks.set(id, task);
-    }
-    return task;
-  }
-
-  async getStats(): Promise<TaskStats> {
-    const all = Array.from(tasks.values());
-    return {
-      total: all.length,
-      pending: all.filter((t) => t.status === "pending").length,
-      completed: all.filter((t) => t.status === "completed").length,
-      byPriority: {
-        high: all.filter((t) => t.priority === "high").length,
-        medium: all.filter((t) => t.priority === "medium").length,
-        low: all.filter((t) => t.priority === "low").length,
-      },
-    };
-  }
-}
-```
-
-Create `src/services/notifications.ts`:
-
-```typescript
-import type { Task } from "../types";
-import type { Logger } from "@pablozaiden/terminatui";
-
-export class NotificationService {
-  constructor(private logger: Logger) {}
-
-  taskAdded(task: Task): void {
-    this.logger.info(`📝 Task added: ${task.title} [${task.priority}]`);
-    if (task.priority === "high") {
-      this.logger.warn(`⚠️ High priority task created!`);
-    }
-  }
-
-  taskCompleted(task: Task): void {
-    this.logger.info(`✅ Task completed: ${task.title}`);
-    const duration = task.completedAt!.getTime() - task.createdAt.getTime();
-    const hours = Math.floor(duration / 3600000);
-    if (hours > 24) {
-      this.logger.debug(`Task took ${hours} hours to complete`);
-    }
-  }
-}
-```
-
-## Step 3: Create Commands
-
-Create `src/commands/add.ts`:
-
-```typescript
-import {
-  Command,
-  ConfigValidationError,
-  type OptionSchema,
-  type OptionValues,
-  type CommandResult,
-} from "@pablozaiden/terminatui";
-import { Database } from "../services/database";
-import { NotificationService } from "../services/notifications";
-import type { Task } from "../types";
-
-const options = {
-  title: {
-    type: "string",
-    description: "Task title",
-    required: true,
-    label: "Task Title",
-    order: 1,
-  },
-  priority: {
-    type: "string",
-    description: "Task priority",
-    default: "medium",
-    enum: ["low", "medium", "high"],
-    label: "Priority",
-    order: 2,
-  },
-} satisfies OptionSchema;
-
-interface AddConfig {
-  title: string;
-  priority: Task["priority"];
-}
-
-export class AddCommand extends Command<typeof options, AddConfig> {
-  readonly name = "add";
-  readonly description = "Add a new task";
-  readonly options = options;
-  readonly displayName = "Add Task";
-  readonly actionLabel = "Create Task";
-
-  private db = new Database();
-
-  override buildConfig(opts: OptionValues<typeof options>): AddConfig {
-    const title = (opts["title"] as string)?.trim();
-    if (!title) {
-      throw new ConfigValidationError("Task title cannot be empty", "title");
-    }
-    if (title.length > 200) {
-      throw new ConfigValidationError(
-        "Task title must be 200 characters or less",
-        "title"
-      );
-    }
-
-    const priority = opts["priority"] as Task["priority"] ?? "medium";
-
-    return { title, priority };
-  }
-
-  async execute(config: AddConfig): Promise<CommandResult> {
-    const task = await this.db.addTask(config.title, config.priority);
-
-    // (Example) optional: log to console or your own logger
-    console.log(`Created task: ${task.title}`);
-
-    return {
-      success: true,
-      data: task,
-      message: `Created task: ${task.title} (${task.id})`,
-    };
-  }
-}
-```
-
-Create `src/commands/list.ts`:
-
-```typescript
-import {
-  Command,
-  type OptionSchema,
-  type OptionValues,
-  type CommandResult,
-} from "@pablozaiden/terminatui";
-import { Database } from "../services/database";
-import type { Task } from "../types";
-
-const options = {
-  filter: {
-    type: "string",
-    description: "Filter by status",
-    default: "all",
-    enum: ["all", "pending", "completed"],
-    label: "Status Filter",
-  },
-  priority: {
-    type: "string",
-    description: "Filter by priority",
-    enum: ["low", "medium", "high"],
-    label: "Priority Filter",
-  },
-} satisfies OptionSchema;
-
-interface ListConfig {
-  filter: "all" | "pending" | "completed";
-  priority?: Task["priority"];
-}
-
-export class ListCommand extends Command<typeof options, ListConfig> {
-  readonly name = "list";
-  readonly description = "List tasks";
-  readonly options = options;
-  readonly displayName = "List Tasks";
-  readonly actionLabel = "Show Tasks";
-
-  // Execute immediately when selected in TUI
-  readonly immediateExecution = true;
-
-  private db = new Database();
-
-  override buildConfig(opts: OptionValues<typeof options>): ListConfig {
-    return {
-      filter: (opts["filter"] as ListConfig["filter"]) ?? "all",
-      priority: opts["priority"] as Task["priority"] | undefined,
-    };
-  }
-
-  async execute(config: ListConfig): Promise<CommandResult> {
-    let tasks = await this.db.listTasks(config.filter);
-
-    if (config.priority) {
-      tasks = tasks.filter((t) => t.priority === config.priority);
-    }
-
-    return {
-      success: true,
-      data: tasks,
-      message: `Found ${tasks.length} tasks`,
-    };
-  }
-}
-```
-
-Create `src/commands/complete.ts`:
-
-```typescript
-import {
-  Command,
-  ConfigValidationError,
-  type OptionSchema,
-  type OptionValues,
-  type CommandResult,
-} from "@pablozaiden/terminatui";
-import { Database } from "../services/database";
-import { NotificationService } from "../services/notifications";
-import type { Task } from "../types";
-
-const options = {
-  id: {
-    type: "string",
-    description: "Task ID to complete",
-    required: true,
-    label: "Task ID",
-  },
-} satisfies OptionSchema;
-
-interface CompleteConfig {
-  id: string;
-}
-
-export class CompleteCommand extends Command<typeof options, CompleteConfig> {
-  readonly name = "complete";
-  readonly description = "Mark a task as complete";
-  readonly options = options;
-  readonly displayName = "Complete Task";
-  readonly actionLabel = "Mark Complete";
-
-  private db = new Database();
-
-  override buildConfig(opts: OptionValues<typeof options>): CompleteConfig {
-    const id = opts["id"] as string;
-    if (!id?.trim()) {
-      throw new ConfigValidationError("Task ID is required", "id");
-    }
-    return { id: id.trim() };
-  }
-
-  async execute(config: CompleteConfig): Promise<CommandResult> {
-    const task = await this.db.completeTask(config.id);
-
-    if (!task) {
-      return {
-        success: false,
-        message: `Task not found: ${config.id}`,
-      };
-    }
-
-    console.log(`Completed task: ${task.title}`);
-
-    return {
-      success: true,
-      data: task,
-      message: `Completed: ${task.title}`,
-    };
-  }
-}
-```
-
-Create `src/commands/stats.ts`:
-
-```typescript
-import {
-  Command,
-  type OptionSchema,
-  type CommandResult,
-} from "@pablozaiden/terminatui";
-import { Database } from "../services/database";
-import type { TaskStats } from "../types";
-
-const options = {} satisfies OptionSchema;
-
-export class StatsCommand extends Command<typeof options> {
-  readonly name = "stats";
-  readonly description = "Show task statistics";
-  readonly options = options;
-  readonly displayName = "Statistics";
-  readonly actionLabel = "Show Stats";
-  readonly immediateExecution = true;
-
-  private db = new Database();
-
-  async execute(): Promise<CommandResult> {
-    const stats = await this.db.getStats();
-
-    return {
-      success: true,
-      data: stats,
-      message: `Total: ${stats.total}, Pending: ${stats.pending}, Completed: ${stats.completed}`,
-    };
-  }
-}
-```
-
-## Step 4: Create the Application
-
-Create `src/index.ts`:
-
-```typescript
-import { TuiApplication } from "@pablozaiden/terminatui";
-import { AddCommand } from "./commands/add";
-import { ListCommand } from "./commands/list";
-import { CompleteCommand } from "./commands/complete";
-import { StatsCommand } from "./commands/stats";
-
-class TasksCLI extends TuiApplication {
-  constructor() {
-    super({
-      name: "tasks",
-      version: "1.0.0",
-      description: "A simple task management CLI",
-      commands: [
-        new AddCommand(),
-        new ListCommand(),
-        new CompleteCommand(),
-        new StatsCommand(),
-      ],
-    });
-  }
-
-  // Optional: Override onBeforeRun for setup
-  protected override async onBeforeRun(): Promise<void> {
-    this.logger.debug("Tasks CLI starting...");
-    // Initialize database connections, load config, etc.
-  }
-
-  // Optional: Override onAfterRun for cleanup
-  protected override async onAfterRun(): Promise<void> {
-    this.logger.debug("Tasks CLI shutting down...");
-    // Close database connections, save state, etc.
-  }
-}
-
-await new TasksCLI().run();
-```
-
-## Step 5: Configure Package
-
-Update `package.json`:
-
-```json
-{
-  "name": "tasks-cli",
-  "version": "1.0.0",
-  "type": "module",
-  "bin": {
-    "tasks": "./src/index.ts"
-  },
-  "scripts": {
-    "start": "bun src/index.ts",
-    "tui": "bun src/index.ts --tui",
-    "build": "bun build src/index.ts --outdir dist --target bun"
-  },
-  "dependencies": {
-    "@pablozaiden/terminatui": "^1.0.0"
-  }
-}
-```
-
-## Step 6: Run the Application
-
-```bash
-# CLI Mode
-bun start add "Write documentation" --priority high
-bun start list --filter pending
-bun start complete abc123
-bun start stats
-
-# TUI Mode
-bun tui
-
-# With verbose logging
-bun start --verbose add "Debug task" --priority low
-```
-
-## TUI Feature Summary
-
-| Feature | Implementation |
-|---------|----------------|
-| Command Groups | `group = "Tasks"` or `"Analytics"` |
-| Command Order | `order = 1, 2, 3` |
-| Display Names | `displayName = "Add Task"` |
-| Action Labels | `actionLabel = "Create Task"` |
-| Immediate Execution | `immediateExecution = true` |
-| Clipboard Support | `getClipboardContent()` |
-
-## What You Learned
-
-- **Project Structure**: Organize code into commands, services, types
-- **Shared Services**: Database and notification services
-- **Command Groups**: Organize commands in TUI sidebar
-- **Full TUI Integration**: Clipboard, immediate execution
-- **Lifecycle Hooks**: `onBeforeRun` and `onAfterRun`
-- **Production Patterns**: Error handling, validation, logging
-
-## Complete Series Summary
-
-1. **Hello World** - Basic command structure
-2. **Adding Options** - Option types and defaults
-3. **Multiple Commands** - Command organization
-4. **Subcommands** - Nested command hierarchies
-5. **Interactive TUI** - TuiApplication basics
-6. **Config Validation** - buildConfig and validation
-7. **Async Cancellation** - Cancellable operations
-8. **Complete Application** - Full production app
-
-You now have all the tools to build powerful CLI applications with terminatui! 🎉

package/guides/README.md

@@ -1,78 +0,0 @@
-# Terminatui Framework Guides
-
-Step-by-step tutorials for building CLI applications with the terminatui framework.
-
-## Guide Overview
-
-| # | Guide | Level | Topics |
-|---|-------|-------|--------|
-| 1 | [Hello World](01-hello-world.md) | Super Simple | Basic Command, Application |
-| 2 | [Adding Options](02-adding-options.md) | Super Simple | Option types, defaults, aliases |
-| 3 | [Multiple Commands](03-multiple-commands.md) | Basic | Multiple commands, project structure |
-| 4 | [Subcommands](04-subcommands.md) | Basic | Nested subcommands, hierarchies |
-| 5 | [Interactive TUI](05-interactive-tui.md) | Normal | TuiApplication, metadata, keyboard |
-| 6 | [Config Validation](06-config-validation.md) | Normal | buildConfig, ConfigValidationError |
-| 7 | [Async Cancellation](07-async-cancellation.md) | Complex | AbortSignal, cancellation, cleanup |
-| 8 | [Complete Application](08-complete-application.md) | Complex | Full app, services, best practices |
-
-## Learning Path
-
-### Beginners
-Start with guides 1-2 to understand the basics of commands and options.
-
-### Intermediate
-Continue with guides 3-4 to learn about organizing larger applications.
-
-### Advanced
-Work through guides 5-8 to master TUI features, validation, and production patterns.
-
-## Quick Start
-
-```bash
-# Create a new project
-mkdir my-cli && cd my-cli
-bun init -y
-bun add @pablozaiden/terminatui
-
-# Create your first command
-cat > src/index.ts << 'EOF'
-import { Command, Application, type OptionSchema } from "@pablozaiden/terminatui";
-
-const options = {
-  name: { type: "string", description: "Your name" },
-} satisfies OptionSchema;
-
-class HelloCommand extends Command<typeof options> {
-  readonly name = "hello";
-  readonly description = "Say hello";
-  readonly options = options;
-
-  async execute(config: Record<string, unknown>) {
-    const name = config["name"] ?? "World";
-    console.log(`Hello, ${name}!`);
-    return { success: true };
-  }
-}
-
-class MyCLI extends Application {
-  constructor() {
-    super({ name: "my-cli", version: "1.0.0", commands: [new HelloCommand()] });
-  }
-}
-
-// Recommended: let Terminatui read `Bun.argv.slice(2)`
-await new MyCLI().run();
-
-// For tests or programmatic invocation:
-// await new MyCLI().runFromArgs(["hello", "--name", "Developer"]);
-EOF
-
-# Run it
-bun src/index.ts hello --name "Developer"
-```
-
-## Prerequisites
-
-- [Bun](https://bun.sh)
-- Basic TypeScript knowledge
-- Terminal/command-line familiarity

package/tsconfig.json

@@ -1,25 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": ["ESNext"],
-    "target": "ESNext",
-    "module": "ESNext",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "jsxImportSource": "@opentui/react",
-    "allowJs": true,
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noPropertyAccessFromIndexSignature": true,
-    "noUncheckedIndexedAccess": true,
-    "esModuleInterop": true,
-    "types": ["bun"]
-  },
-  "include": ["src/**/*", "examples/**/*"]
-}