@done-coding/cli-component 0.1.1

package/README.md

@@ -0,0 +1,7 @@
+# @done-coding/cli-component
+
+组件命令行工具
+
+## 使用
+
+npm install @done-coding/cli-component

package/es/cli.mjs

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import { createCli as e } from "./main.mjs";
+e();

package/es/handler.mjs

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+import { SubcommandEnum as n } from "./utils/types.mjs";
+import { listComponent as r } from "./utils/list.mjs";
+import { addComponent as t } from "./utils/add.mjs";
+import { removeComponent as m } from "./utils/remove.mjs";
+import s from "chalk";
+const u = async (o, e) => (console.log("com", e), o === n.ADD ? t(e) : o === n.REMOVE ? m(e) : o === n.LIST ? r() : (console.log(s.red("无效的命令")), process.exit(1))), d = async (o) => {
+  console.log("component 子命令处理函数", o);
+};
+export {
+  d as handler,
+  u as subHandler
+};

package/es/index.mjs

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+import { handler as e } from "./handler.mjs";
+import { command as m } from "./main.mjs";
+export {
+  m as command,
+  e as handler
+};

package/es/injectInfo.json.mjs

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+const n = {
+  name: "@done-coding/cli-component",
+  version: "0.1.1",
+  description: "组件命令行工具"
+};
+export {
+  n as default
+};

package/es/main.mjs

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+import l from "yargs";
+import { hideBin as p } from "yargs/helpers";
+import { MODULE_NAME as u } from "./utils/const.mjs";
+import { SubcommandEnum as o } from "./utils/types.mjs";
+import { handler as i, subHandler as r } from "./handler.mjs";
+import a from "chalk";
+import t from "./injectInfo.json.mjs";
+import m from "lodash.curry";
+const c = u, g = (e, n) => {
+  console.log(e ? a.red(e) : a.red(n.message)), process.exit(1);
+}, f = t.description, b = `Usage: $0 ${c} <command> [options]`, h = "Usage: $0 <command> [options]", s = (e) => e.command({
+  command: `${o.ADD} <name>`,
+  describe: "新增一个组件",
+  builder: (n) => n.positional("name", {
+    describe: "组件名称",
+    type: "string"
+  }),
+  handler: m(r)(o.ADD)
+}).command({
+  command: `${o.REMOVE} [name]`,
+  describe: "删除一个组件",
+  builder: (n) => n.positional("name", {
+    describe: "组件名称",
+    type: "string"
+  }),
+  handler: m(r)(o.REMOVE)
+}).command({
+  command: o.LIST,
+  describe: "展示组件列表",
+  handler: m(r)(o.LIST)
+}).demandCommand(1), d = (e, n = !1) => n ? s(e.strict().usage(b)) : s(
+  e.strict().usage(h).help("help").version(t.version).alias("v", "version").alias("h", "help")
+).fail(g).argv, v = (e) => d(e, !0), A = {
+  command: c,
+  describe: f,
+  builder: v,
+  handler: i
+}, I = async () => {
+  const e = l(p(process.argv)), n = await d(e);
+  return i(n);
+};
+export {
+  A as command,
+  I as createCli
+};

package/es/utils/add.mjs

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+import { SubcommandEnum as s } from "./types.mjs";
+import { ensureNameLegal as i } from "./name.mjs";
+import { getConfig as p } from "./config.mjs";
+import n from "chalk";
+import f from "prompts";
+import { operateComponent as c } from "./operate.mjs";
+import { getComponentList as l } from "./list.mjs";
+import { getComponentEnvData as g } from "./env-data.mjs";
+const E = async ({ name: t }) => {
+  console.log(n.blue("添加组件"));
+  let o;
+  t ? o = t : o = (await f({
+    type: "text",
+    name: "name",
+    message: "请输入组件名"
+  })).name;
+  const e = p();
+  i(o, e);
+  const { series: r } = e, a = await l(e);
+  for (let m of a)
+    if (g({
+      series: r,
+      name: o
+    }).nameKebab === m)
+      return console.log(n.red(`组件${m}已存在, 不能再次创建${o}组件`)), process.exit(1);
+  return c({
+    name: o,
+    config: e,
+    command: s.ADD
+  });
+};
+export {
+  E as addComponent
+};

