@done-coding/cli-config 0.1.0-alpha.0

package/README.md

@@ -0,0 +1,11 @@
+# @done-coding/cli-config
+
+```
+工程化配置命令行工具
+```
+
+## 使用
+
+``` bash
+npm install @done-coding/cli-config
+```

package/es/cli.mjs

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

package/es/index-48970952.js

@@ -0,0 +1,404 @@
+#!/usr/bin/env node
+import { readConfigFile as B, log as r, getPackageJson as Q, getRelyPkgVersion as X, getConfigFileCommonOptions as Y, readCliConfig as Z, xPrompts as j, addPackageConfig as ee, addHuskyHooks as te, createSubcommand as _, createMainCommand as ne } from "@done-coding/cli-utils";
+import h, { existsSync as C } from "node:fs";
+import g from "node:path";
+import { execSync as k } from "node:child_process";
+var y = /* @__PURE__ */ ((e) => (e.CHECK = "check", e.ADD = "add", e))(y || {}), m = /* @__PURE__ */ ((e) => (e.ESLINT = "eslint", e.PRETTIER = "prettier", e.COMMITLINT = "commitlint", e.LSLINT = "ls-lint", e.MERGELINT = "merge-lint", e))(m || {});
+const N = {
+  name: "@done-coding/cli-config",
+  version: "0.1.0-alpha.0",
+  description: "工程化配置命令行工具",
+  cliConfig: {
+    namespaceDir: ".done-coding",
+    moduleName: "config"
+  }
+}, {
+  cliConfig: { namespaceDir: oe, moduleName: se }
+} = N, re = `./${oe}/${se}`, ie = `${re}.json`, I = Object.values(m).filter(
+  (e) => e.toUpperCase() !== e
+), ce = async (e) => await B(e, () => {
+  const { moduleList: t = [] } = e;
+  return r.info(
+    `配置文件不存在 读取命令行参数 moduleList: ${JSON.stringify(
+      t,
+      null,
+      2
+    )}`
+  ), {
+    moduleList: t
+  };
+}), F = {
+  [m.ESLINT]: "eslint",
+  [m.PRETTIER]: "prettier",
+  [m.COMMITLINT]: "@commitlint/cli",
+  [m.LSLINT]: "@ls-lint/ls-lint",
+  [m.MERGELINT]: "@done-coding/cli-git"
+}, n = "_$_", ae = {
+  [m.ESLINT]: [
+    `${n}.config.js`,
+    `${n}.config.mjs`,
+    `${n}.config.cjs`,
+    `.${n}rc`,
+    `.${n}rc.js`,
+    `.${n}rc.json`,
+    `.${n}rc.mjs`,
+    `.${n}rc.cjs`,
+    `.${n}rc.yaml`,
+    `.${n}rc.yml`
+  ],
+  [m.PRETTIER]: [
+    `${n}.config.js`,
+    `${n}.config.mjs`,
+    `${n}.config.cjs`,
+    `.${n}rc`,
+    `.${n}rc.js`,
+    `.${n}rc.json`,
+    `.${n}rc.json5`,
+    `.${n}rc.mjs`,
+    `.${n}rc.cjs`,
+    `.${n}rc.yaml`,
+    `.${n}rc.yml`,
+    `.${n}rc.toml`
+  ],
+  [m.COMMITLINT]: [
+    `${n}.config.js`,
+    `${n}.config.mjs`,
+    `${n}.config.cjs`,
+    `.${n}rc`,
+    `.${n}rc.js`,
+    `.${n}rc.json`,
+    `.${n}rc.mjs`,
+    `.${n}rc.cjs`,
+    `.${n}rc.yaml`,
+    `.${n}rc.yml`
+  ],
+  [m.LSLINT]: [`.${n}.yaml`, `.${n}.yml`],
+  [m.MERGELINT]: [".done-coding/git.json"]
+}, le = (e, t) => t.filter((o) => C(g.resolve(e, o))), H = (e) => e.filter((t) => {
+  const o = I.includes(t);
+  return o || r.warn(
+    `当前不支持${t}的配置检测, 支持的类型有${I.join(
+      ", "
+    )}`
+  ), o;
+}), me = ({
+  config: e,
+  rootDir: t
+}) => {
+  const { moduleList: o = [] } = e, s = H(o);
+  r.stage(`开始获取${s.join(", ")}配置信息...`);
+  const i = Q({ rootDir: t });
+  return s.reduce(
+    (a, l) => {
+      const f = X({
+        rootDir: t,
+        pkgJson: i,
+        pkgName: F[l],
+        isDevPkg: !0
+      });
+      if (!f)
+        return a;
+      const c = ae[l].map((u) => u.replace(n, l));
+      return c.length ? (a[l] = {
+        version: f,
+        configFileRelativePathList: le(
+          t,
+          c
+        )
+      }, a) : (r.warn(`安装了${l}, 但未找到${l}的配置文件 认为未使用`), a);
+    },
+    {}
+  );
+}, J = () => ({
+  ...Y({
+    configPathDefault: ie
+  }),
+  moduleList: {
+    type: "array",
+    alias: "m",
+    description: "需要检测的工程化配置模块",
+    choices: I,
+    default: I.filter(
+      (e) => e !== m.MERGELINT
+    )
+  }
+}), E = async (e) => {
+  const t = await ce(e), o = me({ config: t, rootDir: e.rootDir });
+  return r.success(`检测到工程化配置信息: 
+${JSON.stringify(o, null, 2)}`), {
+    config: t,
+    info: o
+  };
+}, de = {
+  command: y.CHECK,
+  describe: "检测工程化配置",
+  options: J(),
+  handler: E
+}, {
+  cliConfig: { moduleName: ue }
+} = N, fe = () => ({
+  ...J(),
+  commitGit: {
+    type: "boolean",
+    alias: "g",
+    description: "添加完成后是否提交到git",
+    default: !1
+  }
+}), ge = async ({
+  moduleName: e,
+  moduleConfigList: t
+}) => {
+  if (!Array.isArray(t) || t.length === 0) {
+    r.error(`未找到 ${e} 预设版本配置`);
+    return;
+  }
+  if (t.length === 1) {
+    const s = t[0];
+    return r.skip(
+      `${e} 跳过版本选择: 仅有一个预设版本配置, 默认选择第一个(${s.version})`
+    ), s;
+  }
+  const { version: o } = await j({
+    type: "select",
+    name: "version",
+    message: `请选择需要添加的${e}版本`,
+    choices: t.map((s) => {
+      const { version: i } = s;
+      return {
+        title: `${F[e]}@${i}`,
+        value: i
+      };
+    })
+  });
+  return t.find((s) => s.version === o);
+}, $e = async ({
+  moduleName: e,
+  moduleConfig: t
+}) => {
+  const { configFileInfoList: o } = t;
+  if (!Array.isArray(o) || o.length === 0) {
+    r.error(`未找到 ${e} 配置文件信息列表`);
+    return;
+  }
+  if (o.length === 1) {
+    const i = o[0];
+    return r.skip(
+      `${e} 跳过配置文件信息选择: 仅有一个配置文件信息, 默认选择第一个(${i.sourceFile})`
+    ), i;
+  }
+  const { info: s } = await j({
+    type: "select",
+    name: "info",
+    message: "请选择需要添加的配置文件",
+    choices: o.map((i) => {
+      const { sourceFile: a, description: l } = i;
+      return {
+        title: a,
+        value: i,
+        description: l
+      };
+    })
+  });
+  return o.find((i) => i.sourceFile === s.sourceFile);
+}, pe = ({ rootDir: e, list: t }) => {
+  r.stage(`开始安装依赖包: ${JSON.stringify(t, null, 2)}`);
+  const o = g.resolve(e, "pnpm-workspace.yaml"), s = C(o);
+  k(`pnpm add -D ${s ? "-w" : ""} ${t.join(" ")}`, {
+    cwd: e,
+    stdio: "inherit"
+  });
+}, ye = async ({
+  hooksConfig: e,
+  argv: t
+}) => Object.entries(e).forEach(async ([o, s]) => {
+  await te({
+    hookNames: [o],
+    rootDir: t.rootDir,
+    getCode: () => s
+  });
+}), Le = async ({
+  moduleName: e,
+  moduleConfigList: t,
+  argv: o
+}) => {
+  const s = await ge({
+    moduleName: e,
+    moduleConfigList: t
+  });
+  if (!s)
+    return;
+  const i = await $e({
+    moduleName: e,
+    moduleConfig: s
+  });
+  if (!i)
+    return;
+  const {
+    relyPackages: a = [],
+    version: l,
+    runScripts: f = []
+  } = s, {
+    relyPackages: c = [],
+    sourceFile: u,
+    targetFile: w
+  } = i, $ = [
+    `${F[e]}@${l}`,
+    ...a,
+    ...c
+  ];
+  return r.stage(`需要安装的依赖包: 
+${JSON.stringify($, null, 2)}`), await ee({
+    patchConfig: s.packageJson,
+    rootDir: o.rootDir
+  }), {
+    sourceFile: u,
+    targetFile: w,
+    version: l,
+    pkgList: $,
+    runScripts: f,
+    /** 方法内部已经使用husky了 但是所有依赖包在最后才统一安装 */
+    addHuskyConfigFn: () => {
+      var p;
+      return ye({
+        hooksConfig: ((p = s.husky) == null ? void 0 : p.hooks) || {},
+        argv: o
+      });
+    }
+  };
+}, he = ({
+  listConfig: e,
+  moduleDir: t,
+  moduleName: o
+}) => {
+  if (typeof e == "string") {
+    console.log(e);
+    const s = g.resolve(t, e);
+    if (!C(s))
+      throw new Error(
+        `${o} 预设列表文件 ${s} 不存在`
+      );
+    const i = h.readFileSync(s, "utf-8");
+    return JSON.parse(
+      i
+    );
+  } else {
+    if (!Array.isArray(e))
+      throw new Error(
+        `(${o})预置项必须是数组或者是相对于当前工程化配置模块目录的相对路径`
+      );
+    return e;
+  }
+}, b = async (e) => {
+  const { config: t, info: o } = await E(e), { moduleList: s = [] } = t, a = H(s).filter((c) => {
+    const u = o[c];
+    return u ? (r.skip(`
+检测到 ${c} 已配置, ${JSON.stringify(u, null, 2)},
+跳过添加 ${c}`), !1) : !0;
+  });
+  if (!a.length) {
+    r.success("所有配置项均已配置, 无需添加");
+    return;
+  }
+  await Z({
+    moduleName: ue,
+    onSuccess: async ({
+      config: c,
+      configTemporaryDir: u,
+      cliConfigDirRelativePath: w
+    }) => {
+      if (!(c != null && c.project))
+        throw new Error("项目工程化预设不存在");
+      r.success("预设配置拉取成功");
+      const { project: P } = c, { rootDir: $ } = e, p = [], T = [], S = [];
+      for (let d of a) {
+        const v = g.resolve(
+          u,
+          w,
+          d
+        ), D = he({
+          listConfig: P[d],
+          moduleDir: v,
+          moduleName: d
+        });
+        if (!D) {
+          r.error(`未找到 ${d} 预设配置`);
+          return;
+        }
+        r.stage(`开始添加 ${d} 配置`);
+        const M = await Le({
+          moduleName: d,
+          moduleConfigList: D,
+          argv: e
+        });
+        if (M) {
+          const {
+            sourceFile: U,
+            targetFile: K,
+            version: V,
+            pkgList: W,
+            addHuskyConfigFn: q,
+            runScripts: z
+          } = M, A = g.resolve(v, V, U), L = g.resolve($, K);
+          r.stage(`开始复制 ${A} -> ${L}`);
+          const O = g.dirname(L);
+          h.existsSync(O) || h.mkdirSync(O, { recursive: !0 }), h.copyFileSync(A, L), r.success(`添加 ${d} 配置成功, 路径: ${L}`), p.push(...W), T.push(q), S.push(...z);
+        }
+      }
+      await pe({
+        rootDir: $,
+        list: [...new Set(p)]
+      });
+      for (let d of S)
+        r.stage(`运行脚本: ${d}`), k(d, { cwd: $, stdio: "inherit" });
+      await Promise.all(T.map((d) => d()));
+    }
+  });
+  const { commitGit: l, rootDir: f } = e;
+  if (l) {
+    const { commitMsg: c } = await j({
+      type: "text",
+      name: "commitMsg",
+      message: "请输入提交信息",
+      initial: `chore: 添加 ${a.join(", ")} 工程化配置`
+    });
+    k("git add .", { cwd: f, stdio: "inherit" }), k(`git commit -m "${c}"`, {
+      cwd: f,
+      stdio: "inherit"
+    });
+  }
+}, ke = {
+  command: y.ADD,
+  describe: "添加工程化配置",
+  options: fe(),
+  handler: b
+}, Ee = async (e, t) => {
+  switch (e) {
+    case y.CHECK:
+      return E(t);
+    case y.ADD:
+      return b(t);
+    default:
+      throw new Error(`不支持的命令 ${e}`);
+  }
+}, { version: Ie, description: Ne } = N, G = {
+  describe: Ne,
+  version: Ie,
+  subcommands: [de, ke].map(_),
+  demandCommandCount: 1
+}, {
+  cliConfig: { moduleName: R }
+} = N, x = (e = !1) => {
+  const t = e ? R : void 0, o = `$0${e ? ` ${R}` : ""} <command> [options]`;
+  return { command: t, usage: o };
+}, Pe = async () => ne({
+  ...G,
+  ...x()
+}), Te = () => _({
+  ...G,
+  ...x(!0)
+});
+export {
+  Te as a,
+  Pe as c,
+  Ee as h
+};

