@longzai-intelligence-cli/core 0.0.1 → 0.0.2

package/dist/index.d.ts

@@ -1,5 +1,230 @@
 import "./rolldown-runtime-BqT_7tdF.js";
 import { Command } from "commander";
+//#region src/contracts.d.ts
+/**
+ * 能力契约定义
+ *
+ * core 保持中性：只定义交互、着色等能力的契约（type），
+ * 不含任何具体实现依赖（无 @clack/prompts、无 picocolors）。
+ *
+ * 固定策略实现（clack 交互 + picocolors 着色）由 @longzai-intelligence-cli/standard 提供；
+ * 消费方也可实现自己的 Provider 注入，以保留特定交互偏好或着色行为，
+ * 契约保证替换的安全性。
+ *
+ * 设计遵循 ADR-0048 多策略范式：契约统一、实现可替换、装配时选择。
+ */
+/**
+ * 选择选项（交互层通用，与具体交互实现无关）
+ */
+type SelectOption = {
+  /**
+   * 选项值
+   */
+  value: string;
+  /**
+   * 选项标签
+   */
+  label: string;
+  /**
+   * 选项提示
+   */
+  hint?: string;
+};
+/**
+ * 文本输入选项
+ */
+type TextInputOptions = {
+  /**
+   * 占位提示文本
+   */
+  placeholder?: string;
+  /**
+   * 默认值
+   */
+  defaultValue?: string;
+};
+/**
+ * 确认选项
+ */
+type ConfirmOptions = {
+  /**
+   * 默认选中值
+   */
+  defaultValue?: boolean;
+};
+/**
+ * 加载动画控制器
+ */
+type SpinnerController = {
+  /**
+   * 启动动画
+   *
+   * @param message - 动画提示消息
+   */
+  start: (message: string) => void;
+  /**
+   * 停止动画
+   *
+   * @param message - 结束提示消息
+   */
+  stop: (message: string) => void;
+};
+/**
+ * 日志输出工具集（交互层日志，随 InteractionProvider 提供以保持输出风格一致）
+ */
+type LogToolset = {
+  /**
+   * 输出信息级日志
+   */
+  info: (message: string) => void;
+  /**
+   * 输出成功级日志
+   */
+  success: (message: string) => void;
+  /**
+   * 输出警告级日志
+   */
+  warn: (message: string) => void;
+  /**
+   * 输出错误级日志
+   */
+  error: (message: string) => void;
+  /**
+   * 输出步骤级日志
+   */
+  step: (message: string) => void;
+};
+/**
+ * 交互能力契约
+ *
+ * 定义交互式输入（选择、确认、文本输入、加载动画、提示框、日志）的标准接口。
+ * 默认实现基于 @clack/prompts（方向键交互）；
+ * 消费方可注入基于 node:readline（序号交互）的自定义实现，交互行为无损保留。
+ */
+type InteractionProvider = {
+  /**
+   * 交互式单选
+   *
+   * @param message - 提示消息
+   * @param options - 选项列表
+   * @returns 选中的值
+   */
+  select: (message: string, options: SelectOption[]) => Promise<string>;
+  /**
+   * 交互式文本输入
+   *
+   * @param message - 提示消息
+   * @param options - 输入选项
+   * @returns 输入的文本
+   */
+  textInput: (message: string, options?: TextInputOptions) => Promise<string>;
+  /**
+   * 交互式确认
+   *
+   * @param message - 提示消息
+   * @param options - 确认选项
+   * @returns 确认结果
+   */
+  confirm: (message: string, options?: ConfirmOptions) => Promise<boolean>;
+  /**
+   * 创建加载动画
+   *
+   * @returns 加载动画控制器
+   */
+  spinner: () => SpinnerController;
+  /**
+   * 显示提示信息框
+   *
+   * @param message - 信息内容
+   * @param title - 信息标题
+   */
+  note: (message: string, title?: string) => void;
+  /**
+   * 日志输出工具集
+   */
+  log: LogToolset;
+};
+/**
+ * 着色能力契约
+ *
+ * 定义终端着色的标准接口。默认实现基于 picocolors；
+ * 消费方可注入自研 ANSI 实现以保留特定着色行为。
+ */
+type ColorProvider = {
+  /**
+   * 红色文本
+   */
+  red: (text: string) => string;
+  /**
+   * 绿色文本
+   */
+  green: (text: string) => string;
+  /**
+   * 黄色文本
+   */
+  yellow: (text: string) => string;
+  /**
+   * 蓝色文本
+   */
+  blue: (text: string) => string;
+  /**
+   * 加粗文本
+   */
+  bold: (text: string) => string;
+  /**
+   * 灰色文本
+   */
+  gray: (text: string) => string;
+};
+/**
+ * 进度条控制器（交互无关、平台无关能力，core 直接提供实现）
+ */
+type ProgressController = {
+  /**
+   * 更新进度
+   *
+   * @param percent - 进度百分比（0-100）
+   * @param message - 进度提示消息
+   */
+  update: (percent: number, message?: string) => void;
+  /**
+   * 完成进度条
+   *
+   * @param message - 完成消息
+   */
+  done: (message?: string) => void;
+};
+/**
+ * 输出格式类型
+ */
+type OutputFormat = 'text' | 'json';
+//#endregion
+//#region src/provider.d.ts
+/**
+ * 设置当前交互 provider（由 createCli 或消费方入口注入）
+ *
+ * @param provider - 交互 provider
+ */
+declare function setInteractionProvider(provider: InteractionProvider): void;
+/**
+ * 设置当前着色 provider（由 createCli 或消费方入口注入）
+ *
+ * @param provider - 着色 provider
+ */
+declare function setColorProvider(provider: ColorProvider): void;
+/**
+ * 获取当前交互 provider
+ *
+ * @returns 当前生效的交互 provider
+ */
+declare function getInteractionProvider(): InteractionProvider;
+/**
+ * 获取当前着色 provider
+ *
+ * @returns 当前生效的着色 provider
+ */
+declare function getColorProvider(): ColorProvider;
+//#endregion
 //#region src/create-cli.d.ts
 /**
  * createCli 工厂的配置选项
@@ -17,16 +242,37 @@ type CreateCliOptions = {
    * 版本号（默认从构建期注入读取，无需手动传入）
    */
   version?: string;