package/es/utils/config.mjs

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+import i from "node:path";
+import o from "node:fs";
+import a from "json5";
+import s from "chalk";
+import { getTemplateDirAbsolutePath as m, getPathEnvData as p } from "./env-data.mjs";
+import f from "lodash.template";
+const D = () => {
+  const e = i.resolve(m(), "index.json");
+  if (!o.existsSync(e))
+    return console.log(s.red(`模块入口文件不存在: ${e}`)), process.exit(1);
+  const t = JSON.parse(o.readFileSync(e, "utf-8")).config;
+  if (!t)
+    return console.log(s.red(`配置文件相对路径不存在: ${t}`)), process.exit(1);
+  const n = i.resolve(
+    i.dirname(e),
+    t
+  );
+  if (!o.existsSync(n))
+    return console.log(s.red(`配置文件不存在: ${n}`)), process.exit(1);
+  const r = a.parse(o.readFileSync(n, "utf-8")), c = p();
+  return r.componentDir = f(r.componentDir)(c), r;
+};
+export {
+  D as getConfig
+};

package/es/utils/const.mjs

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+const n = ".done-coding", o = "component";
+export {
+  n as CLI_NAMESPACE_DIR,
+  o as MODULE_NAME
+};

package/es/utils/env-data.mjs

@@ -0,0 +1,32 @@
+#!/usr/bin/env node
+import a from "lodash.upperfirst";
+import m from "lodash.camelcase";
+import c from "lodash.kebabcase";
+import u from "lodash.lowerfirst";
+import b from "node:path";
+import { CLI_NAMESPACE_DIR as f, MODULE_NAME as D } from "./const.mjs";
+const E = () => b.resolve(f, D), _ = () => ({
+  execDir: process.cwd(),
+  templateDir: E()
+}), v = (t) => {
+  const { series: r, name: i } = t, e = a(m(i)), p = u(e), l = c(e), o = r ? a(m(r)) : "", s = o ? `${o}${e}` : "", n = c(s);
+  return {
+    series: o,
+    name: e,
+    nameLowerFirst: p,
+    nameKebab: l,
+    fullName: s,
+    fullNameKebab: n,
+    cls: n
+  };
+}, w = (t) => ({
+  $: "$",
+  ..._(),
+  ...v(t)
+});
+export {
+  v as getComponentEnvData,
+  w as getEnvData,
+  _ as getPathEnvData,
+  E as getTemplateDirAbsolutePath
+};

package/es/utils/list.mjs

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+import o from "chalk";
+import i from "node:path";
+import c from "node:fs";
+import { getConfig as m } from "./config.mjs";
+import { getComponentEnvData as f } from "./env-data.mjs";
+const p = (t) => {
+  const { componentDir: e, nameExcludes: n } = t;
+  return c.statSync(e).isDirectory() ? c.readdirSync(e).map((s) => {
+    const r = i.join(e, s);
+    return c.statSync(r).isDirectory() ? (console.log("filePath:", r, i.basename(r)), i.basename(r)) : "";
+  }).filter((s) => !(!s || n.includes(s))) : (console.log(o.red("组件源码路径不是目录")), process.exit(1));
+}, v = async () => {
+  console.log(o.blue("展示列表"));
+  const t = m(), e = p(t);
+  console.table(
+    e.map((n) => {
+      const { name: l, fullName: a } = f({
+        ...t,
+        name: n
+      });
+      return {
+        [o.green("名称")]: l,
+        [o.green("带系列名称")]: a,
+        [o.green("绝对路径")]: i.resolve(t.componentDir, n)
+      };
+    })
+  );
+};
+export {
+  p as getComponentList,
+  v as listComponent
+};