package/es/index.mjs

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+import { a as i, h as n } from "./index-48970952.js";
+import "@done-coding/cli-utils";
+import "node:fs";
+import "node:path";
+import "node:child_process";
+export {
+  i as crateAsSubcommand,
+  n as handler
+};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@done-coding/cli-config",
+  "version": "0.1.0-alpha.0",
+  "description": "工程化配置命令行工具",
+  "private": false,
+  "module": "es/index.mjs",
+  "type": "module",
+  "types": "types/index.d.ts",
+  "bin": {
+    "dc-config": "es/cli.mjs"
+  },
+  "exports": {
+    ".": {
+      "import": "./es/index.mjs"
+    }
+  },
+  "files": [
+    "es",
+    "lib",
+    "types"
+  ],
+  "scripts": {
+    "clean": "rimraf es lib types",
+    "predev": "pnpm run clean",
+    "dev": "vite build --watch",
+    "prebuild": "pnpm run clean",
+    "build": "vite build",
+    "prepack": "pnpm build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/justsosu/done-coding-cli.git",
+    "directory": "packages/config"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "author": "JustSoSu",
+  "license": "MIT",
+  "sideEffects": false,
+  "devDependencies": {
+    "@done-coding/cli-inject": "^0.5.8-alpha.1",
+    "@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.7.0-alpha.0"
+  },
+  "gitHead": "ff1616738586a268b50f46dce762774fa5fa6d52"
+}

