done-coding-extract 0.1.8

package/README.md

@@ -0,0 +1,11 @@
+# @done-coding/cli-extract
+
+```
+信息提取命令行工具
+```
+
+## 使用
+
+``` bash
+npm install @done-coding/cli-extract
+```

package/es/cli.mjs

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+import { c as m } from "./index-2f3f403a.js";
+import "@done-coding/cli-utils";
+import "./types-a1ee6691-9629699d.js";
+import "node:path";
+import "node:fs";
+import "@done-coding/cli-template";
+m();

package/es/helpers.mjs

@@ -0,0 +1,127 @@
+#!/usr/bin/env node
+import { E as e, a as n } from "./types-a1ee6691-9629699d.js";
+import "@done-coding/cli-utils";
+import "node:path";
+import "node:fs";
+import { OutputModeEnum as t } from "@done-coding/cli-template";
+const i = {
+  name: "${name}",
+  version: "${version}",
+  description: "${description}",
+  cliConfig: {
+    namespaceDir: "${cliConfig.namespaceDir}",
+    moduleName: "${cliConfig.moduleName}"
+  }
+}, u = {
+  extractInput: {
+    "./package.json": {
+      name: {
+        type: e.JSON_INJECT,
+        inject: {
+          type: n.READ
+        }
+      },
+      description: {
+        type: e.JSON_INJECT,
+        inject: {
+          type: n.READ
+        }
+      },
+      version: {
+        type: e.JSON_INJECT,
+        inject: {
+          type: n.READ
+        }
+      },
+      "cliConfig.namespaceDir": {
+        type: e.JSON_INJECT,
+        inject: {
+          type: n.FIXED,
+          value: ".done-coding"
+        }
+      },
+      "cliConfig.moduleName": {
+        type: e.JSON_INJECT,
+        inject: {
+          sourceKey: "name",
+          type: n.REG,
+          pattern: /@done-coding\/cli-([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)/.source,
+          replaceValue: "$1"
+        }
+      }
+    }
+  },
+  extractOutput: {
+    list: [
+      {
+        mode: t.OVERWRITE,
+        inputData: JSON.stringify(i, null, 2),
+        output: "./src/extractInfo.json"
+      }
+    ]
+  }
+}, o = {
+  npm: {
+    aliasInfo: [
+      {
+        packageJson: {
+          name: "${organizationAbbr}-${moduleName}",
+          bin: "${binEntry}",
+          scripts: {}
+        }
+      }
+    ]
+  }
+}, l = {
+  extractInput: {
+    "./package.json": {
+      name: {
+        type: e.JSON_INJECT,
+        inject: {
+          type: n.READ
+        }
+      },
+      bin: {
+        type: e.JSON_INJECT,
+        inject: {
+          type: n.READ
+        }
+      },
+      organization: {
+        type: e.FIXED,
+        value: "done-coding"
+      },
+      /** 组织名缩写 */
+      organizationAbbr: {
+        type: e.FIXED,
+        value: "dc"
+      },
+      binEntry: {
+        type: e.FIXED,
+        value: "es/cli.mjs"
+      },
+      moduleName: {
+        type: e.JSON_INJECT,
+        inject: {
+          sourceKey: "name",
+          type: n.REG,
+          pattern: /@done-coding\/cli-([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)/.source,
+          replaceValue: "$1"
+        }
+      }
+    }
+  },
+  extractOutput: {
+    list: [
+      {
+        mode: t.OVERWRITE,
+        inputData: JSON.stringify(o, null, 2),
+        output: "./.done-coding/publish.json"
+      }
+    ]
+  }
+};
+export {
+  l as doneCodingPublishAliasInfo,
+  u as doneCodingSeriesCliInjectInfo
+};

package/es/index-2f3f403a.js

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

package/es/index.mjs

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+import { a as n, g as p, h as s } from "./index-2f3f403a.js";
+import { E as u, S as c } from "./types-a1ee6691-9629699d.js";
+import "@done-coding/cli-utils";
+import "node:path";
+import "node:fs";
+import "@done-coding/cli-template";
+export {
+  u as ExtractTypeEnum,
+  c as SubcommandEnum,
+  n as crateAsSubcommand,
+  p as generateFile,
+  s as handler
+};

package/es/types-a1ee6691-9629699d.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+var i = /* @__PURE__ */ ((e) => (e.INIT = "init", e.GENERATE = "generate", e))(i || {}), E = /* @__PURE__ */ ((e) => (e.REG = "reg", e.JSON_INJECT = "json-inject", e.FIXED = "fixed", e))(E || {}), n = /* @__PURE__ */ ((e) => (e.INIT = "init", e.GENERATE = "generate", e))(n || {}), r = /* @__PURE__ */ ((e) => (e.REG = "reg", e.FIXED = "fixed", e.READ = "read", e))(r || {});
+export {
+  E,
+  i as S,
+  r as a,
+  n as e
+};

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "done-coding-extract",
+  "version": "0.1.8",
+  "description": "信息提取命令行工具",
+  "private": false,
+  "module": "es/index.mjs",
+  "type": "module",
+  "types": "types/index.d.ts",
+  "bin": "es/cli.mjs",
+  "exports": {
+    ".": {
+      "import": "./es/index.mjs",
+      "types": "./types/index.d.ts"
+    },
+    "./helpers": {
+      "import": "./es/helpers.mjs",
+      "types": "./types/helpers.d.ts"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "helpers": [
+        "./types/helpers.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "es",
+    "lib",
+    "types"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/justsosu/done-coding-cli.git",
+    "directory": "packages/extract"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "author": "JustSoSu",
+  "license": "MIT",
+  "sideEffects": false,
+  "devDependencies": {
+    "@done-coding/cli-inject": "^0.5.8",
+    "@types/node": "^18.0.0",
+    "@types/yargs": "^17.0.28",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.2.2",
+    "vite": "^4.4.11",
+    "vite-plugin-dts": "^3.6.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@done-coding/cli-template": "0.7.8",
+    "@done-coding/cli-utils": "^0.7.0"
+  },
+  "gitHead": "b4fb4f2380a14f72597a1dbfd1bbce22287ef02f",
+  "scripts": {}
+}

package/types/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/types/handler.d.ts

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

package/types/helpers-assets/done-coding.d.ts

@@ -0,0 +1,5 @@
+import { type ExtractConfig } from "../utils";
+/** done-coding 系列cli 注入信息 */
+export declare const doneCodingSeriesCliInjectInfo: ExtractConfig;
+/** done-coding 系列cli 别名发布信息 */
+export declare const doneCodingPublishAliasInfo: ExtractConfig;

package/types/helpers.d.ts

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

package/types/index.d.ts

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

package/types/injectInfo.json.d.ts

@@ -0,0 +1,11 @@
+declare const _default: {
+  "name": "@done-coding/cli-extract",
+  "version": "0.1.8",
+  "description": "信息提取命令行工具",
+  "cliConfig": {
+    "namespaceDir": ".done-coding",
+    "moduleName": "extract"
+  }
+};
+
+export default _default;

package/types/json/default.d.ts

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

package/types/main.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="yargs" />
+/** 作为主命令创建 */
+export declare const createCommand: () => Promise<void | {
+    [x: string]: unknown;
+    _: (string | number)[];
+    $0: string;
+}>;
+/** 作为子命令创建 */
+export declare const crateAsSubcommand: () => import("yargs").CommandModule<{}, {}>;

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

@@ -0,0 +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

@@ -0,0 +1,64 @@
+import type { InitConfigFileOptions, ReadConfigFileOptions } from "@done-coding/cli-utils";
+import type { CompileTemplateConfig } from "@done-coding/cli-template";
+import type { InjectKeyConfig, InjectKeyConfigFixed, 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",
+    /** 固定值 类型 */
+    FIXED = "fixed"
+}
+/** 初始化选项 */
+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 ExtractInputKeyConfigFixed = ExtractInputKeyConfigBase<ExtractTypeEnum.FIXED> & Omit<InjectKeyConfigFixed, "type">;
+/** 提取配置 */
+export type ExtractInputKeyConfig = ExtractInputKeyConfigReg | ExtractInputKeyConfigJsonInject | ExtractInputKeyConfigFixed;
+/** 提取输入配置 */
+export interface ExtractInputConfig {
+    [key: string]: ExtractInputKeyConfig;
+}
+export interface ExtractConfig {
+    /**
+     * 输入配置
+     * -- 每个源文件 对应一个配置
+     */
+    extractInput: Record<string, ExtractInputConfig>;
+    /** 输出配置 */
+    extractOutput: CompileTemplateConfig;
+}
+/** 生成选项 */
+export type GenerateOptions = ReadConfigFileOptions;