package/es/utils/name.mjs

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+import o from "chalk";
+const t = (e, s) => {
+  if (!/^[a-zA-Z]+[a-zA-Z0-9-]*$/.test(e))
+    return console.log(o.red("组件名只能包含字母、数字、中划线")), process.exit(1);
+  const { nameExcludes: r } = s;
+  return r.includes(e) ? (console.log(
+    o.red(`组件名: ${e}是保留名称。
+保留名称: ${r.join(",")}`)
+  ), process.exit(1)) : !0;
+};
+export {
+  t as ensureNameLegal
+};

package/es/utils/operate.mjs

@@ -0,0 +1,47 @@
+#!/usr/bin/env node
+import { getEnvData as E } from "./env-data.mjs";
+import { SubcommandEnum as u } from "./types.mjs";
+import { OutputModeEnum as l, handler as c } from "@done-coding/cli-template";
+import i from "lodash.template";
+import d from "chalk";
+const k = async ({
+  name: m,
+  config: e,
+  command: n
+}) => {
+  if (![u.ADD, u.REMOVE].includes(n))
+    return console.log(d.red(`不支持组件${n}操作`)), process.exit(1);
+  const o = E({
+    ...e,
+    name: m
+  }), f = JSON.stringify(o);
+  for (const { entry: p, index: a } of e.list) {
+    if (p) {
+      const t = p;
+      t != null && t.input && (t.input = i(t.input)(o)), t != null && t.output && (t.output = i(t.output)(o));
+      const r = {
+        ...p,
+        envData: f,
+        mode: l.APPEND,
+        rollback: n === u.REMOVE,
+        dealMarkdown: !0
+      };
+      await c(r);
+    }
+    if (a) {
+      const t = a;
+      t != null && t.input && (t.input = i(t.input)(o)), t != null && t.output && (t.output = i(t.output)(o));
+      const r = {
+        ...a,
+        envData: f,
+        mode: l.OVERWRITE,
+        rollback: n === u.REMOVE,
+        dealMarkdown: !0
+      };
+      await c(r);
+    }
+  }
+};
+export {
+  k as operateComponent
+};

package/es/utils/remove.mjs

@@ -0,0 +1,40 @@
+#!/usr/bin/env node
+import { SubcommandEnum as s } from "./types.mjs";
+import { getConfig as i } from "./config.mjs";
+import n from "chalk";
+import p from "prompts";
+import { operateComponent as c } from "./operate.mjs";
+import { getComponentList as f } from "./list.mjs";
+import { getComponentEnvData as l } from "./env-data.mjs";
+import g from "node:fs";
+import u from "node:path";
+const K = async ({ name: m }) => {
+  console.log(n.blue("移除组件"));
+  const t = i(), r = await f(t);
+  if (r.length === 0)
+    return console.log(n.red("组件列表为空")), process.exit(1);
+  let o;
+  m ? o = m : o = (await p({
+    type: "select",
+    name: "name",
+    message: "请选择要移除的组件",
+    choices: r.map((e) => ({ title: e, value: e }))
+  })).name;
+  const { series: a } = t;
+  for (let e of r)
+    if (l({
+      series: a,
+      name: o
+    }).nameKebab === e) {
+      await c({
+        name: o,
+        config: t,
+        command: s.REMOVE
+      }), g.rmdirSync(u.resolve(t.componentDir, e));
+      return;
+    }
+  return console.log(n.red(`组件${o}不存在`)), process.exit(1);
+};
+export {
+  K as removeComponent
+};