package/types/cli.d.ts

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

package/types/handlers/add.d.ts

@@ -0,0 +1,15 @@
+import { type AddConfigOptions, type ConfigModuleEnum, type ConfigProjectConfigItem } from '../types';
+import type { ArgumentsCamelCase } from "yargs";
+import type { SubCliInfo } from "@done-coding/cli-utils";
+import type yargs from "yargs";
+export declare const getOptions: () => {
+    [key: string]: yargs.Options;
+};
+/** 解析模块配置列表 */
+export declare const resolveModuleConfigList: ({ listConfig, moduleDir, moduleName, }: {
+    listConfig: ConfigProjectConfigItem[] | string;
+    moduleDir: string;
+    moduleName: ConfigModuleEnum;
+}) => ConfigProjectConfigItem[];
+export declare const handler: (argv: ArgumentsCamelCase<AddConfigOptions>) => Promise<void>;
+export declare const commandCliInfo: SubCliInfo;

package/types/handlers/check.d.ts

@@ -0,0 +1,12 @@
+import { type CheckConfigOptions, type ConfigConfig, type TypeConfigInfo } from '../types';
+import type { SubCliInfo } from "@done-coding/cli-utils";
+import type { ArgumentsCamelCase } from "yargs";
+import type yargs from "yargs";
+export declare const getOptions: () => {
+    [key: string]: yargs.Options;
+};
+export declare const handler: (argv: ArgumentsCamelCase<CheckConfigOptions>) => Promise<{
+    config: ConfigConfig;
+    info: TypeConfigInfo;
+}>;
+export declare const commandCliInfo: SubCliInfo;

