@done-coding/cli-extract 0.0.4-alpha.0 → 0.1.1-alpha.0

package/es/cli.mjs

@@ -1,4 +1,7 @@
 #!/usr/bin/env node
-import { c as m } from "./index-b588f95e.js";
+import { c as m } from "./index-7b2a1d96.js";
 import "@done-coding/cli-utils";
+import "node:path";
+import "node:fs";
+import "@done-coding/cli-template";
 m();

package/es/helpers.mjs

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/es/index-7b2a1d96.js

@@ -0,0 +1,316 @@
+#!/usr/bin/env node
+import { log as r, _get as O, _curry as I, createSubcommand as h, getConfigFileCommonOptions as R, initHandlerCommon as v, readConfigFile as G, _set as H, createMainCommand as V } from "@done-coding/cli-utils";
+import D from "node:path";
+import N from "node:fs";
+import { OutputModeEnum as L, batchCompileHandler as W } from "@done-coding/cli-template";
+var u = /* @__PURE__ */ ((e) => (e.INIT = "init", e.GENERATE = "generate", e))(u || {}), d = /* @__PURE__ */ ((e) => (e.REG = "reg", e.JSON_INJECT = "json-inject", e))(d || {}), p = /* @__PURE__ */ ((e) => (e.INIT = "init", e.GENERATE = "generate", e))(p || {}), s = /* @__PURE__ */ ((e) => (e.REG = "reg", e.FIXED = "fixed", e.READ = "read", e))(s || {});
+const j = ({
+  sourceJson: e,
+  targetKey: n,
+  keyConfig: t
+}) => {
+  let o;
+  typeof t == "string" ? o = {
+    type: s.FIXED,
+    value: t
+  } : o = t;
+  const { type: c = s.READ } = o;
+  switch (c) {
+    case s.REG: {
+      const { sourceKey: a, pattern: f, replaceValue: E, flags: g } = o, l = new RegExp(f, g ?? void 0), i = O(e, a);
+      return typeof i == "string" ? i.replace(l, E) : (r.warn(
+        `${i}不是字符串类型，无法使用正则表达式进行替换，此处将直接返回原值`
+      ), i);
+    }
+    case s.FIXED: {
+      const { value: a } = o;
+      return a;
+    }
+    case s.READ:
+      return O(e, n);
+    default: {
+      r.warn(`未知的配置类型${c}`);
+      return;
+    }
+  }
+}, F = {
+  sourceFilePath: "./package.json",
+  keyConfigMap: {
+    name: {
+      type: s.READ
+    },
+    version: {
+      type: s.READ
+    },
+    description: {
+      type: s.READ
+    }
+  },
+  injectFilePath: "./src/injectInfo.json"
+}, J = {
+  name: "@done-coding/cli-inject",
+  version: "0.5.2-alpha.0",
+  description: "信息(JSON)注入命令行工具",
+  cliConfig: {
+    namespaceDir: ".done-coding",
+    moduleName: "inject"
+  }
+}, {
+  cliConfig: { namespaceDir: U, moduleName: X }
+} = J, K = `./${U}/${X}`, $ = `${K}.json`, q = () => R({
+  configPathDefault: $
+}), z = async (e) => v(F, e, {
+  onFileGenerated: () => {
+    r.info("文件生成成功");
+  }
+}), B = () => ({
+  ...R({
+    configPathDefault: $
+  })
+}), Q = async ({
+  rootDir: e = process.cwd(),
+  config: n = F,
+  keyConfigMap: t = {}
+} = {}) => {
+  const {
+    sourceFilePath: o,
+    keyConfigMap: c,
+    injectFilePath: a
+  } = n, f = {
+    ...c,
+    ...t
+  };
+  if (!o.endsWith(".json"))
+    return r.error("源文件必须是json"), process.exit(1);
+  if (!a.endsWith(".json"))
+    return r.error("注入文件必须是json"), process.exit(1);
+  const E = D.resolve(e, o), g = N.readFileSync(E, "utf-8"), l = JSON.parse(g), i = Object.entries(f).reduce(
+    (C, [T, P]) => {
+      const M = j({ sourceJson: l, targetKey: T, keyConfig: P });
+      return H(C, T, M), C;
+    },
+    {}
+  ), m = D.resolve(e, a), y = JSON.stringify(i, null, 2);
+  if (N.existsSync(m)) {
+    const C = N.readFileSync(m, "utf-8");
+    if (y === C)
+      return r.skip("注入文件已存在且内容相同，无需重复注入"), i;
+    r.stage("文件内容变化,开始覆盖注入文件");
+  } else
+    r.stage("开始注入文件");
+  N.writeFileSync(m, y), r.success(`文件注入成功: ${m}`), r.info(y);
+}, Y = async (e) => {
+  const n = await G(e);
+  if (!n)
+    return r.error("配置文件为空"), process.exit(1);
+  const { rootDir: t } = e;
+  await Q({ rootDir: t, config: n });
+}, w = async (e, n) => e === p.INIT ? z(n) : e === p.GENERATE ? Y(n) : (r.error(`无效的命令: ${e}`), process.exit(1)), {
+  version: Z,
+  description: ee,
+  cliConfig: { moduleName: he }
+} = J, ne = {
+  command: p.INIT,
+  describe: "初始化提取配置文件",
+  options: q(),
+  handler: I(w)(
+    p.INIT
+  )
+}, te = {
+  command: p.GENERATE,
+  describe: "提取信息",
+  options: B(),
+  handler: I(w)(
+    p.GENERATE
+  )
+};
+[ne, te].map(
+  h
+);
+const oe = {
+  name: "${name}",
+  version: "${version}",
+  description: "${description}"
+}, re = {
+  extractInput: {
+    "./package.json": {
+      name: {
+        type: d.JSON_INJECT,
+        inject: {
+          type: s.READ
+        }
+      },
+      description: {
+        type: d.JSON_INJECT,
+        inject: {
+          type: s.READ
+        }
+      },
+      version: {
+        type: d.JSON_INJECT,
+        inject: {
+          type: s.READ
+        }
+      }
+    },
+    "./README.md": {
+      docDescription: {
+        type: d.REG,
+        pattern: /#\s*([^`])+```([^`]+)```/.source,
+        replaceValue: ""
+      },
+      usage: {
+        type: d.REG,
+        pattern: /##\s*使用\s*```([^`]+)```/.source,
+        replaceValue: "$1"
+      }
+    }
+  },
+  extractOutput: {
+    list: [
+      {
+        mode: L.OVERWRITE,
+        inputData: JSON.stringify(oe, null, 2),
+        output: "./src/extractInfo.json"
+      }
+    ]
+  }
+}, x = {
+  name: "@done-coding/cli-extract",
+  version: "0.1.1-alpha.0",
+  description: "信息提取命令行工具",
+  cliConfig: {
+    namespaceDir: ".done-coding",
+    moduleName: "extract"
+  }
+}, {
+  cliConfig: { namespaceDir: se, moduleName: ie }
+} = x, ce = `./${se}/${ie}`, S = `${ce}.json5`, ae = () => R({
+  configPathDefault: S
+}), de = async (e) => v(re, e, {
+  onFileGenerated: () => {
+    r.info("文件生成成功");
+  }
+}), ue = ({
+  input: e,
+  rootDir: n
+}) => {
+  const t = D.resolve(n, e), o = N.readFileSync(t, "utf-8");
+  return e.endsWith(".json") || e.endsWith(".json5") ? JSON.parse(o) : o;
+}, pe = (e) => typeof e == "object" && !!e, le = ({
+  content: e,
+  targetKey: n,
+  keyConfig: t
+}) => {
+  const { type: o, ...c } = t;
+  switch (o) {
+    case d.REG: {
+      if (typeof e != "string")
+        throw new Error(`${o} 类型的keyConfig需要content为字符串`);
+      return j({
+        sourceJson: {
+          [n]: e
+        },
+        targetKey: n,
+        keyConfig: {
+          ...c,
+          type: s.REG,
+          sourceKey: n
+        }
+      });
+    }
+    case d.JSON_INJECT: {
+      if (!pe(e))
+        throw new Error(`${o} 类型的keyConfig需要content为json`);
+      return j({
+        sourceJson: e,
+        targetKey: n,
+        keyConfig: t.inject
+      });
+    }
+    default:
+      throw new Error(`不支持的类型${o}`);
+  }
+}, me = () => ({
+  ...R({
+    configPathDefault: S
+  })
+}), fe = async ({
+  rootDir: e = process.cwd(),
+  config: n
+}) => {
+  const { extractInput: t, extractOutput: o } = n, c = Object.entries(t).reduce(
+    (a, [f, E]) => {
+      const g = ue({
+        rootDir: e,
+        input: f
+      });
+      return Object.entries(E).reduce(
+        (l, [i, m]) => {
+          const y = le({
+            content: g,
+            targetKey: i,
+            keyConfig: m
+          });
+          return l[i] = y, l;
+        },
+        a
+      );
+    },
+    {}
+  );
+  await W(
+    {
+      rootDir: e,
+      extraEnvData: c
+    },
+    o
+  );
+}, Ee = async (e) => {
+  const n = await G(e);
+  if (!n)
+    return r.error("配置文件为空"), process.exit(1);
+  const { rootDir: t } = e;
+  await fe({ rootDir: t, config: n });
+}, b = async (e, n) => e === u.INIT ? de(n) : e === u.GENERATE ? Ee(n) : (r.error(`无效的命令: ${e}`), process.exit(1)), {
+  version: ge,
+  description: ye,
+  cliConfig: { moduleName: A }
+} = x, Ne = {
+  command: u.INIT,
+  describe: "初始化提取配置文件",
+  options: ae(),
+  handler: I(b)(
+    u.INIT
+  )
+}, Ce = {
+  command: u.GENERATE,
+  describe: "提取信息",
+  options: me(),
+  handler: I(b)(
+    u.GENERATE
+  )
+}, _ = {
+  describe: ye,
+  version: ge,
+  subcommands: [Ne, Ce].map(
+    h
+  ),
+  demandCommandCount: 1
+}, k = (e = !1) => {
+  const n = e ? A : void 0, t = `$0${e ? ` ${A}` : ""} <command> [options]`;
+  return { command: n, usage: t };
+}, Te = async () => V({
+  ..._,
+  ...k()
+}), Oe = () => h({
+  ..._,
+  ...k(!0)
+});
+export {
+  d as E,
+  u as S,
+  Oe as a,
+  Te as c,
+  b as h
+};