package/es/utils/types.mjs

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+var r = /* @__PURE__ */ ((e) => (e.ADD = "add", e.REMOVE = "remove", e.LIST = "list", e))(r || {});
+export {
+  r as SubcommandEnum
+};

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@done-coding/cli-component",
+  "version": "0.1.1",
+  "description": "组件命令行工具",
+  "private": false,
+  "module": "es/index.mjs",
+  "type": "module",
+  "types": "types/index.d.ts",
+  "bin": {
+    "dc-component": "es/cli.mjs"
+  },
+  "exports": {
+    ".": {
+      "import": "./es/index.mjs"
+    }
+  },
+  "files": [
+    "es",
+    "lib",
+    "types",
+    "gif"
+  ],
+  "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/component"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "JustSoSu",
+  "license": "MIT",
+  "sideEffects": false,
+  "devDependencies": {
+    "@done-coding/cli-inject": "^0.2.2",
+    "@types/json5": "^2.2.0",
+    "@types/lodash.camelcase": "^4.3.8",
+    "@types/lodash.curry": "^4.1.8",
+    "@types/lodash.get": "^4.4.8",
+    "@types/lodash.kebabcase": "^4.1.8",
+    "@types/lodash.lowerfirst": "^4.3.8",
+    "@types/lodash.template": "^4.5.2",
+    "@types/lodash.upperfirst": "^4.3.8",
+    "@types/node": "^16.0.0",
+    "@types/prompts": "^2.4.6",
+    "@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": ">=16.0.0"
+  },
+  "dependencies": {
+    "@done-coding/cli-template": "^0.2.1",
+    "chalk": "^5.3.0",
+    "json5": "^2.2.3",
+    "lodash.camelcase": "^4.3.0",
+    "lodash.curry": "^4.1.1",
+    "lodash.get": "^4.4.2",
+    "lodash.kebabcase": "^4.1.1",
+    "lodash.lowerfirst": "^4.3.1",
+    "lodash.template": "^4.5.0",
+    "lodash.upperfirst": "^4.3.1",
+    "prompts": "^2.4.2",
+    "yargs": "^17.7.2"
+  },
+  "gitHead": "e2dc7c4b0fa74aa83dc6173416aaffe0a0a445ad"
+}

package/types/cli.d.ts

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

package/types/handler.d.ts

@@ -0,0 +1,6 @@
+import type { Options } from './utils';
+import { SubcommandEnum } from './utils';
+import type { ArgumentsCamelCase } from "yargs";
+/** 子命令处理函数 */
+export declare const subHandler: (command: SubcommandEnum, argv: ArgumentsCamelCase<Options>) => Promise<void>;
+export declare const handler: (argv: ArgumentsCamelCase<Options>) => Promise<void>;

package/types/index.d.ts

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

package/types/injectInfo.json.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+  "name": "@done-coding/cli-component",
+  "version": "0.1.1",
+  "description": "组件命令行工具"
+};
+
+export default _default;

package/types/main.d.ts

@@ -0,0 +1,4 @@
+import type { CommandModule } from "yargs";
+import { type Options } from './utils';
+export declare const command: CommandModule<Options, Options>;
+export declare const createCli: () => Promise<void>;

package/types/utils/add.d.ts

@@ -0,0 +1,3 @@
+import type { Options } from "./types";
+/** 新增组件 */
+export declare const addComponent: ({ name: nameInit }: Options) => Promise<undefined>;

package/types/utils/config.d.ts

@@ -0,0 +1,3 @@
+import type { Config } from "./types";
+/** 获取配置 */
+export declare const getConfig: () => Config;

package/types/utils/const.d.ts

@@ -0,0 +1,4 @@
+/** 命令空间目录 */
+export declare const CLI_NAMESPACE_DIR = ".done-coding";
+/** 模块名 */
+export declare const MODULE_NAME = "component";

package/types/utils/env-data.d.ts