package/types/handlers/index.d.ts

@@ -0,0 +1,10 @@
+import { handler as checkHandler, commandCliInfo as checkCommandCliInfo } from "./check";
+import { handler as addHandler, commandCliInfo as addCommandCliInfo } from "./add";
+import { SubcommandEnum } from '../types';
+import { type CliHandlerArgv, type CliInfo } from "@done-coding/cli-utils";
+export { checkHandler, checkCommandCliInfo, addHandler, addCommandCliInfo };
+export declare const handler: (command: SubcommandEnum, argv: CliHandlerArgv<any>) => Promise<void | {
+    config: import('../types').ConfigConfig;
+    info: import('../types').TypeConfigInfo;
+}>;
+export declare const commandCliInfo: Omit<CliInfo, "usage">;

package/types/index.d.ts

@@ -0,0 +1,2 @@
+export { handler } from './handlers';
+export { crateAsSubcommand } from "./main";

package/types/injectInfo.json.d.ts

@@ -0,0 +1,11 @@
+declare const _default: {
+  "name": "@done-coding/cli-config",
+  "version": "0.1.0-alpha.0",
+  "description": "工程化配置命令行工具",
+  "cliConfig": {
+    "namespaceDir": ".done-coding",
+    "moduleName": "config"
+  }
+};
+
+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/types/index.d.ts