+  /**
+   * 交互 provider（决定 select/confirm/textInput 等的交互范式）
+   *
+   * 默认为中性回退。正式使用应注入 @longzai-intelligence-cli/standard 的 clack 实现，
+   * 或消费方自建的 readline 等实现，以保留特定交互偏好。
+   */
+  interaction?: InteractionProvider;
+  /**
+   * 着色 provider（决定 OutputFormatter/progressBar 等的着色实现）
+   *
+   * 默认为中性回退。正式使用应注入 @longzai-intelligence-cli/standard 的 picocolors 实现。
+   */
+  color?: ColorProvider;
 };
 /**
  * 创建 CLI 程序实例
  *
  * 基于 commander 封装，内置 `--version`（版本号由构建期 define 注入 + 开发期兜底）
- * 与 `--help`，调用方只需注册具体子命令后 `parseAsync(process.argv)` 即可。
+ * 与 `--help`。调用方注入交互/着色 provider 后，模块级交互函数（select/confirm 等）
+ * 与 OutputFormatter 即按注入的 provider 工作。
  *
  * @example
  *   ```ts
- *   const program = createCli({ name: 'lzi-my-app', description: '我的 CLI' });
+ *   import { createCli } from '@longzai-intelligence-cli/core';
+ *   import { clackInteraction, picocolorsColor } from '@longzai-intelligence-cli/standard';
+ *
+ *   const program = createCli({
+ *     name: 'lzi-my-app',
+ *     interaction: clackInteraction,
+ *     color: picocolorsColor,
+ *   });
  *   program.command('hello').action(() => console.log('hi'));
  *   await program.parseAsync(process.argv);
  *   ```;
@@ -36,7 +282,7 @@ type CreateCliOptions = {
  */
 declare function createCli(options: CreateCliOptions): Command;
 //#endregion
-//#region src/version/index.d.ts
+//#region src/version.d.ts
 /**
  * 获取 CLI 版本号
  *
@@ -50,16 +296,13 @@ declare function createCli(options: CreateCliOptions): Command;
  */
 declare const getCliVersion: () => string;
 //#endregion
