@done-coding/cli-utils 0.2.2-alpha.0 → 0.3.1-alpha.0

package/es/index.mjs

@@ -1,37 +1,46 @@
 #!/usr/bin/env node
-import h from "chalk";
-import { default as O } from "chalk";
-import i from "node:path";
-import v from "node:fs";
-import f from "crypto";
-import S from "prompts";
-const c = Object.assign(
-  (r, ...n) => console.log(...n.map((e) => h[r](e))),
+import D from "chalk";
+import { default as ce } from "chalk";
+import a from "node:path";
+import O, { existsSync as h, mkdirSync as k, writeFileSync as g, readFileSync as m } from "node:fs";
+import l from "crypto";
+import H from "prompts";
+import E from "yargs";
+import { hideBin as F } from "yargs/helpers";
+import { execSync as y } from "node:child_process";
+import v from "json5";
+export * from "json5";
+import { default as ue } from "json5";
+import { default as pe } from "lodash.get";
+import { default as ge } from "lodash.set";
+import { default as ye } from "lodash.curry";
+const i = Object.assign(
+  (e, ...o) => console.log(...o.map((r) => D[e](r))),
   {
     /** 成功 */
-    success: (...r) => c("green", ...r),
+    success: (...e) => i("green", ...e),
     /** /步骤 */
-    stage: (...r) => c("blue", ...r),
+    stage: (...e) => i("blue", ...e),
     /** 提示信息 */
-    info: (...r) => c("cyan", ...r),
+    info: (...e) => i("cyan", ...e),
     /** 警告 */
-    warn: (...r) => c("yellow", ...r),
+    warn: (...e) => i("yellow", ...e),
     /** 错误 */
-    error: (...r) => c("red", ...r),
+    error: (...e) => i("red", ...e),
     /** 跳过 */
-    skip: (...r) => c("gray", ...r)
+    skip: (...e) => i("gray", ...e)
   }
-), k = (r, n = process.cwd()) => {
-  const e = i.resolve(n).split(i.sep).map((t, o, s) => o ? i.join(s.slice(0, o).join(i.sep), t) : t);
-  for (; e.length; ) {
-    const t = e.pop(), o = i.join(t, r);
-    if (v.existsSync(o))
+), G = (e, o = process.cwd()) => {
+  const r = a.resolve(o).split(a.sep).map((t, n, c) => n ? a.join(c.slice(0, n).join(a.sep), t) : t);
+  for (; r.length; ) {
+    const t = r.pop(), n = a.join(t, e);
+    if (O.existsSync(n))
       return t;
   }
-}, m = "aes-256-cbc", y = 16, u = "hex", d = ":";
-function g(r) {
-  return f.pbkdf2Sync(
-    r,
+}, C = "aes-256-cbc", S = 16, p = "hex", d = ":";
+function $(e) {
+  return l.pbkdf2Sync(
+    e,
     "done-coding-cli-salt",
     // 使用固定的盐值
     1e4,
@@ -41,55 +50,191 @@ function g(r) {
     "sha256"
   );
 }
-function A({
-  text: r,
-  secretKey: n
+function Q({
+  text: e,
+  secretKey: o
 }) {
   try {
-    const e = g(n), t = f.randomBytes(y), o = f.createCipheriv(m, e, t);
-    let s = o.update(r);
-    s = Buffer.concat([s, o.final()]);
-    const a = t.toString(u), p = s.toString(u);
-    return `${a}${d}${p}`;
-  } catch (e) {
-    return c.error(
-      `加密失败: ${e instanceof Error ? e.message : String(e)}`
+    const r = $(o), t = l.randomBytes(S), n = l.createCipheriv(C, r, t);
+    let c = n.update(e);
+    c = Buffer.concat([c, n.final()]);
+    const u = t.toString(p), s = c.toString(p);
+    return `${u}${d}${s}`;
+  } catch (r) {
+    return i.error(
+      `加密失败: ${r instanceof Error ? r.message : String(r)}`
     ), "";
   }
 }
-function B({
-  encryptedText: r,
-  secretKey: n
+function X({
+  encryptedText: e,
+  secretKey: o
 }) {
   try {
-    if (!r.includes(d))
+    if (!e.includes(d))
       return "";
-    const e = g(n), [t, o] = r.split(d);
-    if (t.length !== y * 2)
+    const r = $(o), [t, n] = e.split(d);
+    if (t.length !== S * 2)
       return "";
-    const s = Buffer.from(t, u), a = Buffer.from(o, u), p = f.createDecipheriv(m, e, s);
-    let l = p.update(a);
-    return l = Buffer.concat([l, p.final()]), l.toString();
-  } catch (e) {
-    return c.error(
-      `解密失败: ${e instanceof Error ? e.message : String(e)}`
+    const c = Buffer.from(t, p), u = Buffer.from(n, p), s = l.createDecipheriv(C, r, c);
+    let f = s.update(u);
+    return f = Buffer.concat([f, s.final()]), f.toString();
+  } catch (r) {
+    return i.error(
+      `解密失败: ${r instanceof Error ? r.message : String(r)}`
     ), "";
   }
 }
-const j = (...r) => {
-  const [n, e = {}] = r;
-  return S(n, {
+const x = (...e) => {
+  const [o, r = {}] = e;
+  return H(o, {
     onCancel(t) {
-      return c.error(`退出${t == null ? void 0 : t.name}输入`), process.exit(1);
+      return i.error(`退出${t == null ? void 0 : t.name}输入`), process.exit(1);
     },
-    ...e
+    ...r
   });
+}, R = (e, o) => {
+  e ? i.error(e) : i.error(o.message), o != null && o.stack && i.error(o.stack), process.exit(1);
+}, T = () => {
+  const e = F(process.argv);
+  return E(e);
+}, j = (e, {
+  usage: o,
+  version: r,
+  demandCommandCount: t,
+  options: n,
+  positionals: c,
+  subcommands: u
+}) => {
+  let s = e.strict();
+  o && (s = s.usage(`Usage: ${o}`)), t && (s = s.demandCommand(t));
+  const f = "help";
+  return s = s.help(f), r ? s = s.version(r).alias("h", f).alias("v", "version") : s = s.alias("h", f), n && (s = s.options(n)), c && (s = Object.entries(c).reduce((w, [P, b]) => w.positional(P, b), s)), u && (s = s.command(u)), s;
+}, Z = async ({ handler: e, ...o }) => {
+  const r = await j(T(), o).fail(R).argv;
+  return e ? e(r) : r;
+}, ee = (e) => {
+  const { command: o, describe: r, handler: t = () => {
+  }, ...n } = e;
+  return {
+    command: o,
+    describe: r,
+    builder(c) {
+      return j(c, n);
+    },
+    handler: t
+  };
+};
+var _ = /* @__PURE__ */ ((e) => (e.VSCODE = "VsCode", e.CURSOR = "Cursor", e.OTHER = "其他", e))(_ || {});
+const A = async () => {
+  const { editorType: e } = await x([
+    {
+      name: "editorType",
+      type: "select",
+      message: "编辑器类型",
+      choices: [
+        "Cursor",
+        "VsCode",
+        "其他"
+        /* OTHER */
+      ].map((o) => ({
+        title: o,
+        value: o
+      }))
+    }
+  ]);
+  return e;
+}, B = {
+  Cursor: "cursor",
+  VsCode: "code"
+}, N = (e, o, r) => {
+  try {
+    y(`${e} -v`, { stdio: "ignore" }), y(`${e} ${o}`);
+  } catch {
+    r();
+  }
+}, V = (e, o) => {
+  const r = (t) => i.info(`
+      ${t}, 请用编辑器打开 ${e} 进行编辑
+`);
+  switch (o) {
+    case "Cursor":
+    case "VsCode": {
+      const t = B[o];
+      N(t, e, () => {
+        r(`${t}命令未安装`);
+      });
+      break;
+    }
+    default:
+      r("其他编辑器");
+  }
+}, re = ({
+  configPathDefault: e
+}) => ({
+  /** 必须保留 */
+  rootDir: {
+    type: "string",
+    alias: "r",
+    describe: "运行目录",
+    /** 必须设置默认值 */
+    default: process.cwd()
+  },
+  /** 必须保留 */
+  configPath: {
+    type: "string",
+    alias: "c",
+    describe: "配置文件相对路径",
+    /** 必须设置默认值 */
+    default: e
+  }
+}), L = async (e, o) => {
+  const { configPath: r, rootDir: t } = o, n = a.resolve(t, r), c = a.dirname(n);
+  return h(c) || k(c, {
+    recursive: !0
+  }), n.endsWith(".json5") ? (i.info(`json5模式写入 ${n}`), g(n, v.stringify(e, null, 2)), n) : (i.info(`json模式写入 ${n}`), g(n, JSON.stringify(e, null, 2)), n);
+}, te = async (e, o, {
+  onFileGenerated: r
+} = {}) => {
+  const t = await L(e, o);
+  r == null || r(t);
+  const n = await A();
+  V(o.configPath, n);
+}, oe = async (e) => {
+  const { configPath: o, rootDir: r } = e, t = a.resolve(r, o);
+  if (!h(t)) {
+    i.warn(`配置文件不存在 ${t}`);
+    return;
+  }
+  return t.endsWith(".json5") ? (i.info(`json5模式解析 ${t}`), v.parse(m(t, "utf8"))) : (i.info(`json模式解析 ${t}`), JSON.parse(m(t, "utf8")));
+}, ne = async () => {
+  const { useDefaultConfig: e } = await x({
+    name: "useDefaultConfig",
+    type: "confirm",
+    message: "使用默认模板配置",
+    initial: !0
+  });
+  return e;
 };
 export {
-  O as chalk,
-  B as decryptAES,
-  A as encryptAES,
-  c as log,
-  k as lookForParentTarget,
-  j as xPrompts
+  _ as EditorTypeEnum,
+  ye as _curry,
+  pe as _get,
+  ge as _set,
+  ce as chalk,
+  Z as createMainCommand,
+  ee as createSubcommand,
+  X as decryptAES,
+  Q as encryptAES,
+  re as getConfigFileCommonOptions,
+  A as getEditorType,
+  ne as getUseDefaultConfig,
+  L as initConfigFile,
+  te as initHandlerCommon,
+  ue as json5,
+  i as log,
+  G as lookForParentTarget,
+  V as openFileInEditor,
+  oe as readConfigFile,
+  x as xPrompts
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@done-coding/cli-utils",
-  "version": "0.2.2-alpha.0",
+  "version": "0.3.1-alpha.0",
   "description": "cli utils",
   "private": false,
   "module": "es/index.mjs",
@@ -14,8 +14,7 @@
   "files": [
     "es",
     "lib",
-    "types",
-    "gif"
+    "types"
   ],
   "scripts": {
     "clean": "rimraf es lib types",
@@ -38,6 +37,10 @@
   "license": "MIT",
   "sideEffects": false,
   "devDependencies": {
+    "@types/json5": "^2.2.0",
+    "@types/lodash.curry": "^4.1.8",
+    "@types/lodash.get": "^4.4.9",
+    "@types/lodash.set": "^4.3.9",
     "@types/node": "^18.0.0",
     "@types/prompts": "^2.4.6",
     "@types/yargs": "^17.0.28",
@@ -51,8 +54,12 @@
   },
   "dependencies": {
     "chalk": "^5.3.0",
+    "json5": "^2.2.3",
+    "lodash.curry": "^4.1.1",
+    "lodash.get": "^4.4.2",
+    "lodash.set": "^4.3.2",
     "prompts": "^2.4.2",
     "yargs": "^17.7.2"
   },
-  "gitHead": "2e59e86ee192e023138e7475f4abbb5e7c42b29e"
+  "gitHead": "ec6957606bbae68d7268159b38b9d36dab4a2731"
 }

package/types/cli.d.ts

@@ -0,0 +1,43 @@
+import type { ArgumentsCamelCase, CommandModule, Options as YargsOptions, Argv as YargsArgv } from "yargs";
+import yargs from "yargs";
+export { ArgumentsCamelCase, CommandModule, YargsOptions, YargsArgv };
+/** cli 信息 */
+export interface CliInfo {
+    /** 命令 */
+    command?: string;
+    /** 用法 */
+    usage?: string;
+    /** 描述信息  */
+    describe?: string;
+    /** 版本号 */
+    version?: string;
+    /** 必传命令数 */
+    demandCommandCount?: number;
+    /** 选项 */
+    options?: {
+        [key in string]: YargsOptions;
+    };
+    /** 子命令 */
+    subcommands?: CommandModule[];
+    /** 位置信息 */
+    positionals?: {
+        [key in string]: Parameters<typeof yargs.positional>[1];
+    };
+    /** 处理函数 */
+    handler?: CommandModule["handler"];
+}
+/** 子cli信息 */
+export interface SubCliInfo extends CliInfo {
+    /** 命令 */
+    command: string;
+}
+/** 处理函数参数类型 */
+export type CliHandlerArgv<O> = ArgumentsCamelCase<O> | O;
+/** 创建主命令 */
+export declare const createMainCommand: ({ handler, ...config }: CliInfo) => Promise<void | {
+    [x: string]: unknown;
+    _: (string | number)[];
+    $0: string;
+}>;
+/** 创建子命令模块 */
+export declare const createSubcommand: (cliInfo: SubCliInfo) => CommandModule;

package/types/config-file.d.ts

@@ -0,0 +1,31 @@
+import type { CliHandlerArgv, YargsOptions } from "./cli";
+/** 配置文件通用选项 */
+export interface ConfigFileCommonOptions {
+    /**
+     * 相对于路径
+     * ---
+     * 绝对路径 path.resolve(rootDir, configPath)
+     */
+    configPath: string;
+    /** 项目根目录 */
+    rootDir: string;
+}
+/** 初始化文件选项 */
+export type InitConfigFileOptions = ConfigFileCommonOptions;
+/** 读取配置文件选项 */
+export type ReadConfigFileOptions = ConfigFileCommonOptions;
+/** 获取配置文件通用选项 */
+export declare const getConfigFileCommonOptions: ({ configPathDefault, }: {
+    configPathDefault: string;
+}) => Record<keyof ConfigFileCommonOptions, YargsOptions>;
+/** 初始化配置文件 */
+export declare const initConfigFile: <T>(content: T, argv: CliHandlerArgv<InitConfigFileOptions>) => Promise<string>;
+/** 初始化配置文件通用处理器 */
+export declare const initHandlerCommon: <T>(content: T, argv: CliHandlerArgv<InitConfigFileOptions>, { onFileGenerated, }?: {
+    /** 文件已生成 */
+    onFileGenerated?: ((path: string) => void) | undefined;
+}) => Promise<void>;
+/** 读取配置文件 */
+export declare const readConfigFile: <T>(argv: CliHandlerArgv<ReadConfigFileOptions>) => Promise<T | undefined>;
+/** 获取是否使用默认配置 */
+export declare const getUseDefaultConfig: () => Promise<any>;

package/types/editor.d.ts

@@ -0,0 +1,13 @@
+/** 编辑器类型枚举 */
+export declare enum EditorTypeEnum {
+    /** vscode */
+    VSCODE = "VsCode",
+    /** cursor */
+    CURSOR = "Cursor",
+    /** 其他编辑器 */
+    OTHER = "\u5176\u4ED6"
+}
+/** 获取编辑器类型 */
+export declare const getEditorType: () => Promise<any>;
+/** 用编辑器打开文件 */
+export declare const openFileInEditor: (path: string, editorType: EditorTypeEnum) => void;

package/types/index.d.ts

@@ -2,3 +2,8 @@ export * from "./log";
 export * from "./look-for";
 export * from "./aes";
 export * from "./prompts";
+export * from "./cli";
+export * from "./editor";
+export * from "./config-file";
+export * from "./json5";
+export * from "./lodash";

package/types/json5.d.ts

@@ -0,0 +1,3 @@
+import json5 from "json5";
+export { json5 };
+export * from "json5";

package/types/lodash.d.ts

@@ -0,0 +1,4 @@
+import _get from "lodash.get";
+import _set from "lodash.set";
+import _curry from "lodash.curry";
+export { _get, _set, _curry };