@pablozaiden/terminatui 0.3.0-beta-1 → 0.3.0

package/package.json

@@ -1,13 +1,20 @@
 {
   "name": "@pablozaiden/terminatui",
-  "version": "0.3.0-beta-1",
+  "version": "0.3.0",
   "description": "Terminal UI and Command Line Application Framework",
   "repository": {
     "url": "https://github.com/PabloZaiden/terminatui"
   },
   "type": "module",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
+  "files": [
+    "src/**/*"
+  ],
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "default": "./src/index.ts"
+    }
+  },
   "scripts": {
     "build": "bunx tsc --noEmit",
     "test": "bun test",

package/src/__tests__/configOnChange.test.ts

@@ -0,0 +1,63 @@
+import { test, expect } from "bun:test";
+import { Command } from "../core/command.ts";
+import type { OptionSchema } from "../types/command.ts";
+
+class TestCommand extends Command<typeof TestCommand.Options> {
+  static readonly Options = {
+    a: { type: "string" as const, description: "a" },
+    b: { type: "string" as const, description: "b" },
+  } as const satisfies OptionSchema;
+
+  readonly name = "my";
+  readonly description = "my";
+  readonly options = TestCommand.Options;
+
+  public readonly onChangeCalls: Array<[
+    string,
+    unknown,
+    Record<string, unknown>
+  ]> = [];
+
+  override execute(): void {}
+
+  override onConfigChange(
+    key: string,
+    value: unknown,
+    allValues: Record<string, unknown>
+  ) {
+    this.onChangeCalls.push([key, value, allValues]);
+    if (key === "a") {
+      return { b: "derived" };
+    }
+    return undefined;
+  }
+
+  applyTuiConfigChange(
+    key: string,
+    value: unknown,
+    values: Record<string, unknown>
+  ): Record<string, unknown> {
+    let nextValues: Record<string, unknown> = { ...values, [key]: value };
+
+    const updates = this.onConfigChange?.(key, value, nextValues);
+    if (updates && typeof updates === "object") {
+      nextValues = { ...nextValues, ...updates };
+    }
+
+    return nextValues;
+  }
+}
+
+test("onConfigChange merges returned updates", () => {
+  const command = new TestCommand();
+
+  const next = command.applyTuiConfigChange("a", "new", {
+    a: "old",
+    b: "oldb",
+  });
+
+  expect(command.onChangeCalls.length).toBe(1);
+  expect(command.onChangeCalls[0]?.[0]).toBe("a");
+  expect(command.onChangeCalls[0]?.[1]).toBe("new");
+  expect(next).toEqual({ a: "new", b: "derived" });
+});

package/src/builtins/version.ts

@@ -18,7 +18,7 @@ interface VersionConfig {
  * Format version string with optional commit hash.
  * If commitHash is empty or undefined, shows "(dev)".
  */
-function formatVersion(version: string, commitHash?: string): string {
+export function formatVersion(version: string, commitHash?: string): string {
   const hashPart = commitHash && commitHash.length > 0 
     ? commitHash.substring(0, 7) 
     : "(dev)";

package/src/index.ts

@@ -0,0 +1,22 @@
+export * from "./builtins/help.ts";
+export * from "./builtins/settings.ts";
+export * from "./builtins/version.ts";
+
+export * from "./cli/parser.ts";
+export * from "./cli/output/colors.ts";
+
+export * from "./core/application.ts";
+export * from "./core/command.ts";
+export * from "./core/context.ts";
+export * from "./core/help.ts";
+export * from "./core/knownCommands.ts";
+export * from "./core/logger.ts";
+export * from "./core/registry.ts";
+
+export * from "./tui/TuiApplication.tsx";
+export * from "./tui/TuiRoot.tsx";
+export * from "./tui/registry.ts";
+export * from "./tui/theme.ts";
+export * from "./types/command.ts";
+
+export * from "./tui/components/JsonHighlight.tsx";

package/src/tui/adapters/ink/InkRenderer.tsx

@@ -26,6 +26,10 @@ export class InkRenderer implements Renderer {
     private instance: ReturnType<typeof render> | null = null;
     private activeKeyboardAdapter: Renderer["keyboard"] | null = null;
 
+    public supportCustomRendering(): boolean {
+        return false;
+    }
+
     public keyboard: Renderer["keyboard"] = {
         setActiveHandler: (id, handler) => {
             return this.activeKeyboardAdapter?.setActiveHandler(id, handler) ?? (() => {});

package/src/tui/adapters/opentui/OpenTuiRenderer.tsx

@@ -27,6 +27,10 @@ export class OpenTuiRenderer implements Renderer {
 
     private activeKeyboardAdapter: Renderer["keyboard"] | null = null;
 
+    public supportCustomRendering(): boolean {
+        return true;
+    }
+
     public keyboard: Renderer["keyboard"] = {
         setActiveHandler: (id, handler) => {
             return this.activeKeyboardAdapter?.setActiveHandler(id, handler) ?? (() => {});

package/src/tui/adapters/types.ts

@@ -64,6 +64,7 @@ export interface Renderer {
     initialize: () => Promise<void>;
     render: (node: ReactNode) => void;
     destroy: () => void;
+    supportCustomRendering: () => boolean;
 
     keyboard: KeyboardAdapter;
     components: RendererComponents;

package/src/tui/screens/ConfigScreen.tsx

@@ -116,7 +116,12 @@ export class ConfigScreen extends ScreenBase {
                     currentValue: values[fieldKey],
                     fieldConfigs: derivedFieldConfigs,
                     onSubmit: (value: unknown) => {
-                        const nextValues = { ...values, [fieldKey]: value };
+                        let nextValues = { ...values, [fieldKey]: value };
+                        const updates = command.onConfigChange?.(fieldKey, value, nextValues);
+                        if (updates) {
+                            nextValues = { ...nextValues, ...updates };
+                        }
+
                         navigation.replace<ConfigParams>(ConfigScreen.Id, { ...params, values: nextValues });
                         navigation.closeModal();
                     },

package/src/tui/screens/ResultsScreen.tsx

@@ -5,6 +5,7 @@ import { ResultsPanel } from "../components/ResultsPanel.tsx";
 import { useClipboardProvider } from "../hooks/useClipboardProvider.ts";
 import { type ScreenComponent } from "../registry.ts";
 import { ScreenBase } from "./ScreenBase.ts";
+import { useRenderer } from "../context/RendererContext.tsx";
 
 /**
  * Screen state stored in navigation params.
@@ -36,6 +37,13 @@ export class ResultsScreen extends ScreenBase {
 
             const { result, command } = params;
 
+            const renderer = useRenderer();
+
+            let renderFunction = undefined;
+            if (renderer.supportCustomRendering()) {
+                renderFunction = command.renderResult;
+            }
+
             // Register clipboard provider for this screen
             useClipboardProvider(
                 useCallback(() => {
@@ -52,7 +60,7 @@ export class ResultsScreen extends ScreenBase {
                     result={result as CommandResult | null}
                     error={null}
                     focused={true}
-                    renderResult={command.renderResult}
+                    renderResult={renderFunction}
                 />
             );
         }

package/src/tui/screens/RunningScreen.tsx

@@ -55,7 +55,7 @@ export class RunningScreen extends ScreenBase {
                 <Panel
                     flexDirection="column"
                     flex={1}
-                    title={`Running ${command.displayName ?? command.name}`}
+                    title={`${command.displayName ?? command.name}`}
                     padding={1}
                     focused
                 >

package/.devcontainer/devcontainer.json

@@ -1,19 +0,0 @@
-{
-	"name": "Ubuntu",
-	"image": "mcr.microsoft.com/devcontainers/base:noble",
-	"features": {
-		"ghcr.io/devcontainers/features/github-cli:1": {},
-		"ghcr.io/devcontainers/features/azure-cli:latest": {},
-		"ghcr.io/devcontainers/features/docker-outside-of-docker": {}
-	},
-	"postCreateCommand": "./.devcontainer/install-prerequisites.sh",
-	"customizations": {
-		"vscode": {
-			"extensions": [
-				"oven.bun-vscode",
-				"ms-azuretools.vscode-docker",
-				"SanjulaGanepola.github-local-actions"
-			]
-		}
-	}
-}

package/.devcontainer/install-prerequisites.sh

@@ -1,49 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-# if bun is not installed, install it
-if ! command -v bun &> /dev/null
-then
-    echo "Bun not found, installing..."
-    
-    curl -fsSL https://bun.com/install | bash
-
-    # manual fix for missing package.json issue
-    if [ ! -f "$HOME/.bun/install/global/package.json" ]; then
-        echo "Creating missing package.json for bun global..."
-        mkdir -p "$HOME/.bun/install/global"
-        echo '{}' > "$HOME/.bun/install/global/package.json"
-    fi
-
-
-    # add bun to PATH
-    export PATH="$HOME/.bun/bin:$PATH"
-fi
-
-# if there is no symlink for node, create it
-if ! command -v node &> /dev/null
-then
-    # discover the bun binary location
-    bunBinary=$(which bun)
-    echo "Bun binary located at: $bunBinary"
-    echo "Creating symlink for node to bun..."
-    mkdir -p $HOME/.local/bin
-    ln -sf "$bunBinary" "$HOME/.local/bin/node"
-fi
-
-export BUN_INSTALL_BIN=$HOME/.bun/bin
-export BUN_INSTALL_GLOBAL_DIR=$HOME/.bun/global
-
-# Ensure dirs exist and are owned by the current user
-mkdir -p "$BUN_INSTALL_BIN" "$BUN_INSTALL_GLOBAL_DIR"
-export PATH="$HOME/.bun/bin:$HOME/.bun/global/bin:${PATH}"
-
-# add the paths to bashrc and zshrc
-echo 'export PATH="$HOME/.bun/bin:$HOME/.bun/global/bin:${PATH}" ' >> $HOME/.bashrc
-echo 'export PATH="$HOME/.bun/bin:$HOME/.bun/global/bin:${PATH}" '>> $HOME/.zshrc
-
-# ensure $HOME/.local/bin is in PATH for current session and future shells
-export PATH="$HOME/.local/bin:$PATH"
-echo 'export PATH="$HOME/.local/bin:$PATH"' >> "$HOME/.bashrc"
-echo 'export PATH="$HOME/.local/bin:$PATH"' >> "$HOME/.zshrc"

package/.github/workflows/copilot-setup-steps.yml

@@ -1,32 +0,0 @@
-name: "Copilot Setup Steps"
-
-on:
-  workflow_dispatch:
-  push:
-    paths:
-      - .github/workflows/copilot-setup-steps.yml
-  pull_request:
-    paths:
-      - .github/workflows/copilot-setup-steps.yml
-
-jobs:
-  # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
-  copilot-setup-steps:
-    runs-on: ubuntu-latest
-
-    permissions:
-      contents: read
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v6
-
-      - name: Install prerequisites
-        run: |
-          chmod +x ./.devcontainer/install-prerequisites.sh
-          ./.devcontainer/install-prerequisites.sh
-          echo "$HOME/.bun/bin" >> $GITHUB_PATH
-          echo "$HOME/.bun/global/bin" >> $GITHUB_PATH
-
-      - name: Install dependencies
-        run: bun install

package/.github/workflows/pull-request.yml

@@ -1,27 +0,0 @@
-name: Pull Request
-
-on:
-  pull_request:
-    branches: [ "main" ]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    environment: PR
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v6
-
-      - name: Install prerequisites
-        run: |
-          chmod +x .devcontainer/install-prerequisites.sh
-          ./.devcontainer/install-prerequisites.sh
-          echo "$HOME/.bun/bin" >> $GITHUB_PATH
-          echo "$HOME/.bun/global/bin" >> $GITHUB_PATH
-
-      - name: Install dependencies
-        run: bun install
-
-      - name: Run tests
-        run: bun test

package/.github/workflows/release-npm-package.yml

@@ -1,81 +0,0 @@
-name: Release NPM Package
-
-on:
-  release:
-    types: [published]
-  workflow_dispatch:
-    inputs:
-      tag:
-        description: 'Release tag (e.g., v1.2.3)'
-        required: true
-
-jobs:
-  publish:
-    name: Publish Package
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write
-    steps:
-      - name: Determine release tag
-        id: get_tag
-        run: |
-          echo "Event name: ${{ github.event_name }}"
-          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
-            TAG="${{ github.event.inputs.tag }}"
-          else
-            TAG="${{ github.event.release.tag_name }}"
-          fi
-
-          # if the tag is empty, exit with error
-          if [ -z "$TAG" ]; then
-            echo "Error: Tag is empty"
-            exit 1
-          fi
-
-          # Strip 'v' prefix if present
-          VERSION="${TAG#v}"
-
-          echo "Using tag: $TAG"
-          echo "Using version: $VERSION"
-
-          echo "tag=$TAG" >> $GITHUB_OUTPUT
-          echo "version=$VERSION" >> $GITHUB_OUTPUT
-
-      - name: Checkout repository
-        uses: actions/checkout@v6
-        with:
-          ref: ${{ steps.get_tag.outputs.tag }}
-
-      - name: Install bun
-        run: |
-          curl -fsSL https://bun.com/install | bash
-          echo "$HOME/.bun/bin" >> $GITHUB_PATH
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '24'
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: Set package version
-        run: |
-          VERSION="${{ steps.get_tag.outputs.version }}"
-          jq --arg version "$VERSION" '.version = $version' package.json > package.json.tmp && mv package.json.tmp package.json
-
-      - name: Verify package version
-        run: |
-          EXPECTED_VERSION="${{ steps.get_tag.outputs.version }}"
-          ACTUAL_VERSION=$(jq -r '.version' package.json)
-          if [ "$EXPECTED_VERSION" != "$ACTUAL_VERSION" ]; then
-            echo "Error: Version mismatch. Expected $EXPECTED_VERSION, got $ACTUAL_VERSION"
-            exit 1
-          fi
-          echo "Version verified: $ACTUAL_VERSION"
-
-      - name: Install dependencies
-        run: bun install
-      - name: Build package
-        run: bun run build
-
-      - name: Publish Package
-        run: npm publish --no-build

package/AGENTS.md

@@ -1,43 +0,0 @@
-## General guidelines
-
-- Never use `git` operations. That's up to the user.
-- Always prefer simplicity, usability and top level type safety over cleverness.
-- Don't create index.ts files that re-export things from other files. Always import directly from the file you need.
-- Prefer classes over standalone functions when it makes sense.
-- Before doing something, check the patterns used in the rest of the codebase.
-- Never use `import("...")` dynamic imports. Always use static imports (unless absolutely necessary).
-
-## Bun specifics
-This is a Bun-only project. Never check if something might not be supported in another environment. You can assume Bun is always available.
-
-Always use Bun features and APIs where possible.
-
-- Use `bun <file>` instead of `node <file>` or `ts-node <file>`
-- Use `bun test` instead of `jest` or `vitest`
-- Use `bun build <file.html|file.ts|file.css>` instead of `webpack` or `esbuild`
-- Use `bun install` instead of `npm install` or `yarn install` or `pnpm install`
-- Use `bun run <script>` instead of `npm run <script>` or `yarn run <script>` or `pnpm run <script>`
-- Use `bunx <package> <command>` instead of `npx <package> <command>`
-- Bun automatically loads .env, so don't use dotenv.
-
-## APIs
-
-- Prefer `Bun.file` over `node:fs`'s readFile/writeFile
-- Bun.$`ls` instead of execa.
-
-## Testing
-
-Always run `bun run build` before running tests, to make sure there are no build errors.
-Use `bun run test` to run all the tests.
-
-Always run `bun run test` when you think you are done making changes.
-
-```ts#index.test.ts
-import { test, expect } from "bun:test";
-
-test("hello world", () => {
-  expect(1).toBe(1);
-});
-```
-
-For more information, read the Bun API docs in `node_modules/bun-types/docs/**.mdx`.

package/CLAUDE.md

@@ -1 +0,0 @@
-@AGENTS.md