@longzai-intelligence-cli/tui 0.0.10 → 0.0.11

package/README.md

@@ -0,0 +1,14 @@
+# @longzai-intelligence-cli/tui
+
+Longzai Intelligence Cli 的终端 TUI 预设包，为命令行应用提供组件式终端界面的固定策略实现。
+
+## 简介
+
+治理终端 TUI 界面的重复实现：需要组件式终端界面的命令行应用按需引入本包，获得统一渲染入口与通用界面组件，不需要的应用零负担。
+
+## 能力
+
+- 应用渲染入口（`renderApp()`，返回可管理渲染实例）
+- 数据表格组件（DataTable，列定义与行数据渲染）
+- 信息面板组件（InfoPanel）
+- 空态提示组件（EmptyState）

package/dist/index.d.ts

@@ -29,11 +29,19 @@ type RenderInstance = ReturnType<typeof render>;
 declare function renderApp(element: ReactElement): RenderInstance;
 //#endregion
 //#region src/components/data-table.d.ts
-/** 文本对齐方式 */
+/**
+ * 文本对齐方式
+ */
 type Align = 'left' | 'right';
-/** ink Text 支持的颜色字面量 */
+/**
+ * ink Text 支持的颜色字面量
+ */
 type TextColor = 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray' | 'grayBright' | 'redBright' | 'greenBright' | 'yellowBright' | 'blueBright' | 'magentaBright' | 'cyanBright' | 'whiteBright';
-/** 单元格取值方式：字段名或格式化器函数 */
+/**
+ * 单元格取值方式：字段名或格式化器函数
+ *
+ * @typeParam T - 表格行数据类型，accessor 据此约束字段名或接收该行实例。
+ */
 type CellAccessor<T> = keyof T | ((row: T) => string);
 /**
  * 列定义
@@ -41,30 +49,56 @@ type CellAccessor<T> = keyof T | ((row: T) => string);
  * @typeParam T - 行数据类型
  */
 type Column<T> = {
-  /** 列标题（表头显示文本） */
+  /**
+   * 列标题（表头显示文本）
+   */
   header: string;
-  /** 列宽（字符数，用于 Box width） */
+  /**
+   * 列宽（字符数，用于 Box width）
+   */
   width: number;
-  /** 单元格取值：行字段名或自定义格式化器 */
+  /**
+   * 单元格取值：行字段名或自定义格式化器
+   */
   cell: CellAccessor<T>;
-  /** 文本对齐，默认 left */
+  /**
+   * 文本对齐，默认 left
+   */
   align?: Align;
-  /** 数据行文本颜色，默认不染色 */
+  /**
+   * 数据行文本颜色，默认不染色
+   */
   color?: TextColor;
 };
-/** DataTable 组件属性 */
+/**
+ * DataTable 组件属性
+ *
+ * @typeParam T - 表格行数据类型，列定义的 cell 取值器据此约束。
+ */
 type DataTableProps<T> = {
-  /** 列定义列表 */
+  /**
+   * 列定义列表
+   */
   columns: Array<Column<T>>;
-  /** 行数据列表 */
+  /**
+   * 行数据列表
+   */
   rows: T[];
-  /** 表格标题（显示在表头上方） */
+  /**
+   * 表格标题（显示在表头上方）
+   */
   title?: string;
-  /** 总记录数（用于标题展示，通常在分页时传入） */
+  /**
+   * 总记录数（用于标题展示，通常在分页时传入）
+   */
   total?: number;
-  /** 空态提示文本，默认"暂无数据" */
+  /**
+   * 空态提示文本，默认"暂无数据"
+   */
   emptyText?: string;
-  /** 行 key 提取器，默认使用行索引字符串 */
+  /**
+   * 行 key 提取器，默认使用行索引字符串
+   */
   rowKey?: (row: T, index: number) => string;
 };
 /**
@@ -88,15 +122,23 @@ type DataTableProps<T> = {
  *   ```;
  *
  * @typeParam T - 行数据类型
+ * @param props - 表格配置，含列定义、行数据、标题、空态文案等。
+ * @returns 渲染好的表格 ReactElement；rows 为空时返回 EmptyState。
  */
 declare function DataTable<T>(props: DataTableProps<T>): ReactElement;
 //#endregion
 //#region src/components/info-panel.d.ts
