done-coding-template 0.7.8-alpha.1

package/README.md

@@ -0,0 +1,7 @@
+# @done-coding/cli-template
+
+预编译命令行工具
+
+## 使用
+
+npm install @done-coding/cli-template

package/es/cli.mjs

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+import { d as m } from "./main-b3266c2d.js";
+import "@done-coding/cli-utils";
+import "node:path";
+import "node:fs";
+import "lodash.template";
+import "lodash.assign";
+m();

package/es/index.mjs

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+import { M as r } from "./main-b3266c2d.js";
+import { O as E, S as h, T as b, b as T, c as A, a as H, h as O, i as S } from "./main-b3266c2d.js";
+import t from "node:path";
+import { existsSync as n } from "node:fs";
+import "@done-coding/cli-utils";
+import "lodash.template";
+import "lodash.assign";
+const u = ({
+  rootDir: e,
+  configPath: o = r
+}) => {
+  const a = t.resolve(e, o);
+  if (n(a))
+    return a;
+};
+export {
+  r as MODULE_DEFAULT_CONFIG_RELATIVE_PATH,
+  E as OutputModeEnum,
+  h as SubcommandEnum,
+  b as TemplateBindKeyEnum,
+  T as batchCompileHandler,
+  A as compileHandler,
+  H as crateAsSubcommand,
+  u as getConfigPath,
+  O as handler,
+  S as initHandler
+};

package/es/main-b3266c2d.js

