@done-coding/cli-utils 0.8.0 → 0.8.2-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@done-coding/cli-utils",
-  "version": "0.8.0",
+  "version": "0.8.2-alpha.0",
   "description": "cli utils",
   "private": false,
   "module": "es/index.mjs",
@@ -50,7 +50,7 @@
     "@types/uuid": "^10.0.0",
     "@types/yargs": "^17.0.28",
     "rimraf": "^6.0.1",
-    "typescript": "^5.2.2",
+    "typescript": "^5.8.3",
     "vite": "^4.4.11",
     "vite-plugin-dts": "^3.6.0"
   },
@@ -70,5 +70,5 @@
     "uuid": "^11.1.0",
     "yargs": "^17.7.2"
   },
-  "gitHead": "e68f726aa899f75c4d294b11620f343c953a74c3"
+  "gitHead": "b09dd794f69ba2dafe22a3519d712d059c2eb376"
 }

package/types/index.d.ts

@@ -1,5 +1,4 @@
 import type { ArgumentsCamelCase } from 'yargs';
-import chalk from 'chalk';
 import type { CommandModule } from 'yargs';
 import _curry from 'lodash.curry';
 import _get from 'lodash.get';
@@ -31,7 +30,7 @@ export declare const addHuskyHooks: <H extends string>({ hookNames, rootDir, get
 
 /** 添加package.json配置 */
 export declare const addPackageConfig: ({ patchConfig, rootDir, }: {
-    patchConfig?: Record<string, any> | undefined;
+    patchConfig?: Record<string, any>;
     rootDir: string;
 }) => void;
 
@@ -44,15 +43,17 @@ export declare const applyUseTempDir: <T>({ dir, fn, endClear, exitClear, }: {
     dir: string;
     fn: (dir: string) => T;
     /** 结束时移除临时目录 */
-    endClear?: boolean | undefined;
+    endClear?: boolean;
     /** 退出信号是否移除临时目录 */
-    exitClear?: boolean | undefined;
+    exitClear?: boolean;
 }) => T;
 
 export { ArgumentsCamelCase }
 
 /** 文件或文件夹是否存在(同步) */
-export declare const assetIsExits: (assetPath: string) => boolean;
+export declare const assetIsExits: (
+/** 资源路径 */
+assetPath: string) => boolean;
 
 /**
  * 检查路径是否存在（包括文件、目录、符号链接）
@@ -60,8 +61,6 @@ export declare const assetIsExits: (assetPath: string) => boolean;
  */
 export declare const assetIsExitsAsync: (path: string) => Promise<boolean>;
 
-export { chalk }
-
 /** 检测当前正在变基 */
 export declare const checkCurrentIsRebasing: (rootDir: string) => boolean;
 
@@ -161,6 +160,30 @@ export declare const fileAddX: (filePath: string) => void;
 
 export { _get }
 
+/** 快捷获取答案 */
+export declare const getAnswerSwift: <V = unknown, T extends string = string>(key: T, 
+/** 表单问询配置 */
+questionConfig: Parameters<typeof prompts<T>>[0]) => Promise<V>;
+
+/**
+ * 获取答案 考虑mcp情况
+ * ----
+ * mcp 只拿预设值，非mcp优先拿默认值
+ * 有预设值的场景: MCP
+ */
+export declare const getAnswerWithMCP: <V = unknown, T extends string = string>({ isMCP, key, presetAnswer, defaultValue, questionConfig, }: {
+    /** 是否mcp场景 */
+    isMCP: boolean;
+    /** 表单key */
+    key: T;
+    /** 预设答案所在的对象 */
+    presetAnswer?: object & { [K in T]: any; };
+    /** 默认值 */
+    defaultValue?: V;
+    /** 表单问询配置 */
+    questionConfig: Parameters<typeof prompts<T>>[0];
+}) => Promise<V>;
+
 /** 获取cli模块【临时】目录[绝对路径] */
 export declare const getCliModuleTempDir: (moduleName: string) => string;
 
@@ -173,14 +196,14 @@ export declare const getCommitByHookName: ({ hookName, rootDir, }: {
 /** 获取配置文件通用选项 */
 export declare const getConfigFileCommonOptions: ({ configPathDefault, rootDirDefault, }: {
     configPathDefault: string;
-    rootDirDefault?: string | undefined;
+    rootDirDefault?: string;
 }) => Record<keyof ConfigFileCommonOptions, YargsOptions>;
 
 /** 获取当前分支最近提交列表 */
 export declare const getCurrentBranchLastCommitList: ({ count, }?: {
-    count?: number | undefined;
+    count?: number;
     /** 某个hash之后的提交 */
-    afterHash?: string | undefined;
+    afterHash?: string;
 }) => GitLogItemInfo[];
 
 /** 获取当前分支名 */
@@ -202,18 +225,41 @@ export declare interface GetGitLastCommitParams {
     remoteAlias?: GitRemoteInfo["alias"];
 }
 
+/**
+ * 获取git路径
+ * ---
+ * @param projectPath 项目路径
+ */
+export declare const getGitPath: (projectPath: string) => string;
+
 /** 获取git项目目录 */
 export declare const getGitProjectDir: (rootDir: string) => string;
 
 /** 获取最后的reflog */
 export declare const getLastReflogList: ({ count, filterItem, }?: {
-    count?: number | undefined;
+    count?: number;
     /** 某个hash之后的提交 */
-    afterHash?: string | undefined;
+    afterHash?: string;
     /** 过滤函数 */
-    filterItem?: ((item: GitReflogItemInfoRaw) => boolean) | undefined;
+    filterItem?: (item: GitReflogItemInfoRaw) => boolean;
 }) => GitReflogItemInfo[];
 
+/** 获取输出文字 */
+export declare const getLogText: ((type: LogTypeEnum, ...messages: unknown[]) => string) & {
+    /** 成功 */
+    success: (...messages: unknown[]) => string;
+    /** /步骤 */
+    stage: (...messages: unknown[]) => string;
+    /** 提示信息 */
+    info: (...messages: unknown[]) => string;
+    /** 警告 */
+    warn: (...messages: unknown[]) => string;
+    /** 错误 */
+    error: (...messages: unknown[]) => string;
+    /** 跳过 */
+    skip: (...messages: unknown[]) => string;
+};
+
 /** 获取package.json文件内容 */
 export declare const getPackageJson: <R extends PackageJson>({ rootDir, }: {
     rootDir: string;
@@ -222,7 +268,7 @@ export declare const getPackageJson: <R extends PackageJson>({ rootDir, }: {
 /** 获取依赖包版本 */
 export declare const getRelyPkgVersion: <R extends PackageJson>({ rootDir, pkgJson, pkgName, isDevPkg, }: {
     rootDir: string;
-    pkgJson?: R | undefined;
+    pkgJson?: R;
     pkgName: string;
     /** 是开发依赖包 */
     isDevPkg: boolean;
@@ -235,8 +281,8 @@ export declare const getRootDirOptions: (rootDirDefault?: string) => {
 
 /** 获取根命令名称 */
 export declare const getRootScriptName: ({ rootScriptName, packageJson, }: {
-    rootScriptName?: string | undefined;
-    packageJson?: Pick<PackageJson, "name" | "bin"> | undefined;
+    rootScriptName?: string;
+    packageJson?: Pick<PackageJson, "name" | "bin">;
 }) => string | undefined;
 
 /** 获取是否使用默认配置 */
@@ -421,8 +467,8 @@ export declare type InitConfigFileOptions = ConfigFileCommonOptions;
 /** 初始化配置文件通用处理器 */
 export declare const initHandlerCommon: <T>(content: T, argv: CliHandlerArgv<InitConfigFileOptions>, { onFileGenerated, edit, }?: {
     /** 文件已生成 */
-    onFileGenerated?: ((path: string) => void) | undefined;
-    edit?: boolean | undefined;
+    onFileGenerated?: (path: string) => void;
+    edit?: boolean;
 }) => Promise<void>;
 
 /** 是http git地址 */
@@ -434,21 +480,23 @@ export declare const isSshGitUrl: (url: string) => boolean;
 export { json5 }
 
 /** 日志 */
-export declare const log: ((type: LogTypeEnum, ...messages: string[]) => void) & {
+export declare const log: ((type: LogTypeEnum, ...messages: unknown[]) => void) & {
     /** 成功 */
-    success: (...messages: string[]) => void;
+    success: (...messages: unknown[]) => void;
     /** /步骤 */
-    stage: (...messages: string[]) => void;
+    stage: (...messages: unknown[]) => void;
     /** 提示信息 */
-    info: (...messages: string[]) => void;
+    info: (...messages: unknown[]) => void;
     /** 警告 */
-    warn: (...messages: string[]) => void;
+    warn: (...messages: unknown[]) => void;
     /** 错误 */
-    error: (...messages: string[]) => void;
+    error: (...messages: unknown[]) => void;
     /** 跳过 */
-    skip: (...messages: string[]) => void;
+    skip: (...messages: unknown[]) => void;
 };
 
+export declare type LogParams = [type: LogTypeEnum, ...messages: unknown[]];
+
 /** 日志类型 */
 declare enum LogTypeEnum {
     /** 成功 */
@@ -468,9 +516,11 @@ declare enum LogTypeEnum {
 /**
  * 查找目标文件或目录
  */
-export declare const lookForParentTarget: (target: string, { currentDir, isFindFarthest, }?: {
-    currentDir?: string | undefined;
-    isFindFarthest?: boolean | undefined;
+export declare const lookForParentTarget: (
+/** 目标文件或目录 */
+target: string, { currentDir, isFindFarthest, }?: {
+    currentDir?: string;
+    isFindFarthest?: boolean;
 }) => string | undefined;
 
 /** 用编辑器打开文件 */
@@ -510,7 +560,7 @@ export { PromptValueOrFunc }
 export declare const pushGitPublishInfoToRemote: ({ branchName, version, remoteInfo, }: {
     branchName: string;
     version: string;
-    remoteInfo?: GitRemoteInfo | undefined;
+    remoteInfo?: GitRemoteInfo;
 }) => void;
 
 /** 读取(某个模块)配置 */
@@ -535,7 +585,7 @@ export declare const readCliModuleAssetsConfig: <R>({ moduleName, onSuccess, }:
 }) => Promise<R>;
 
 /** 读取配置文件 */
-export declare const readConfigFile: <T>(options: ReadConfigFileOptions, onNotExists?: (() => T) | undefined) => Promise<T>;
+export declare const readConfigFile: <T>(options: ReadConfigFileOptions, onNotExists?: () => T) => Promise<T>;
 
 /** 读取配置文件选项 */
 export declare type ReadConfigFileOptions = ConfigFileCommonOptions;
@@ -547,24 +597,32 @@ export declare const readFile: (assetPath: string) => string;
 export declare const readFileAsync: (assetPath: string) => Promise<string>;
 
 /** 读取json文件[同步] */
-export declare const readJsonFile: <T>(assetPath: string, defaultValue?: T | undefined) => T;
+export declare const readJsonFile: <T>(assetPath: string, defaultValue?: T) => T;
 
 /** 读取json文件[异步] */
-export declare const readJsonFileAsync: <T>(assetPath: string, defaultValue?: T | undefined) => Promise<T>;
+export declare const readJsonFileAsync: <T>(assetPath: string, defaultValue?: T) => Promise<T>;
 
 /**
  * 删除资源 (同步)
  * ---
  * 无论文件还是文件夹
  */
-export declare const removeAsset: (assetPath: string, force?: boolean) => void;
+export declare const removeAsset: (
+/** 资源路径 */
+assetPath: string, 
+/** 是否要强删除 */
+force?: boolean) => void;
 
 /**
  * 删除资源 (异步)
  * ---
  * 无论文件还是文件夹
  */
-export declare const removeAssetAsync: (assetPath: string, force?: boolean) => Promise<void>;
+export declare const removeAssetAsync: (
+/** 资源路径 */
+assetPath: string, 
+/** 是否要强删除 */
+force?: boolean) => Promise<void>;
 
 /** 解析checkoutInfo */
 export declare const resolveCheckoutInfoByRefInfo: (message: string) => {
@@ -581,6 +639,13 @@ export declare const resolveMergeInfoByGitReflogAction: () => GitMergeBranchInfo
 /** 从reflog type解析合并信息 */
 export declare const resolveMergeInfoByRefType: (type: string) => GitMergeBranchInfo | undefined;
 
+/**
+ * 移除git控制 - 异步
+ * @param projectPath
+ * @returns
+ */
+export declare const rmGitCtrlAsync: (projectPath: string) => Promise<void>;
+
 export { _set }
 
 /** 子cli信息 */
@@ -597,7 +662,7 @@ export declare type SupportGetCommitByHookName = (typeof SUPPORT_GET_COMMIT_BY_H
 export { uuidv4 }
 
 /** prompts 拓展 */
-export declare const xPrompts: <T extends string = string>(questions: prompts.PromptObject<T> | prompts.PromptObject<T>[], options?: prompts.Options | undefined) => Promise<prompts.Answers<T>>;
+export declare const xPrompts: <T extends string = string>(...args: Parameters<typeof prompts<T>>) => Promise<prompts.Answers<T>>;
 
 export { YargsArgv }