package/es/index.mjs

@@ -1,7 +1,12 @@
 #!/usr/bin/env node
-import { a as n, h as o } from "./index-b588f95e.js";
+import { E as e, S as p, a as s, h as i } from "./index-7b2a1d96.js";
 import "@done-coding/cli-utils";
+import "node:path";
+import "node:fs";
+import "@done-coding/cli-template";
 export {
-  n as crateAsSubcommand,
-  o as handler
+  e as ExtractTypeEnum,
+  p as SubcommandEnum,
+  s as crateAsSubcommand,
+  i as handler
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@done-coding/cli-extract",
-  "version": "0.0.4-alpha.0",
+  "version": "0.1.1-alpha.0",
   "description": "信息提取命令行工具",
   "private": false,
   "module": "es/index.mjs",
@@ -12,13 +12,23 @@
   "exports": {
     ".": {
       "import": "./es/index.mjs"
+    },
+    "./helpers": {
+      "import": "./es/helpers.mjs",
+      "types": "./types/helpers.d.ts"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "helpers": [
+        "./types/helpers.d.ts"
+      ]
     }
   },
   "files": [
     "es",
     "lib",
-    "types",
-    "gif"
+    "types"
   ],
   "scripts": {
     "clean": "rimraf es lib types",
@@ -41,7 +51,7 @@
   "license": "MIT",
   "sideEffects": false,
   "devDependencies": {
-    "@done-coding/cli-inject": "^0.5.0-alpha.0",
+    "@done-coding/cli-inject": "^0.5.2-alpha.0",
     "@types/node": "^18.0.0",
     "@types/yargs": "^17.0.28",
     "rimraf": "^6.0.1",
@@ -53,7 +63,8 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@done-coding/cli-utils": "^0.3.0-alpha.0"
+    "@done-coding/cli-template": "0.7.3-alpha.0",
+    "@done-coding/cli-utils": "^0.3.2-alpha.0"
   },
-  "gitHead": "25909f1ffe943c46fdb40133e959c3fc684b023a"
+  "gitHead": "7faf662e137d46f776c8e5abdf75ab3db541362c"
 }

package/types/handler.d.ts

@@ -1,3 +1,5 @@
-import type { Options } from './utils';
+import type { GenerateOptions, InitOptions } from './utils';
+import { SubcommandEnum } from './utils';
 import type { CliHandlerArgv } from "@done-coding/cli-utils";
-export declare const handler: (argv: CliHandlerArgv<Options>) => Promise<void>;
+/** 命令处理函数 */
+export declare const handler: (command: SubcommandEnum, argv: CliHandlerArgv<InitOptions | GenerateOptions>) => Promise<void>;

package/types/helpers/index.d.ts

@@ -0,0 +1,3 @@
+import { type ExtractConfig } from '../utils';
+/** done-coding 系列cli 注入信息 */
+export declare const doneCodingSeriesCliInjectInfo: ExtractConfig;

package/types/helpers.d.ts

@@ -0,0 +1 @@
+export * from './helpers';

package/types/index.d.ts

@@ -1,2 +1,3 @@
 export { handler } from "./handler";
 export { crateAsSubcommand } from "./main";
+export * from './utils/types';

package/types/injectInfo.json.d.ts

@@ -1,6 +1,6 @@
 declare const _default: {
-  "version": "0.0.4-alpha.0",
   "name": "@done-coding/cli-extract",
+  "version": "0.1.1-alpha.0",
   "description": "信息提取命令行工具",
   "cliConfig": {
     "namespaceDir": ".done-coding",

package/types/json/default.d.ts

@@ -0,0 +1,2 @@
+import { type ExtractConfig } from '../utils';
+export declare const config: ExtractConfig;

package/types/utils/generate.d.ts

@@ -0,0 +1,11 @@
+import { type CliHandlerArgv, type CliInfo } from "@done-coding/cli-utils";
+import type { ExtractConfig, GenerateOptions } from "./types";
+/** 获取生成命令选项 */
+export declare const getGenerateOptions: () => CliInfo["options"];
+/** 将提取的信息生成文件 */
+export declare const generateFile: ({ rootDir, config, }: {
+    rootDir?: string | undefined;
+    config: ExtractConfig;
+}) => Promise<void>;
+/** 提取文件命令处理器 */
+export declare const generateHandler: (argv: CliHandlerArgv<GenerateOptions>) => Promise<undefined>;

package/types/utils/index.d.ts

@@ -1 +1,4 @@
 export * from "./types";
+export * from "./init";
+export * from "./generate";
+export * from "./path";

package/types/utils/init.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="yargs" />
+import type { CliHandlerArgv } from "@done-coding/cli-utils";
+import type { InitOptions } from "./types";
+/** 获取初始化选项 */
+export declare const getInitOptions: () => Record<keyof import("@done-coding/cli-utils").ConfigFileCommonOptions, import("yargs").Options>;
+/** 初始化命令处理器 */
+export declare const initHandler: (argv: CliHandlerArgv<InitOptions>) => Promise<void>;

package/types/utils/path.d.ts

@@ -0,0 +1,4 @@
+/** 模块配置相对路径 */
+export declare const MODULE_CONFIG_RELATIVE_PATH: string;
+/** 模块默认配置文件相对路径 */
+export declare const MODULE_DEFAULT_CONFIG_RELATIVE_PATH: string;

package/types/utils/resolve.d.ts

@@ -0,0 +1,14 @@
+import { type ExtractInputKeyConfig } from "./types";
+/** 内容解析 */
+export declare const contentResolve: ({ input, rootDir, }: {
+    input: string;
+    rootDir: string;
+}) => string | Record<string, any>;
+/** 内容是否为对象 */
+export declare const contentIsObj: (content: ReturnType<typeof contentResolve>) => boolean;
+/** 配置解析 */
+export declare const keyConfigResolve: ({ content, targetKey, keyConfig, }: {
+    content: ReturnType<typeof contentResolve>;
+    targetKey: string;
+    keyConfig: ExtractInputKeyConfig;
+}) => any;

package/types/utils/types.d.ts

@@ -1,3 +1,60 @@
-export interface Options {
-    xx: string;
+import type { InitConfigFileOptions, ReadConfigFileOptions } from "@done-coding/cli-utils";
+import type { CompileTemplateConfig } from "@done-coding/cli-template";
+import type { InjectKeyConfig, InjectKeyConfigReg } from "@done-coding/cli-inject";
+/** 子命令枚举 */
+export declare enum SubcommandEnum {
+    /** 初始化提取配置文件 */
+    INIT = "init",
+    /** 生成文件 */
+    GENERATE = "generate"
 }
+/** 提取方式枚举 */
+export declare enum ExtractTypeEnum {
+    /**
+     * 正则 类型
+     * ---
+     * 通过正则匹配后 replace 替换
+     */
+    REG = "reg",
+    /**
+     * json注入 类型
+     * ---
+     * 只限于读取json文件 input\output 均为json文件
+     * ---
+     * 内部直接调用 @done-coding/cli-inject
+     */
+    JSON_INJECT = "json-inject"
+}
+/** 初始化选项 */
+export type InitOptions = InitConfigFileOptions;
+/** 提取配置基础 */
+export interface ExtractInputKeyConfigBase<T extends ExtractTypeEnum> {
+    /**
+     * 提取类型
+     */
+    type: T;
+}
+/** 提取配置正则表达式 */
+export interface ExtractInputKeyConfigReg extends ExtractInputKeyConfigBase<ExtractTypeEnum.REG>, Omit<InjectKeyConfigReg, "type" | "sourceKey"> {
+}
+/** 提取配置直接读取 */
+export interface ExtractInputKeyConfigJsonInject extends ExtractInputKeyConfigBase<ExtractTypeEnum.JSON_INJECT> {
+    inject: InjectKeyConfig;
+}
+/** 提取配置 */
+export type ExtractInputKeyConfig = ExtractInputKeyConfigReg | ExtractInputKeyConfigJsonInject;
+/** 提取输入配置 */
+export interface ExtractInputConfig {
+    [key: string]: ExtractInputKeyConfig;
+}
+export interface ExtractConfig {
+    /**
+     * 输入配置
+     * -- 每个源文件 对应一个配置
+     */
+    extractInput: Record<string, ExtractInputConfig>;
+    /** 输出配置 */
+    extractOutput: CompileTemplateConfig;
+}
+/** 生成选项 */
+export type GenerateOptions = ReadConfigFileOptions;

package/es/index-b588f95e.js

@@ -1,43 +0,0 @@
-#!/usr/bin/env node
-import { createMainCommand as s, createSubcommand as i } from "@done-coding/cli-utils";
-const r = async (n) => {
-  console.log(n);
-}, d = {
-  version: "0.0.4-alpha.0",
-  name: "@done-coding/cli-extract",
-  description: "信息提取命令行工具",
-  cliConfig: {
-    namespaceDir: ".done-coding",
-    moduleName: "extract"
-  }
-}, {
-  version: m,
-  description: l,
-  cliConfig: { moduleName: e }
-} = d, p = () => ({
-  xx: {
-    alias: "x",
-    describe: "模版测试",
-    type: "string",
-    demandOption: !0
-  }
-}), o = {
-  describe: l,
-  version: m,
-  options: p(),
-  handler: r
-}, t = (n = !1) => {
-  const c = n ? e : void 0, a = `$0${n ? ` ${e}` : ""} [options]`;
-  return { command: c, usage: a };
-}, g = async () => s({
-  ...o,
-  ...t()
-}), f = () => i({
-  ...o,
-  ...t(!0)
-});
-export {
-  f as a,
-  g as c,
-  r as h
-};