@done-coding/cli-utils 0.7.8 → 0.8.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@done-coding/cli-utils",
-  "version": "0.7.8",
+  "version": "0.8.1",
   "description": "cli utils",
   "private": false,
   "module": "es/index.mjs",
@@ -47,6 +47,7 @@
     "@types/pinyin": "^2.10.0",
     "@types/prompts": "^2.4.6",
     "@types/semver": "^7.5.3",
+    "@types/uuid": "^10.0.0",
     "@types/yargs": "^17.0.28",
     "rimraf": "^6.0.1",
     "typescript": "^5.2.2",
@@ -66,7 +67,8 @@
     "pinyin": "^2.11.2",
     "prompts": "^2.4.2",
     "semver": "^7.5.4",
+    "uuid": "^11.1.0",
     "yargs": "^17.7.2"
   },
-  "gitHead": "67d4fc202427c5b2f387b856cfe9507127a5b26c"
+  "gitHead": "0930f800167c04a86b56eae9741872dd51bec0c6"
 }

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';
@@ -15,6 +14,7 @@ import prompts from 'prompts';
 import { PromptType } from 'prompts';
 import { ValueOrFunc as PromptValueOrFunc } from 'prompts';
 import _set from 'lodash.set';
+import { v4 as uuidv4 } from 'uuid';
 import yargs from 'yargs';
 import type { Argv as YargsArgv } from 'yargs';
 import type { Options as YargsOptions } from 'yargs';
@@ -34,9 +34,30 @@ export declare const addPackageConfig: ({ patchConfig, rootDir, }: {
     rootDir: string;
 }) => void;
 
+/**
+ * 申请使用临时目录
+ * ---
+ * !!! 临时目录 默认 执行完成及退出信号发出时 清理临时文件
+ */
+export declare const applyUseTempDir: <T>({ dir, fn, endClear, exitClear, }: {
+    dir: string;
+    fn: (dir: string) => T;
+    /** 结束时移除临时目录 */
+    endClear?: boolean | undefined;
+    /** 退出信号是否移除临时目录 */
+    exitClear?: boolean | undefined;
+}) => T;
+
 export { ArgumentsCamelCase }
 
-export { chalk }
+/** 文件或文件夹是否存在(同步) */
+export declare const assetIsExits: (assetPath: string) => boolean;
+
+/**
+ * 检查路径是否存在（包括文件、目录、符号链接）
+ * 异步版本，行为与 fs.existsSync 一致
+ */
+export declare const assetIsExitsAsync: (path: string) => Promise<boolean>;
 
 /** 检测当前正在变基 */
 export declare const checkCurrentIsRebasing: (rootDir: string) => boolean;
@@ -100,6 +121,22 @@ export declare function decryptAES({ encryptedText, secretKey, }: {
     secretKey: string;
 }): string;
 
+/** done-coding-cli 全局配置 */
+export declare type DoneCodingCliGlobalConfig = {
+    [K in DoneCodingCliGlobalConfigKeyEnum]: string;
+};
+
+/** done-coding-cli 全局配置 key 枚举 */
+export declare enum DoneCodingCliGlobalConfigKeyEnum {
+    /**
+     * 资产配置仓库
+     * ---
+     * 1. http ssh则认为远程仓库 临时拉取到本地临时目录中
+     * 2. 若非上述 则认为本地【绝对】路径
+     */
+    ASSETS_CONFIG_REPO_URL = "ASSETS_CONFIG_REPO_URL"
+}
+
 /** 编辑器类型枚举 */
 export declare enum EditorTypeEnum {
     /** vscode */
@@ -121,6 +158,9 @@ export declare const fileAddX: (filePath: string) => void;
 
 export { _get }
 
+/** 获取cli模块【临时】目录[绝对路径] */
+export declare const getCliModuleTempDir: (moduleName: string) => string;
+
 /** 根据hookName获取(将)提交的信息 */
 export declare const getCommitByHookName: ({ hookName, rootDir, }: {
     hookName: SupportGetCommitByHookName;
@@ -171,6 +211,22 @@ export declare const getLastReflogList: ({ count, filterItem, }?: {
     filterItem?: ((item: GitReflogItemInfoRaw) => boolean) | undefined;
 }) => 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;
@@ -391,21 +447,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 {
     /** 成功 */
@@ -470,19 +528,24 @@ export declare const pushGitPublishInfoToRemote: ({ branchName, version, remoteI
     remoteInfo?: GitRemoteInfo | undefined;
 }) => void;
 
-/** 读取配置 */
-export declare const readCliConfig: <R>({ moduleName, onSuccess, }: {
+/** 读取(某个模块)配置 */
+export declare const readCliModuleAssetsConfig: <R>({ moduleName, onSuccess, }: {
     moduleName: string;
     onSuccess: (params: {
+        /**
+         * 资产配置仓库地址
+         * ----
+         * 可能是 http ssh 也可能是本地【绝对】文件路径
+         */
         repoUrl: string;
-        /** 配置文件相对路径 */
-        cliConfigFileRelativePath: string;
-        /** 配置文件目录相对路径 */
-        cliConfigDirRelativePath: string;
+        /** 资产配置文件临时目录[绝对路径] */
+        assetsConfigRepoTempDir: string;
+        /** 模块对应的资产配置仓库(相对路径) */
+        moduleDirFileRelativePath: string;
+        /** 模块对应的资产配置入口文件(相对路径) */
+        moduleEntryFileRelativePath: string;
         /** 配置文件内容 */
         config: R;
-        /** 配置临时目录 */
-        configTemporaryDir: string;
     }) => void | Promise<void>;
 }) => Promise<R>;
 
@@ -492,6 +555,32 @@ export declare const readConfigFile: <T>(options: ReadConfigFileOptions, onNotEx
 /** 读取配置文件选项 */
 export declare type ReadConfigFileOptions = ConfigFileCommonOptions;
 
+/** 读取文件[同步] */
+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;
+
+/** 读取json文件[异步] */
+export declare const readJsonFileAsync: <T>(assetPath: string, defaultValue?: T | undefined) => Promise<T>;
+
+/**
+ * 删除资源 (同步)
+ * ---
+ * 无论文件还是文件夹
+ */
+export declare const removeAsset: (assetPath: string, force?: boolean) => void;
+
+/**
+ * 删除资源 (异步)
+ * ---
+ * 无论文件还是文件夹
+ */
+export declare const removeAssetAsync: (assetPath: string, force?: boolean) => Promise<void>;
+
 /** 解析checkoutInfo */
 export declare const resolveCheckoutInfoByRefInfo: (message: string) => {
     fromBranch: string;
@@ -520,6 +609,8 @@ export declare const SUPPORT_GET_COMMIT_BY_HOOKS_NAMES: readonly [HooksNameEnum.
 
 export declare type SupportGetCommitByHookName = (typeof SUPPORT_GET_COMMIT_BY_HOOKS_NAMES)[number];
 
+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>>;