-/** InfoPanel 组件属性 */
+/**
+ * InfoPanel 组件属性
+ */
 type InfoPanelProps = {
-  /** 面板标题（显示在顶部） */
+  /**
+   * 面板标题（显示在顶部）
+   */
   title: string;
-  /** 面板内容 */
+  /**
+   * 面板内容
+   */
   children: ReactNode;
 };
 /**
@@ -110,13 +152,20 @@ type InfoPanelProps = {
  *     <Text>仓库总数：{stats.totalRepos}</Text>
  *   </InfoPanel>
  *   ```;
+ *
+ * @param options - 组件属性对象：title 为面板标题，children 为内容区子元素
+ * @returns 渲染青色粗体标题与内容区的纵向 Ink Box。
  */
 declare const InfoPanel: FC<InfoPanelProps>;
 //#endregion
 //#region src/components/empty-state.d.ts
-/** 空态提示组件属性 */
+/**
+ * 空态提示组件属性
+ */
 type EmptyStateProps = {
-  /** 提示文本（默认"暂无数据"） */
+  /**
+   * 提示文本（默认"暂无数据"）
+   */
   text?: string;
 };
 /**
@@ -124,7 +173,8 @@ type EmptyStateProps = {
  *
  * 以暗色文本居中展示空态提示
  *
- * @param props - 组件属性
+ * @param options - 组件属性对象，text 为空态提示文本（缺省"暂无数据"）
+ * @returns 渲染居中暗色提示文本的 Ink Box。
  */
 declare const EmptyState: FC<EmptyStateProps>;
 //#endregion

package/dist/index.js