@@ -0,0 +1,41 @@
+import type { Config, Options } from "./types";
+/** 获取模板目录绝对路径 */
+export declare const getTemplateDirAbsolutePath: () => string;
+/** 路径环境变量 */
+export interface PathEnvData {
+    /** 执行命令的目录绝对路径 */
+    execDir: string;
+    /** 模板目录绝对路径 */
+    templateDir: string;
+}
+/** 获取路径环境变量 */
+export declare const getPathEnvData: () => {
+    execDir: string;
+    templateDir: string;
+};
+/** 组件环境变量 */
+export interface ComponentEnvData {
+    /** 矫正后的组件系列 */
+    series: string;
+    /** 矫正后的组件名 */
+    name: string;
+    /** 矫正后的组件名小写开头 */
+    nameLowerFirst: string;
+    /** 小写连接的组件名 */
+    nameKebab: string;
+    /** 矫正后的带系列组件名 */
+    fullName: string;
+    /** 矫正后的带系列小写连接的组件名 */
+    fullNameKebab: string;
+    /** 组件类名 */
+    cls: string;
+}
+/** 获取环境变量 */
+export declare const getComponentEnvData: (data: Pick<Config, "series"> & Required<Options>) => ComponentEnvData;
+/** 环境变量 */
+export interface EnvData extends PathEnvData, ComponentEnvData {
+    /** 转义的$ */
+    $: "$";
+}
+/** 获取环境变量 */
+export declare const getEnvData: (data: Pick<Config, "series"> & Required<Options>) => EnvData;

package/types/utils/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./const";
+export * from "./types";
+export * from "./name";
+export * from "./config";
+export * from "./list";
+export * from "./add";
+export * from "./remove";

package/types/utils/list.d.ts

@@ -0,0 +1,6 @@
+import type { Config } from "./types";
+/**
+ * 获取组件列表
+ */
+export declare const getComponentList: (config: Config) => string[];
+export declare const listComponent: () => Promise<void>;

package/types/utils/name.d.ts

@@ -0,0 +1,7 @@
+import type { Config } from "./types";
+/**
+ * 组件名检测
+ * ---
+ * 限制只能字母、数字、中划线且以字母开头
+ */
+export declare const ensureNameLegal: (name: string, config: Config) => boolean;

package/types/utils/operate.d.ts

@@ -0,0 +1,8 @@
+import type { Config } from "./types";
+import { SubcommandEnum } from "./types";
+/** 操作组件 */
+export declare const operateComponent: ({ name, config, command, }: {
+    name: string;
+    config: Config;
+    command: SubcommandEnum;
+}) => Promise<undefined>;

package/types/utils/remove.d.ts

@@ -0,0 +1,3 @@
+import type { Options } from "./types";
+/** 新增组件 */
+export declare const removeComponent: ({ name: nameInit }: Options) => Promise<undefined>;

package/types/utils/types.d.ts

@@ -0,0 +1,44 @@
+import type { Options as TemplateOptions } from "@done-coding/cli-template";
+/** 子命令枚举 */
+export declare enum SubcommandEnum {
+    /** 新增组件 */
+    ADD = "add",
+    /** 移除组件 */
+    REMOVE = "remove",
+    /** 展示列表 */
+    LIST = "list"
+}
+export interface Options {
+    /**
+     * 组件名
+     * ---
+     * 新增时必传
+     */
+    name?: string;
+}
+/** 模版配置输入路径 */
+export type TemplateConfigInputByPath = Pick<TemplateOptions, "input" | "output">;
+/** 模版配置输入数据 */
+export type TemplateConfigInputByData = Pick<TemplateOptions, "inputData" | "output">;
+/** 模版配置 */
+export type TemplateConfig = TemplateConfigInputByPath | TemplateConfigInputByData;
+/** 模版配置完整 */
+export type TemplateConfigFull = Pick<TemplateOptions, "input" | "inputData" | "output">;
+/** 列表item */
+export interface ConfigListItem {
+    /** 组件逻辑文件 */
+    entry: TemplateConfig;
+    /** 组件逻辑文件 */
+    index?: TemplateConfig;
+}
+/** 组件配置 */
+export interface Config {
+    /** 组件系列 */
+    series: string;
+    /** 组件名排除列表 */
+    nameExcludes: string[];
+    /** 组件目录 */
+    componentDir: string;
+    /** 配置列表 */
+    list: ConfigListItem[];
+}