dc-inject 0.5.8-alpha.0

package/README.md

@@ -0,0 +1,7 @@
+# @done-coding/cli-inject
+
+done-coding信息(JSON)注入命令行工具
+
+## 使用
+
+npm install @done-coding/cli-inject

package/es/cli.mjs

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

package/es/helpers.mjs

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+import { I as e } from "./types-a1ee6691.js";
+const o = {
+  sourceFilePath: "./package.json",
+  keyConfigMap: {
+    name: {
+      type: e.READ
+    },
+    version: {
+      type: e.READ
+    },
+    description: {
+      type: e.READ
+    },
+    "cliConfig.namespaceDir": {
+      type: e.FIXED,
+      value: ".done-coding"
+    },
+    "cliConfig.moduleName": {
+      type: e.REG,
+      sourceKey: "name",
+      pattern: /@done-coding\/cli-([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)/.source,
+      replaceValue: "$1"
+    }
+  },
+  injectFilePath: "./src/injectInfo.json"
+};
+export {
+  o as doneCodingCliConfig
+};

package/es/index-124e6e6f.js

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

package/es/index.mjs

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+import { a as r, g as s, h as t, k as i } from "./index-124e6e6f.js";
+import { I as u, S as c } from "./types-a1ee6691.js";
+import "@done-coding/cli-utils";
+import "node:path";
+import "node:fs";
+export {
+  u as InjectTypeEnum,
+  c as SubcommandEnum,
+  r as crateAsSubcommand,
+  s as generateFile,
+  t as handler,
+  i as keyConfigResolve
+};

package/es/types-a1ee6691.js

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

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "dc-inject",
+  "version": "0.5.8-alpha.0",
+  "description": "信息(JSON)注入命令行工具",
+  "private": false,
+  "module": "es/index.mjs",
+  "type": "module",
+  "types": "types/index.d.ts",
+  "bin": "es/cli.mjs",
+  "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"
+  ],
+  "scripts": {},
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/justsosu/done-coding-cli.git",
+    "directory": "packages/inject"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "author": "JustSoSu",
+  "license": "MIT",
+  "sideEffects": false,
+  "devDependencies": {
+    "@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-utils": "^0.6.0-alpha.0"
+  },
+  "gitHead": "5879161383e32e7bed351d71d3ef607d81dc021a"
+}

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,6 @@
+/** 考虑本包会使用当前文件源码 避免不识别@ 此处用相对路径 */
+/** 考虑本包会使用当前文件源码 避免不识别@ 此处用相对路径 */
+/** 考虑本包会使用当前文件源码 避免不识别@ 此处用相对路径 */
+import type { InjectConfig } from "../utils";
+/** done-coding-cli 注入配置 */
+export declare const doneCodingCliConfig: InjectConfig;

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 { crateAsSubcommand } from "./main";
+export { generateFile, keyConfigResolve } from './utils';
+export * from './utils/types';

package/types/injectInfo.json.d.ts

@@ -0,0 +1,11 @@
+declare const _default: {
+  "name": "@done-coding/cli-inject",
+  "version": "0.5.8-alpha.0",
+  "description": "信息(JSON)注入命令行工具",
+  "cliConfig": {
+    "namespaceDir": ".done-coding",
+    "moduleName": "inject"
+  }
+};
+
+export default _default;

package/types/json/default.d.ts