@@ -0,0 +1,489 @@
+#!/usr/bin/env node
+import { getConfigFileCommonOptions as N, getUseDefaultConfig as V, initHandlerCommon as W, log as a, xPrompts as R, readConfigFile as G, _curry as T, createSubcommand as A, createMainCommand as Y } from "@done-coding/cli-utils";
+import k from "node:path";
+import f from "node:fs";
+import O from "lodash.template";
+import B from "lodash.assign";
+var h = /* @__PURE__ */ ((e) => (e.INIT = "init", e.COMPILE = "compile", e))(h || {}), J = /* @__PURE__ */ ((e) => (e.REPOSITORY_URL = "REPOSITORY_URL", e))(J || {}), b = /* @__PURE__ */ ((e) => (e.OVERWRITE = "overwrite", e.APPEND = "append", e.REPLACE = "replace", e.RETURN = "return", e))(b || {});
+const _ = {
+  name: "@done-coding/cli-template",
+  version: "0.7.8-alpha.1",
+  description: "预编译命令行工具",
+  cliConfig: {
+    namespaceDir: ".done-coding",
+    moduleName: "template"
+  }
+}, {
+  cliConfig: { namespaceDir: K, moduleName: q }
+} = _, z = `./${K}/${q}`, I = `${z}.json`, v = {
+  rollback: !1,
+  dealMarkdown: !1,
+  mode: b.OVERWRITE,
+  batch: !1,
+  rollbackDelNullFile: !1
+}, S = (e) => {
+  const {
+    rollback: t,
+    dealMarkdown: s,
+    mode: c,
+    batch: l,
+    rootDir: o,
+    configPath: i,
+    rollbackDelNullFile: r,
+    ...u
+  } = e, { rootDir: g, configPath: D } = N({
+    configPathDefault: I
+  });
+  return {
+    rollback: t ?? v.rollback,
+    rollbackDelNullFile: r ?? v.rollbackDelNullFile,
+    dealMarkdown: s ?? v.dealMarkdown,
+    mode: c ?? v.mode,
+    batch: l ?? v.batch,
+    rootDir: o ?? g.default,
+    configPath: i ?? D.default,
+    ...u
+  };
+}, Z = () => ({
+  env: {
+    alias: "e",
+    describe: "环境数据文件JSON文件相对路径(优先级高于envData)",
+    type: "string"
+  },
+  envData: {
+    alias: "E",
+    describe: "环境变量数据(JSON字符串)",
+    type: "string"
+  },
+  input: {
+    alias: "i",
+    describe: "模板文件相对路径(优先级高于inputTemplate)",
+    type: "string"
+  },
+  inputData: {
+    alias: "I",
+    describe: "模板数据",
+    type: "string"
+  },
+  mode: {
+    alias: "m",
+    describe: "输出模式",
+    type: "string",
+    choices: [
+      b.OVERWRITE,
+      b.APPEND,
+      b.REPLACE,
+      b.RETURN
+    ],
+    default: v.mode
+  },
+  output: {
+    alias: "o",
+    describe: "输出文件路径",
+    type: "string"
+  },
+  rollback: {
+    alias: "r",
+    describe: "是否回滚",
+    type: "boolean",
+    default: v.rollback
+  },
+  dealMarkdown: {
+    alias: "d",
+    describe: "(检测是markdown)是否处理(单个)代码块包裹",
+    type: "boolean",
+    default: v.dealMarkdown
+  },
+  batch: {
+    alias: "b",
+    describe: "是否批量处理",
+    type: "boolean",
+    default: v.batch
+  },
+  ...N({
+    configPathDefault: I
+  })
+}), Q = {
+  globalEnvData: {},
+  collectEnvDataForm: [
+    {
+      key: "name",
+      label: "项目名"
+    },
+    {
+      key: "chineseName",
+      label: "项目中文名"
+    },
+    {
+      key: "description",
+      label: "描述",
+      initial: "这是一个描述"
+    },
+    {
+      key: "repositoryUrl",
+      label: "仓库地址",
+      initial: "",
+      bindKey: "REPOSITORY_URL"
+    }
+  ],
+  list: [
+    {
+      input: "./package.json",
+      output: "./package.json",
+      mode: "replace"
+    },
+    {
+      input: "./README.md",
+      output: "./README.md",
+      mode: "replace"
+    }
+  ]
+}, X = () => N({
+  configPathDefault: I
+}), ee = async (e) => {
+  let t = {};
+  if (e)
+    t = Q;
+  else {
+    const { globalEnvCount: s, collectEnvCount: c, compileFileCount: l } = await R([
+      {
+        name: "globalEnvCount",
+        type: "number",
+        message: "全局固定变量数量",
+        initial: 1,
+        format: (o) => Number(o) || 0,
+        validate: (o) => o >= 0
+      },
+      {
+        name: "collectEnvCount",
+        type: "number",
+        message: "采集变量数量",
+        initial: 1,
+        format: (o) => Number(o) || 0,
+        validate: (o) => o >= 0
+      },
+      {
+        name: "compileFileCount",
+        type: "number",
+        message: "预编译文件数量",
+        initial: 1,
+        format: (o) => Number(o) || 0,
+        validate: (o) => o >= 0
+      }
+    ]);
+    s && (t.globalEnvData = Array.from({
+      length: s
+    }).reduce((o, i, r) => (o[`GLOBAL_${r}`] = "", o), {})), c && (t.collectEnvDataForm = Array.from({
+      length: c
+    }).map((o, i) => ({
+      key: `COLLECT_KEY_${i}`,
+      label: `COLLECT_LABEL_${i}`,
+      initial: void 0
+    }))), l && (t.list = Array.from({
+      length: l
+    }).map((o, i) => ({
+      input: `(相对于命令运行目录)需要编译的模板文件路径${i}`,
+      output: `(相对于命令运行目录)编译后输出的文件路径${i}`,
+      mode: b.REPLACE
+    })));
+  }
+  return t;
+}, te = async (e) => {
+  const t = await V(), s = await ee(t);
+  await W(s, e, {
+    edit: !0,
+    onFileGenerated(c) {
+      t || a.success(`配置文件已生成：${c}
+        请具体需要替换
+        globalEnvData中的 GLOBAL_\${index}及其对应值
+        collectEnvDataForm各项中 COLLECT_KEY_\${index} COLLECT_LABEL_\${index}
+        list各项中的 input值 output值
+    `);
+    }
+  });
+}, x = ({
+  rootDir: e,
+  filePath: t,
+  dataInit: s,
+  limitJson: c,
+  filePathKey: l,
+  dataInitKey: o,
+  dealMarkdown: i = !1
+}) => {
+  if (t) {
+    if (c && !t.endsWith(".json"))
+      return a.error(`${l}必须是json文件，请检查文件后缀名`), process.exit(1);
+    const r = f.readFileSync(
+      k.resolve(e, t),
+      "utf-8"
+    );
+    let u = r;
+    return i && t.endsWith(".md") && (u = r.replace(
+      /^\s*```[a-zA-Z0-9]+\s*[\r\n]+([\s\S]+?)```\s*$/,
+      "$1"
+    )), c ? JSON.parse(u) : u;
+  } else
+    return s ? (a.info(`${l} 为空，将使用${o}作为数据`), c ? JSON.parse(s) : s) : (a.error(`${l}与${o}不能同时为空`), process.exit(1));
+}, P = (e, t) => {
+  if (!t)
+    return a.error(`${e}模式下output不能为空`), process.exit(1);
+}, w = (e, t) => {
+  if (t && e === t)
+    return a.error("output与input不能相同"), process.exit(1);
+}, ne = (e, t) => {
+  if (!t)
+    return a.error(`${e}模式下input不能为空`), process.exit(1);
+}, M = async (e, {
+  rootDir: t,
+  rollbackDelFileAgree: s = !1
+}) => {
+  const {
+    env: c,
+    input: l,
+    inputData: o,
+    output: i,
+    mode: r,
+    rollback: u,
+    rollbackDelNullFile: g,
+    dealMarkdown: D,
+    envData: E
+  } = e;
+  if (u)
+    switch (r) {
+      case b.REPLACE:
+      case b.RETURN: {
+        a.error(`${r}模式不支持回滚`);
+        return;
+      }
+    }
+  a.stage(`开始处理模板
+mode: ${r}
+rollback: ${u}
+`);
+  const m = x({
+    rootDir: t,
+    filePath: l,
+    dataInit: o,
+    limitJson: !1,
+    filePathKey: "input",
+    dataInitKey: "inputData",
+    dealMarkdown: D
+  }), d = O(m), C = typeof E == "function" ? E() : E, p = d(C);
+  switch (r) {
+    case b.OVERWRITE: {
+      P(r, i), w(i, l);
+      const n = k.resolve(t, i);
+      if (f.mkdirSync(k.dirname(n), { recursive: !0 }), f.existsSync(n)) {
+        if (u)
+          if (s || (await R({
+            type: "confirm",
+            name: "remove",
+            message: `${r}模式下回滚将删除${n}，是否继续？`
+          })).remove) {
+            f.rmSync(n, { force: !0 }), a.success(`${r}模式下${n}已删除`);
+            return;
+          } else {
+            a.warn(`${r}模式下${n}回滚取消`);
+            return;
+          }
+        a.info(`output:${n} 已存在，将覆盖`);
+      } else {
+        if (u) {
+          a.warn(`${r}模式下${n}不存在，无需回滚`);
+          return;
+        }
+        a.stage(`output:${n} 不存在，将创建`);
+      }
+      f.writeFileSync(n, p, "utf-8"), a.success(`模板处理完成，输出到 ${n}`);
+      break;
+    }
+    case b.APPEND: {
+      P(r, i), w(i, l);
+      const n = k.resolve(t, i);
+      if (f.mkdirSync(k.dirname(n), { recursive: !0 }), f.existsSync(n)) {
+        const $ = f.readFileSync(n, "utf-8");
+        if (u) {
+          const L = $.replace(p, "");
+          L || !g ? f.writeFileSync(n, L, "utf-8") : (a.stage(`${r}模式下 文件为空 删除`), f.unlinkSync(n)), a.success(`${r}模式下${n}回滚完成`);
+          return;
+        }
+        const y = $ + p;
+        f.writeFileSync(n, y, "utf-8"), a.success(`模板处理完成，追加到 ${n}`);
+      } else {
+        if (u) {
+          a.warn(`${r}模式下${n}不存在，无需回滚`);
+          return;
+        }
+        a.stage(`output:${n} 不存在，将创建`), f.writeFileSync(n, p, "utf-8"), a.success(`模板处理完成，输出到 ${n}`);
+      }
+      break;
+    }
+    case b.REPLACE: {
+      if (i && a.warn(`output ${i} 将被忽略`), ne(r, l), c && c === l)
+        return a.error("env 与 input 不能相同"), process.exit(1);
+      const n = k.resolve(t, l);
+      let $ = n;
+      const y = O(n)(C);
+      y !== n && (a.success(`检测输入文件名也需要替换
+            ${n} => ${y}`), f.rmSync(n), $ = y), f.mkdirSync(k.dirname($), { recursive: !0 }), f.writeFileSync($, p, "utf-8"), a.success(`模板处理完成，输出到 ${$}`);
+      break;
+    }
+    case b.RETURN:
+      return a.success("模板处理完成，返回结果(函数调用才会拿到返回值)"), p;
+    default:
+      return a.error(`mode ${r} 不支持`), process.exit(1);
+  }
+  return p;
+}, ae = async ({
+  rootDir: e,
+  configPath: t = I,
+  itemDefaultRollback: s = !1,
+  extraEnvData: c = {}
+}, l) => {
+  let o;
+  if (l ? o = l : o = await G({
+    rootDir: e,
+    configPath: t
+  }), !o)
+    return a.error("读取配置文件失败"), process.exit(1);
+  const {
+    list: i = [],
+    globalEnvData: r = {},
+    collectEnvDataForm: u = []
+  } = o, g = {};
+  for (const m of u) {
+    let d, C, p;
+    typeof m == "string" ? (d = m, C = m, p = void 0) : (d = m.key, C = m.label, p = m.initial), g[d] = (await R({
+      type: "text",
+      name: d,
+      message: `请输入${C}`,
+      initial: p,
+      format: (n) => n.trim(),
+      validate: (n) => n.length > 0 || `${C}不能为空`
+    }))[d];
+  }
+  const D = i.map((m) => {
+    const { rollback: d = s } = m, {
+      envData: C,
+      env: p,
+      input: n,
+      output: $,
+      ...y
+    } = S(m);
+    return p && a.warn(`批量处理中 env:${p} 将被忽略, 只读envData`), {
+      ...y,
+      env: p,
+      input: n,
+      output: $,
+      envData: B(
+        {},
+        c,
+        r,
+        g,
+        C
+      ),
+      rollback: d
+    };
+  }), E = [];
+  for (const m of D) {
+    const d = await M(m, {
+      rollbackDelFileAgree: !0,
+      rootDir: e
+    });
+    E.push(d);
+  }
+  return E;
+}, oe = async (e) => {
+  const {
+    envData: t,
+    env: s,
+    input: c,
+    inputData: l,
+    output: o,
+    mode: i,
+    rollback: r,
+    rollbackDelNullFile: u,
+    dealMarkdown: g,
+    batch: D,
+    rootDir: E,
+    configPath: m
+  } = S(e);
+  if (D)
+    return a.stage("开始批量处理"), ae({
+      // 回滚默认值 基于全局
+      itemDefaultRollback: r,
+      rootDir: E,
+      configPath: m
+    });
+  a.stage("开始单个处理");
+  const d = x({
+    rootDir: E,
+    filePath: s,
+    dataInit: t,
+    limitJson: !0,
+    filePathKey: "env",
+    dataInitKey: "envData",
+    dealMarkdown: g
+  });
+  return M(
+    {
+      input: c,
+      inputData: l,
+      output: o,
+      mode: i,
+      rollback: r,
+      rollbackDelNullFile: u,
+      dealMarkdown: g,
+      envData: d
+    },
+    {
+      rootDir: E
+    }
+  );
+}, U = async (e, t) => e === h.INIT ? te(t) : e === h.COMPILE ? oe(t) : (a.error(`无效的命令: ${e}`), process.exit(1)), {
+  version: re,
+  description: ie,
+  cliConfig: { moduleName: F }
+} = _, le = {
+  command: h.INIT,
+  describe: "初始化模板配置文件",
+  options: X(),
+  handler: T(U)(
+    h.INIT
+  )
+}, se = {
+  command: h.COMPILE,
+  describe: "编译模板",
+  options: Z(),
+  handler: T(U)(
+    h.COMPILE
+  )
+}, j = {
+  describe: ie,
+  version: re,
+  subcommands: [le, se].map(
+    A
+  ),
+  demandCommandCount: 1
+}, H = (e = !1) => {
+  const t = e ? F : void 0, s = `$0${e ? ` ${F}` : ""} <command> [options]`;
+  return { command: t, usage: s };
+}, de = async () => Y({
+  ...j,
+  ...H()
+}), be = () => A({
+  ...j,
+  ...H(!0)
+});
+export {
+  I as M,
+  b as O,
+  h as S,
+  J as T,
+  be as a,
+  ae as b,
+  oe as c,
+  de as d,
+  U as h,
+  te as i
+};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "done-coding-template",
+  "version": "0.7.8-alpha.1",
+  "description": "预编译命令行工具",
+  "private": false,
+  "module": "es/index.mjs",
+  "type": "module",
+  "types": "types/index.d.ts",
+  "bin": "es/cli.mjs",
+  "exports": {
+    ".": {
+      "import": "./es/index.mjs"
+    }
+  },
+  "files": [
+    "es",
+    "lib",
+    "types"
+  ],
+  "scripts": {},
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/justsosu/done-coding-cli.git",
+    "directory": "packages/template"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "author": "JustSoSu",
+  "license": "MIT",
+  "sideEffects": false,
+  "devDependencies": {
+    "@done-coding/cli-inject": "^0.5.8-alpha.0",
+    "@types/lodash.assign": "^4.2.9",
+    "@types/lodash.template": "^4.5.3",
+    "@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",
+    "lodash.assign": "^4.2.0",
+    "lodash.template": "^4.5.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 { CompileOptions, InitOptions } from './utils';
+import { SubcommandEnum } from './utils';
+import type { CliHandlerArgv } from "@done-coding/cli-utils";
+/** 命令处理函数 */
+export declare const handler: (command: SubcommandEnum, argv: CliHandlerArgv<InitOptions | CompileOptions>) => Promise<string | void | (string | undefined)[]>;

package/types/index.d.ts

@@ -0,0 +1,5 @@
+export { handler } from './handler';
+export { initHandler, compileHandler, batchCompileHandler, MODULE_DEFAULT_CONFIG_RELATIVE_PATH, } from './utils';
+export { crateAsSubcommand } from "./main";
+export * from './utils/types';
+export * from './utils/config';

package/types/injectInfo.json.d.ts

@@ -0,0 +1,11 @@
+declare const _default: {
+  "name": "@done-coding/cli-template",
+  "version": "0.7.8-alpha.1",
+  "description": "预编译命令行工具",
+  "cliConfig": {
+    "namespaceDir": ".done-coding",
+    "moduleName": "template"
+  }
+};
+
+export default _default;

package/types/json/default.json.d.ts

@@ -0,0 +1,38 @@
+declare const _default: {
+  "globalEnvData": {},
+  "collectEnvDataForm": [
+    {
+      "key": "name",
+      "label": "项目名"
+    },
+    {
+      "key": "chineseName",
+      "label": "项目中文名"
+    },
+    {
+      "key": "description",
+      "label": "描述",
+      "initial": "这是一个描述"
+    },
+    {
+      "key": "repositoryUrl",
+      "label": "仓库地址",
+      "initial": "",
+      "bindKey": "REPOSITORY_URL"
+    }
+  ],
+  "list": [
+    {
+      "input": "./package.json",
+      "output": "./package.json",
+      "mode": "replace"
+    },
+    {
+      "input": "./README.md",
+      "output": "./README.md",
+      "mode": "replace"
+    }
+  ]
+};
+
+export default _default;

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/compile.d.ts

@@ -0,0 +1,16 @@
+import type { CompileTemplateConfig } from '.';
+import { type CompileOptions } from '.';
+import type { CliHandlerArgv } from "@done-coding/cli-utils";
+/** 批量编译模板 */
+export declare const batchCompileHandler: ({ rootDir, configPath, itemDefaultRollback, extraEnvData, }: {
+    /** 项目更目录 */
+    rootDir: string;
+    /** 配置文件路径 */
+    configPath?: string | undefined;
+    /** item默认回滚? */
+    itemDefaultRollback?: boolean | undefined;
+    /** 额外环境变量 */
+    extraEnvData?: object | undefined;
+}, paramsConfig?: CompileTemplateConfig) => Promise<(string | undefined)[]>;
+/** 编译模板 */
+export declare const compileHandler: (argv: CliHandlerArgv<CompileOptions>) => Promise<string | (string | undefined)[] | undefined>;

package/types/utils/config.d.ts

@@ -0,0 +1,3 @@
+import type { ReadConfigFileOptions } from "@done-coding/cli-utils";
+/** 获取配置文件路径 */
+export declare const getConfigPath: ({ rootDir, configPath, }: ReadConfigFileOptions) => string | undefined;

package/types/utils/dealOptions.d.ts

@@ -0,0 +1,21 @@
+import { type CliInfo } from "@done-coding/cli-utils";
+import { OutputModeEnum, type CompileOptions } from "./types";
+/** 编译默认选项 */
+export declare const defaultCompileOptions: Pick<CompileOptions, "rollback" | "dealMarkdown" | "mode" | "batch" | "rollbackDelNullFile">;
+/** 设置编译默认选项 */
+export declare const completeDefaultCompileOptions: <T extends Pick<CompileOptions, "mode" | "rollback" | "rollbackDelNullFile" | "dealMarkdown" | "batch">>(options: T) => {
+    env?: string | undefined;
+    envData?: string | undefined;
+    input?: string | undefined;
+    inputData?: string | undefined;
+    output?: string | undefined;
+    rollback: boolean | undefined;
+    rollbackDelNullFile: boolean | undefined;
+    dealMarkdown: boolean | undefined;
+    mode: OutputModeEnum;
+    batch: boolean | undefined;
+    rootDir: string;
+    configPath: string;
+};
+/** 获取编译选项 */
+export declare const getCompileOptions: () => CliInfo["options"];

package/types/utils/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./types";
+export * from "./dealOptions";
+export * from "./config";
+export * from "./init";
+export * from "./compile";
+export * from "./path";

package/types/utils/init.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="yargs" />
+import { type InitOptions } from '.';
+import { type CliHandlerArgv } from "@done-coding/cli-utils";
+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/types.d.ts

@@ -0,0 +1,82 @@
+import type { InitConfigFileOptions, ReadConfigFileOptions } from "@done-coding/cli-utils";
+/** 子命令枚举 */
+export declare enum SubcommandEnum {
+    /** 初始化模板 */
+    INIT = "init",
+    /** 编译模板 */
+    COMPILE = "compile"
+}
+export type InitOptions = InitConfigFileOptions;
+/** 绑定的关键变量枚举 */
+export declare enum TemplateBindKeyEnum {
+    /** 远程仓库地址 */
+    REPOSITORY_URL = "REPOSITORY_URL"
+}
+/** 输出模式 */
+export declare enum OutputModeEnum {
+    /** 覆盖模式 */
+    OVERWRITE = "overwrite",
+    /** 追加模式 */
+    APPEND = "append",
+    /** 替换模式 */
+    REPLACE = "replace",
+    /** 返回模式--函数调用方式可用 */
+    RETURN = "return"
+}
+export interface CompileOptions {
+    /** 项目根目录 */
+    rootDir: string;
+    /** 配置文件路径 */
+    configPath?: string;
+    /** 环境数据(json)文件(优先级高于 envData ) */
+    env?: string;
+    /** 环境变量数据(JSON字符串) */
+    envData?: string;
+    /** 模板文件相对路径(优先级高于 inputData ) */
+    input?: string;
+    /** 模板数据 */
+    inputData?: string;
+    /** 输出文件相对路径 */
+    output?: string;
+    /** 输出模式 @default OutputModeEnum.OVERWRITE */
+    mode: OutputModeEnum;
+    /** 是否回滚 @default false */
+    rollback?: boolean;
+    /**
+     * 回滚删除空文件
+     * ---
+     * 只限 OutputModeEnum.APPEND 模式下生效
+     */
+    rollbackDelNullFile?: boolean;
+    /** (检测是markdown)是否处理(单个)代码块包裹 */
+    dealMarkdown?: boolean;
+    /** 是否批量处理 */
+    batch?: boolean;
+}
+/**
+ * 编译模板配置选项
+ */
+export type CompileTemplateConfigListItem = Omit<CompileOptions, "envData" | keyof ReadConfigFileOptions> & {
+    /** 已经解析为对象的envData */
+    envData: Record<string, any>;
+};
+/** 采集环境变量配置 */
+export interface CollectFormItem {
+    /** 采集环境变量的key */
+    key: string;
+    /** 采集环境变量标签 */
+    label: string;
+    /** 采集环境变量初始值 */
+    initial?: string;
+    /** 绑定的关键变量 */
+    bindKey?: TemplateBindKeyEnum;
+}
+/** 编译模板配置 */
+export interface CompileTemplateConfig {
+    /** 全局环境变量 */
+    globalEnvData?: Record<string, any>;
+    /** 采集环境变量表单配置 */
+    collectEnvDataForm?: (CollectFormItem | string)[];
+    /** 配置列表 */
+    list?: Omit<CompileOptions, keyof ReadConfigFileOptions>[];
+}