@@ -1 +1 @@
-import"./rolldown-runtime-BqT_7tdF.js";import{Box as e,Text as t,render as n}from"ink";import{jsx as r,jsxs as i}from"react/jsx-runtime";function a(e){return n(e)}const o=({text:n=`暂无数据`})=>r(e,{padding:1,children:r(t,{dimColor:!0,children:n})});function s(e,t){if(typeof t==`function`)return t(e);let n=e[t];return n==null?`-`:String(n)}function c(n){let{columns:a,rows:c,title:l,total:u,emptyText:d=`暂无数据`,rowKey:f}=n;if(c.length===0)return r(o,{text:d});let p=a.reduce((e,t)=>e+t.width,0);return i(e,{flexDirection:`column`,padding:1,children:[l!==void 0&&i(t,{color:`cyan`,bold:!0,children:[l,u===void 0?``:`（共 ${u} 条）`]}),i(e,{marginTop:l===void 0?0:1,flexDirection:`column`,children:[r(e,{children:a.map(n=>r(e,{width:n.width,children:r(t,{bold:!0,color:`gray`,children:n.header})},n.header))}),r(t,{dimColor:!0,children:`─`.repeat(p)}),c.map((n,i)=>r(e,{children:a.map(i=>{let a=s(n,i.cell);return r(e,{width:i.width,children:i.color===void 0?r(t,{children:a}):r(t,{color:i.color,children:a})},i.header)})},f?.(n,i)??String(i)))]})]})}const l=({title:n,children:a})=>i(e,{flexDirection:`column`,padding:1,children:[r(t,{color:`cyan`,bold:!0,children:n}),r(e,{marginTop:1,flexDirection:`column`,children:a})]});export{c as DataTable,o as EmptyState,l as InfoPanel,a as renderApp};
+import"./rolldown-runtime-BqT_7tdF.js";import{Box as e,Text as t,render as n}from"ink";import{jsx as r,jsxs as i}from"react/jsx-runtime";function a(e){return n(e)}const o=({text:n=`暂无数据`})=>/* @__PURE__ */ r(e,{padding:1,children:/* @__PURE__ */ r(t,{dimColor:!0,children:n})});function s(e,t){if(typeof t==`function`)return t(e);let n=e[t];return n==null?`-`:String(n)}function c(n){let{columns:a,rows:c,title:l,total:u,emptyText:d=`暂无数据`,rowKey:f}=n;if(c.length===0)return/* @__PURE__ */ r(o,{text:d});let p=a.reduce((e,t)=>e+t.width,0);return/* @__PURE__ */ i(e,{flexDirection:`column`,padding:1,children:[l!==void 0&&/* @__PURE__ */ i(t,{color:`cyan`,bold:!0,children:[l,u===void 0?``:`（共 ${u} 条）`]}),/* @__PURE__ */ i(e,{marginTop:l===void 0?0:1,flexDirection:`column`,children:[/* @__PURE__ */ r(e,{children:a.map(n=>/* @__PURE__ */ r(e,{width:n.width,children:/* @__PURE__ */ r(t,{bold:!0,color:`gray`,children:n.header})},n.header))}),/* @__PURE__ */ r(t,{dimColor:!0,children:`─`.repeat(p)}),c.map((n,i)=>/* @__PURE__ */ r(e,{children:a.map(i=>{let a=s(n,i.cell);return/* @__PURE__ */ r(e,{width:i.width,children:i.color===void 0?/* @__PURE__ */ r(t,{children:a}):/* @__PURE__ */ r(t,{color:i.color,children:a})},i.header)})},f?.(n,i)??String(i)))]})]})}const l=({title:n,children:a})=>/* @__PURE__ */ i(e,{flexDirection:`column`,padding:1,children:[/* @__PURE__ */ r(t,{color:`cyan`,bold:!0,children:n}),/* @__PURE__ */ r(e,{marginTop:1,flexDirection:`column`,children:a})]});export{c as DataTable,o as EmptyState,l as InfoPanel,a as renderApp};

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@longzai-intelligence-cli/tui",
-  "version": "0.0.10",
-  "private": false,
+  "version": "0.0.11",
+  "description": "Longzai Intelligence CLI 终端 TUI 交互预设",
   "keywords": [
+    "longzai-intelligence",
     "cli",
     "ink",
     "preset",
     "react",
     "tui"
   ],
+  "private": false,
   "license": "UNLICENSED",
   "files": [
     "dist"
@@ -24,12 +26,12 @@
   },
   "scripts": {
     "build": "lzi-builder",
-    "build:prod": "NODE_ENV=production lzi-builder",
+    "build:prod": "NODE_ENV=production bun run build",
     "prepublishOnly": "bun run build:prod",
     "typecheck": "bun run typecheck:app && bun run typecheck:node && bun run typecheck:test",
-    "typecheck:app": "tsgo --noEmit -p tsconfig/app.json",
-    "typecheck:node": "tsgo --noEmit -p tsconfig/node.json",
-    "typecheck:test": "tsgo --noEmit -p tsconfig/test.json",
+    "typecheck:app": "lzi-tsgo typecheck tsconfig/app.json",
+    "typecheck:node": "lzi-tsgo typecheck tsconfig/node.json",
+    "typecheck:test": "lzi-tsgo typecheck tsconfig/test.json",
     "lint": "oxlint && oxfmt --check",
     "lint:fix": "oxlint --fix && oxfmt",
     "test": "bun test",
@@ -38,7 +40,7 @@
     "clean": "lzi-dev-cli clean"
   },
   "dependencies": {
-    "@longzai-intelligence-cli/core": "0.0.10",
+    "@longzai-intelligence-cli/core": "0.0.11",
     "ink": "^5.0.1",
     "react": "^19.2.6"
   },