-//#region src/output/index.d.ts
-/**
- * 输出格式类型
- */
-type OutputFormat = 'text' | 'json';
+//#region src/output.d.ts
 /**
  * 输出格式化器
  *
- * 支持 text（带颜色的可读输出）与 json（机器可读的结构化输出）两种格式，
- * 由 `parseOutputFormat` 从命令行 `--format` 参数解析得到。
+ * 支持 text（带颜色的可读输出）与 json（机器可读的结构化输出）两种格式。
+ * 着色由当前注入的 ColorProvider 决定（默认 @longzai-intelligence-cli/standard 的 picocolors 实现）；
+ * 未注入时为中性无色，保证 core 单独可用。
  */
 declare class OutputFormatter {
   /**
@@ -72,6 +315,12 @@ declare class OutputFormatter {
    * @param format - 输出格式，默认 text
    */
   constructor(format?: OutputFormat);
+  /**
+   * 当前着色 provider（每次调用动态读取，保证 setProvider 后即时生效）
+   *
+   * @returns 当前着色 provider
+   */
+  private get colors();
   /**
    * 输出成功信息
    *
@@ -120,65 +369,18 @@ declare class OutputFormatter {
  */
 declare function parseOutputFormat(format?: string): OutputFormat;
 //#endregion
-//#region src/tui/index.d.ts
-/**
- * 选择选项
- */
-type SelectOption = {
-  /**
-   * 选项值
-   */
-  value: string;
-  /**
-   * 选项标签
-   */
-  label: string;
-  /**
-   * 选项提示
-   */
-  hint?: string;
-};
+//#region src/tui.d.ts
 /**
- * 文本输入选项
- */
-type TextInputModule = {
-  /**
-   * 占位提示文本
-   */
-  placeholder?: string;
-  /**
-   * 默认值
-   */
-  defaultValue?: string;
-};
-/**
- * 确认选项
- */
-type ConfirmOptions = {
-  /**
-   * 默认选中值
-   */
-  defaultValue?: boolean;
-};
-/**
- * 加载动画控制器
+ * 交互层模块函数
+ *
+ * 这些函数读取当前注入的 InteractionProvider（由 createCli 或 setInteractionProvider 设置），
+ * 默认为中性回退。正式使用应注入 @longzai-intelligence-cli/standard 的 clack 实现。
+ *
+ * 消费方 command 文件可直接 `import { select } from '@longzai-intelligence-cli/core'` 调用，
+ * 无需感知当前用的是哪个 provider。
  */
-type SpinnerController = {
-  /**
-   * 启动动画
-   *
-   * @param message - 动画提示消息
-   */
-  start(message: string): void;
-  /**
-   * 停止动画
-   *
-   * @param message - 结束提示消息
-   */
-  stop(message: string): void;
-};
 /**
- * 交互式选择
+ * 交互式单选
  *
  * @param message - 提示消息
  * @param options - 选项列表
@@ -192,7 +394,7 @@ declare function select(message: string, options: SelectOption[]): Promise<strin
  * @param options - 输入选项
  * @returns 输入的文本
  */
-declare function textInput(message: string, options?: TextInputModule): Promise<string>;
+declare function textInput(message: string, options?: TextInputOptions): Promise<string>;
 /**
  * 交互式确认
  *
@@ -215,7 +417,7 @@ declare function spinner(): SpinnerController;
  */
 declare function note(message: string, title?: string): void;
 /**
- * 日志输出工具集
+ * 日志输出工具集（委托当前 provider 的 log）
  */
 declare const log: {
   /**
@@ -250,4 +452,16 @@ declare const log: {
   step(message: string): void;
 };
 //#endregion
-export { type ConfirmOptions, type CreateCliOptions, type OutputFormat, OutputFormatter, type SelectOption, type SpinnerController, type TextInputModule, confirm, createCli, getCliVersion, log, note, parseOutputFormat, select, spinner, textInput };
+//#region src/progress.d.ts
+/**
+ * 进度条能力（交互无关、平台无关）
+ *
+ * 基于 process.stdout 的纯文本进度条，不依赖任何交互库。
+ * 着色由当前注入的 ColorProvider 决定。
+ *
+ * @param total - 总进度值（默认 100，仅用于明确语义，实际以 0-100 百分比驱动）
+ * @returns 进度条控制器
+ */
+declare function progressBar(total?: number): ProgressController;
+//#endregion
+export { type ColorProvider, type ConfirmOptions, type CreateCliOptions, type InteractionProvider, type LogToolset, type OutputFormat, OutputFormatter, type ProgressController, type SelectOption, type SpinnerController, type TextInputOptions, confirm, createCli, getCliVersion, getColorProvider, getInteractionProvider, log, note, parseOutputFormat, progressBar, select, setColorProvider, setInteractionProvider, spinner, textInput };

package/dist/index.js

@@ -1 +1,3 @@
-import"./rolldown-runtime-BqT_7tdF.js";import{Command as e}from"commander";import"node:fs";import"node:path";import"node:url";import{createNodeLogger as t}from"@longzai-intelligence-logger/node";import n from"picocolors";import*as r from"@clack/prompts";const i=()=>`0.0.1`;function a(t){let n=t.version??i(),r=new e;return r.name(t.name).version(n,`-v, --version`,`输出 ${t.name} 的版本号`),t.description&&r.description(t.description),r}const o=t(`@longzai-intelligence-cli/core/output`);var s=class{format;constructor(e=`text`){this.format=e}success(e,t){this.format===`json`?o.info(JSON.stringify({success:!0,data:e},null,2)):o.info(t?n.green(t):n.green(this.formatData(e)))}error(e){if(this.format===`json`){let t=e instanceof Error?{message:e.message,name:e.name}:{message:String(e)};o.info(JSON.stringify({success:!1,error:t},null,2))}else{let t=e instanceof Error?e.message:String(e);o.error(n.red(`错误: ${t}`))}}info(e){this.format===`json`?o.info(JSON.stringify({success:!0,message:e},null,2)):o.info(n.blue(e))}warn(e){this.format===`json`?o.info(JSON.stringify({success:!0,warning:e},null,2)):o.info(n.yellow(e))}table(e,t){if(this.format===`json`){let n=t.map(t=>{let n={};return e.forEach((e,r)=>{n[e]=t[r]??``}),n});o.info(JSON.stringify({success:!0,data:n},null,2))}else{let r=e.map((e,n)=>Math.max(e.length,...t.map(e=>(e[n]??``).length)));o.info(e.map((e,t)=>n.bold(e.padEnd(r[t]??0))).join(`  `)),o.info(r.map(e=>`-`.repeat(e??0)).join(`  `));for(let e of t)o.info(e.map((e,t)=>(e??``).padEnd(r[t]??0)).join(`  `))}}formatData(e){return typeof e==`string`?e:typeof e==`number`||typeof e==`boolean`?String(e):JSON.stringify(e,null,2)}};function c(e){return e===`json`?`json`:`text`}async function l(e,t){let n=await r.select({message:e,options:t.map(e=>({value:e.value,label:e.label,hint:e.hint}))});return r.isCancel(n)&&(r.cancel(`操作已取消`),process.exit(0)),typeof n==`string`?n:String(n)}async function u(e,t){let n=await r.text({message:e,placeholder:t?.placeholder,defaultValue:t?.defaultValue});return r.isCancel(n)&&(r.cancel(`操作已取消`),process.exit(0)),typeof n==`string`?n:String(n)}async function d(e,t){let n=await r.confirm({message:e,initialValue:t?.defaultValue??!1});return r.isCancel(n)&&(r.cancel(`操作已取消`),process.exit(0)),typeof n==`boolean`?n:!!n}function f(){let e=r.spinner();return{start(t){e.start(t)},stop(t){e.stop(t)}}}function p(e,t){r.note(e,t)}const m={info(e){r.log.info(n.blue(e))},success(e){r.log.success(n.green(e))},warn(e){r.log.warn(n.yellow(e))},error(e){r.log.error(n.red(e))},step(e){r.log.step(e)}};export{s as OutputFormatter,d as confirm,a as createCli,i as getCliVersion,m as log,p as note,c as parseOutputFormat,l as select,f as spinner,u as textInput};
+import"./rolldown-runtime-BqT_7tdF.js";import{createNodeLogger as e}from"@longzai-intelligence-logger/node";import{Command as t}from"commander";import"node:fs";import"node:path";import"node:url";const n=e(`@longzai-intelligence-cli/core/provider`),r={red:e=>e,green:e=>e,yellow:e=>e,blue:e=>e,bold:e=>e,gray:e=>e};let i={select:async(e,t)=>t[0]?.value??``,textInput:async(e,t)=>t?.defaultValue??``,confirm:async(e,t)=>t?.defaultValue??!1,spinner:()=>({start:e=>n.info(e),stop:e=>n.info(e)}),note:(e,t)=>{t?n.info(`${t}: ${e}`):n.info(e)},log:{info:e=>n.info(e),success:e=>n.info(e),warn:e=>n.warn(e),error:e=>n.error(e),step:e=>n.info(e)}},a=r;function o(e){i=e}function s(e){a=e}function c(){return i}function l(){return a}const u=()=>`0.0.2`;function d(e){let n=e.version??u();e.interaction&&o(e.interaction),e.color&&s(e.color);let r=new t;return r.name(e.name).version(n,`-v, --version`,`输出 ${e.name} 的版本号`),e.description&&r.description(e.description),r}const f=e(`@longzai-intelligence-cli/core/output`);var p=class{format;constructor(e=`text`){this.format=e}get colors(){return l()}success(e,t){this.format===`json`?f.info(JSON.stringify({success:!0,data:e},null,2)):f.info(t?this.colors.green(t):this.colors.green(this.formatData(e)))}error(e){if(this.format===`json`){let t=e instanceof Error?{message:e.message,name:e.name}:{message:String(e)};f.info(JSON.stringify({success:!1,error:t},null,2))}else{let t=e instanceof Error?e.message:String(e);f.error(this.colors.red(`错误: ${t}`))}}info(e){this.format===`json`?f.info(JSON.stringify({success:!0,message:e},null,2)):f.info(this.colors.blue(e))}warn(e){this.format===`json`?f.info(JSON.stringify({success:!0,warning:e},null,2)):f.info(this.colors.yellow(e))}table(e,t){if(this.format===`json`){let n=t.map(t=>{let n={};return e.forEach((e,r)=>{n[e]=t[r]??``}),n});f.info(JSON.stringify({success:!0,data:n},null,2))}else{let n=e.map((e,n)=>Math.max(e.length,...t.map(e=>(e[n]??``).length)));f.info(e.map((e,t)=>this.colors.bold(e.padEnd(n[t]??0))).join(`  `)),f.info(n.map(e=>`-`.repeat(e??0)).join(`  `));for(let e of t)f.info(e.map((e,t)=>(e??``).padEnd(n[t]??0)).join(`  `))}}formatData(e){return typeof e==`string`?e:typeof e==`number`||typeof e==`boolean`?String(e):JSON.stringify(e,null,2)}};function m(e){return e===`json`?`json`:`text`}async function h(e,t){return c().select(e,t)}async function g(e,t){return c().textInput(e,t)}async function _(e,t){return c().confirm(e,t)}function v(){return c().spinner()}function y(e,t){c().note(e,t)}const b={info(e){c().log.info(e)},success(e){c().log.success(e)},warn(e){c().log.warn(e)},error(e){c().log.error(e)},step(e){c().log.step(e)}},x=e(`@longzai-intelligence-cli/core/progress`);function S(e=100){let t=-1;return{update(e,n){let r=Math.max(0,Math.min(100,e)),i=Math.round(r/100*30),a=`█`.repeat(i)+`░`.repeat(30-i);if(e!==t){t=e;let i=n?` ${n}`:``;process.stdout.write(`\r${l().blue(a)} ${r.toFixed(0)}%${i}`),r>=100&&process.stdout.write(`
+`)}},done(e){process.stdout.write(`
+`),e&&x.info(l().green(`✓ ${e}`))}}}export{p as OutputFormatter,_ as confirm,d as createCli,u as getCliVersion,l as getColorProvider,c as getInteractionProvider,b as log,y as note,m as parseOutputFormat,S as progressBar,h as select,s as setColorProvider,o as setInteractionProvider,v as spinner,g as textInput};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@longzai-intelligence-cli/core",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "private": false,
   "keywords": [
     "cli",
@@ -36,11 +36,9 @@
     "clean": "lzi-dev-cli clean"
   },
   "dependencies": {
-    "@clack/prompts": "^0.11.0",
     "@longzai-intelligence-builder/utils": "^0.2.13",
     "@longzai-intelligence-logger/node": "^0.1.0",
-    "commander": "^14.0.0",
-    "picocolors": "^1.1.1"
+    "commander": "^14.0.0"
   },
   "devDependencies": {}
 }