@@ -0,0 +1,92 @@
+import { InitConfigFileOptions, ReadConfigFileOptions } from "@done-coding/cli-utils";
+/** 子命令枚举 */
+export declare enum SubcommandEnum {
+    /** 检测工程化配置*/
+    CHECK = "check",
+    /** 添加工程化配置 */
+    ADD = "add"
+}
+/** (工程化)配置模块枚举 */
+export declare enum ConfigModuleEnum {
+    /** eslint 配置 */
+    ESLINT = "eslint",
+    /** prettier 配置 */
+    PRETTIER = "prettier",
+    /** 提交配置 */
+    COMMITLINT = "commitlint",
+    /** 文件配置 */
+    LSLINT = "ls-lint",
+    /** (git)合并检测 */
+    MERGELINT = "merge-lint"
+}
+/** config命令的配置 */
+export interface ConfigConfig {
+    moduleList?: ConfigModuleEnum[];
+}
+/** 初始化配置选项 */
+export interface initConfigOptions extends InitConfigFileOptions {
+}
+/** 检测配置选项 */
+export interface CheckConfigOptions extends ReadConfigFileOptions, Partial<ConfigConfig> {
+}
+/** 添加配置选项 */
+export interface AddConfigOptions extends ReadConfigFileOptions, Partial<ConfigConfig> {
+    /** 是否直接提交git */
+    commitGit?: boolean;
+}
+/** 各类型工程化配置信息 */
+export type TypeConfigInfo = {
+    [key in ConfigModuleEnum]?: {
+        version: string;
+        /** 配置文件相对路径 */
+        configFileRelativePathList: string[];
+    };
+};
+/** 配置文件信息 */
+export interface ConfigConfigFileInfo {
+    /**
+     * 待复制的配置文件路径
+     * ---
+     * 相对于当前工程化模块目录对应的版本目录
+     */
+    sourceFile: string;
+    /**
+     * 目标配置文件路径
+     * ---
+     * 相对于命令运行目录
+     */
+    targetFile: string;
+    /** 描述 */
+    description?: string;
+    /** 当前配置依赖的额外包 */
+    relyPackages?: string[];
+}
+/** 项目配置单项 */
+export interface ConfigProjectConfigItem {
+    version: string;
+    /** 配置文件配置列表 */
+    configFileInfoList: ConfigConfigFileInfo[];
+    /** 依赖的包 */
+    relyPackages?: string[];
+    /** package.json需要添加的配置 */
+    packageJson?: {
+        scripts?: Record<string, string>;
+        "lint-staged"?: Record<string, string[]>;
+    };
+    /** husky需要添加的配置 */
+    husky?: {
+        hooks?: Record<string, string>;
+    };
+    /** 运行脚本 */
+    runScripts?: string[];
+}
+/**
+ * 项目配置
+ * ---
+ * value 为 string时则是该模块对应的预置列表json文件名【相对于所属工程化模块目录】，如 reset-list.json
+ */
+export type ConfigProject = Record<string, ConfigProjectConfigItem[] | string>;
+/** 工程化配置 */
+export interface ConfigConfigJson {
+    project: ConfigProject;
+}

package/types/utils/config-resolve.d.ts

@@ -0,0 +1,20 @@
+import type { AddConfigOptions, CheckConfigOptions, ConfigConfig, TypeConfigInfo } from '../types';
+import { ConfigModuleEnum } from '../types';
+/** 允许的模块 */
+export declare const ALLOW_MODULE_LIST: ConfigModuleEnum[];
+export declare const getConfig: (argv: CheckConfigOptions | AddConfigOptions) => Promise<ConfigConfig>;
+/** 配置模块与包名的映射 */
+export declare const configModulePkgNameMap: {
+    [key in ConfigModuleEnum]: string;
+};
+/** 配置类型与配置文件后缀的映射 */
+export declare const configModuleConfigFileSuffixMap: {
+    [key in ConfigModuleEnum]: string[];
+};
+/** 矫正配置模块列表 */
+export declare const adjustModuleList: (list: string[]) => ConfigModuleEnum[];
+/** 获取配置信息 */
+export declare const getConfigInfo: ({ config, rootDir, }: {
+    config: ConfigConfig;
+    rootDir: string;
+}) => TypeConfigInfo;

package/types/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./path";
+export * from "./config-resolve";

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;