@@ -0,0 +1,6 @@
+/** 考虑本包会使用当前文件源码 避免不识别@ 此处用相对路径 */
+/** 考虑本包会使用当前文件源码 避免不识别@ 此处用相对路径 */
+/** 考虑本包会使用当前文件源码 避免不识别@ 此处用相对路径 */
+import type { InjectConfig } from "../utils";
+declare const config: InjectConfig;
+export default config;

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,15 @@
+/** 考虑本包会使用当前文件源码 避免不识别@ 此处用相对路径 */
+/** 考虑本包会使用当前文件源码 避免不识别@ 此处用相对路径 */
+/** 考虑本包会使用当前文件源码 避免不识别@ 此处用相对路径 */
+import { type CliHandlerArgv, type CliInfo } from "@done-coding/cli-utils";
+import type { InjectConfig, GenerateOptions } from "./types";
+/** 获取生成命令选项 */
+export declare const getGenerateOptions: () => CliInfo["options"];
+/** 生成注入信息文件 */
+export declare const generateFile: ({ rootDir, config, keyConfigMap: extractKeyConfigMap, }?: {
+    rootDir?: string | undefined;
+    config?: InjectConfig | undefined;
+    keyConfigMap?: Record<string, import("./types").InjectKeyConfig> | undefined;
+}) => Promise<{} | undefined>;
+/** 提取文件命令处理器 */
+export declare const generateHandler: (argv: CliHandlerArgv<GenerateOptions>) => Promise<undefined>;

package/types/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./types";
+export * from "./resolve";
+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,7 @@
+import type { InjectKeyConfig } from "./types";
+/** key配置解析-获取最终值 */
+export declare const keyConfigResolve: ({ sourceJson, targetKey, keyConfig: keyConfigInit, }: {
+    sourceJson: Record<string, any>;
+    targetKey: string;
+    keyConfig: InjectKeyConfig;
+}) => any;

package/types/utils/types.d.ts

@@ -0,0 +1,87 @@
+import type { InitConfigFileOptions, ReadConfigFileOptions } from "@done-coding/cli-utils";
+/** 子命令枚举 */
+export declare enum SubcommandEnum {
+    /** 初始化提取配置文件 */
+    INIT = "init",
+    /** 生成文件 */
+    GENERATE = "generate"
+}
+/** 配置类型枚举 */
+export declare enum InjectTypeEnum {
+    /**
+     * 正则表达式 类型
+     */
+    REG = "reg",
+    /**
+     * 固定值 类型
+     */
+    FIXED = "fixed",
+    /**
+     * 读取 类型
+     */
+    READ = "read"
+}
+/** 初始化选项 */
+export type InitOptions = InitConfigFileOptions;
+/** 注入配置基础 */
+export interface InjectKeyConfigBase<T extends InjectTypeEnum> {
+    /**
+     * 提取类型
+     */
+    type: T;
+}
+/** 注入配置-正则类型 */
+export interface InjectKeyConfigReg extends InjectKeyConfigBase<InjectTypeEnum.REG> {
+    /**
+     * 正则表达式字符串
+     * ----
+     * 不带flags
+     */
+    pattern: string;
+    /** 正则匹配的 flags */
+    flags?: string;
+    /**
+     * 替换值
+     * ---
+     * replace 第二个参数
+     */
+    replaceValue: string;
+    /** 源key */
+    sourceKey: string;
+}
+/** 注入配置-固定值类型  */
+export interface InjectKeyConfigFixed extends InjectKeyConfigBase<InjectTypeEnum.FIXED> {
+    /** 值 */
+    value: string;
+}
+/** 注入配置-读取类型 */
+export interface InjectKeyConfigRead extends InjectKeyConfigBase<InjectTypeEnum.READ> {
+    /** 源key */
+    sourceKey?: string;
+}
+/**
+ * 注入配置
+ * ---
+ * 为 string 时 解析为 InjectKeyConfigFixed, 其中InjectKeyConfigFixed.value = string
+ */
+export type InjectKeyConfig = InjectKeyConfigReg | (InjectKeyConfigFixed | string) | InjectKeyConfigRead;
+/** @deprecated */
+export interface Options {
+    /** json文件相对路径 */
+    sourceJsonFilePath: string;
+    /** 注入的key路径 */
+    injectKeyPath: string[];
+    /** 注入信息文件路径 */
+    injectInfoFilePath: string;
+}
+/** 注入配置 */
+export interface InjectConfig {
+    /** json文件相对路径 */
+    sourceFilePath: string;
+    /** 注入的key路径 */
+    keyConfigMap: Record<string, InjectKeyConfig>;
+    /** 注入信息文件路径 */
+    injectFilePath: string;
+}
+/** 生成选项 */
+export type GenerateOptions = ReadConfigFileOptions;