done-coding-component 0.3.8-alpha.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,12 @@
+#!/usr/bin/env node
+import { c as m } from "./index-f3df0c33.js";
+import "node:path";
+import "node:fs";
+import "lodash.upperfirst";
+import "lodash.camelcase";
+import "lodash.kebabcase";
+import "lodash.lowerfirst";
+import "lodash.template";
+import "@done-coding/cli-utils";
+import "@done-coding/cli-template";
+m();

package/es/index-f3df0c33.js

@@ -0,0 +1,223 @@
+#!/usr/bin/env node
+import u from "node:path";
+import p from "node:fs";
+import x from "lodash.upperfirst";
+import h from "lodash.camelcase";
+import y from "lodash.kebabcase";
+import A from "lodash.lowerfirst";
+import f from "lodash.template";
+import { log as m, json5 as L, chalk as g, xPrompts as w, _curry as b, createSubcommand as M, createMainCommand as F } from "@done-coding/cli-utils";
+import { OutputModeEnum as $, compileHandler as O } from "@done-coding/cli-template";
+var a = /* @__PURE__ */ ((e) => (e.ADD = "add", e.REMOVE = "remove", e.LIST = "list", e))(a || {});
+const T = (e, t) => {
+  if (!/^[a-zA-Z]+[a-zA-Z0-9-]*$/.test(e))
+    return m.error("组件名只能包含字母、数字、中划线"), process.exit(1);
+  const { nameExcludes: n } = t;
+  return n.includes(e) ? (m.error(`组件名: ${e}是保留名称。
+保留名称: ${n.join(",")}`), process.exit(1)) : !0;
+}, N = {
+  name: "@done-coding/cli-component",
+  version: "0.3.8-alpha.1",
+  description: "组件命令行工具",
+  cliConfig: {
+    namespaceDir: ".done-coding",
+    moduleName: "component"
+  }
+}, { namespaceDir: _, moduleName: j } = N.cliConfig, I = () => u.resolve(_, j), R = () => ({
+  execDir: process.cwd(),
+  templateDir: I()
+}), D = (e) => {
+  const { series: t, name: n } = e, o = x(h(n)), i = A(o), s = y(o), c = t ? x(h(t)) : "", l = c ? `${c}${o}` : "", r = y(l);
+  return {
+    series: c,
+    name: o,
+    nameLowerFirst: i,
+    nameKebab: s,
+    fullName: l,
+    fullNameKebab: r,
+    cls: r
+  };
+}, K = (e) => ({
+  $: "$",
+  ...R(),
+  ...D(e)
+}), C = () => {
+  const e = u.resolve(I(), "index.json");
+  if (!p.existsSync(e))
+    return m.error(`模块入口文件不存在: ${e}`), process.exit(1);
+  const n = JSON.parse(p.readFileSync(e, "utf-8")).config;
+  if (!n)
+    return m.error(`配置文件相对路径不存在: ${n}`), process.exit(1);
+  const o = u.resolve(
+    u.dirname(e),
+    n
+  );
+  if (!p.existsSync(o))
+    return m.error(`配置文件不存在: ${o}`), process.exit(1);
+  const i = L.parse(p.readFileSync(o, "utf-8")), s = R();
+  return i.componentDir = f(i.componentDir)(s), i;
+}, E = (e) => {
+  const { componentDir: t, nameExcludes: n } = e;
+  return p.statSync(t).isDirectory() ? p.readdirSync(t).map((c) => {
+    const l = u.join(t, c);
+    return p.statSync(l).isDirectory() ? (console.log("filePath:", l, u.basename(l)), u.basename(l)) : "";
+  }).filter((c) => !(!c || n.includes(c))) : (m.error("组件源码路径不是目录"), process.exit(1));
+}, z = async () => {
+  m.stage("展示列表");
+  const e = C(), t = E(e);
+  console.table(
+    t.map((n) => {
+      const { name: o, fullName: i } = D({
+        ...e,
+        name: n
+      });
+      return {
+        [g.green("名称")]: o,
+        [g.green("带系列名称")]: i,
+        [g.green("绝对路径")]: u.resolve(e.componentDir, n)
+      };
+    })
+  );
+}, P = async ({
+  name: e,
+  config: t,
+  command: n
+}) => {
+  if (![a.ADD, a.REMOVE].includes(n))
+    return m.error(`不支持组件${n}操作`), process.exit(1);
+  const o = K({
+    ...t,
+    name: e
+  }), i = process.cwd(), s = JSON.stringify(o);
+  for (const { entry: c, index: l } of t.list) {
+    if (c) {
+      const r = c;
+      r != null && r.input && (r.input = f(r.input)(o)), r != null && r.output && (r.output = f(r.output)(o));
+      const d = {
+        ...c,
+        envData: s,
+        mode: $.APPEND,
+        rollback: n === a.REMOVE,
+        /** 回滚时可以删除空文件 */
+        rollbackDelNullFile: !0,
+        dealMarkdown: !0,
+        batch: !1,
+        rootDir: i
+      };
+      await O(d);
+    }
+    if (l) {
+      const r = l;
+      r != null && r.input && (r.input = f(r.input)(o)), r != null && r.output && (r.output = f(r.output)(o));
+      const d = {
+        ...l,
+        envData: s,
+        mode: $.OVERWRITE,
+        rollback: n === a.REMOVE,
+        dealMarkdown: !0,
+        batch: !1,
+        rootDir: i
+      };
+      await O(d);
+    }
+  }
+}, J = async ({ name: e }) => {
+  m.stage("添加组件");
+  let t;
+  e ? t = e : t = (await w({
+    type: "text",
+    name: "name",
+    message: "请输入组件名"
+  })).name;
+  const n = C();
+  T(t, n);
+  const { series: o } = n, i = await E(n);
+  for (let s of i)
+    if (D({
+      series: o,
+      name: t
+    }).nameKebab === s)
+      return m.error(`组件${s}已存在, 不能再次创建${t}组件`), process.exit(1);
+  return P({
+    name: t,
+    config: n,
+    command: a.ADD
+  });
+}, Z = async ({ name: e }) => {
+  m.stage("移除组件");
+  const t = C(), n = await E(t);
+  if (n.length === 0)
+    return m.error("组件列表为空"), process.exit(1);
+  let o;
+  e ? o = e : o = (await w({
+    type: "select",
+    name: "name",
+    message: "请选择要移除的组件",
+    choices: n.map((s) => ({ title: s, value: s }))
+  })).name;
+  const { series: i } = t;
+  for (let s of n)
+    if (D({
+      series: i,
+      name: o
+    }).nameKebab === s) {
+      await P({
+        name: o,
+        config: t,
+        command: a.REMOVE
+      }), p.rmdirSync(u.resolve(t.componentDir, s));
+      return;
+    }
+  return m.error(`组件${o}不存在`), process.exit(1);
+}, v = async (e, t) => e === a.ADD ? J(t) : e === a.REMOVE ? Z(t) : e === a.LIST ? z() : (m.error(`无效的命令: ${e}`), process.exit(1)), {
+  version: H,
+  description: U,
+  cliConfig: { moduleName: S }
+} = N, W = {
+  command: `${a.ADD} <name>`,
+  describe: "新增一个组件",
+  positionals: {
+    name: {
+      describe: "组件名称",
+      type: "string"
+    }
+  },
+  handler: b(v)(a.ADD)
+}, q = {
+  command: `${a.REMOVE} [name]`,
+  describe: "删除一个组件",
+  positionals: {
+    name: {
+      describe: "组件名称",
+      type: "string"
+    }
+  },
+  handler: b(v)(a.REMOVE)
+}, B = {
+  command: a.LIST,
+  describe: "展示组件列表",
+  handler: b(v)(a.LIST)
+}, V = {
+  describe: U,
+  version: H,
+  subcommands: [
+    W,
+    q,
+    B
+  ].map(M),
+  demandCommandCount: 1
+}, k = (e = !1) => {
+  const t = e ? S : void 0, n = `$0${e ? ` ${S}` : ""} <command> [options]`;
+  return { command: t, usage: n };
+}, se = async () => F({
+  ...V,
+  ...k()
+}), ae = () => M({
+  ...V,
+  ...k(!0)
+});
+export {
+  ae as a,
+  se as c,
+  v as h
+};

package/es/index.mjs

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+import { a as b, h as c } from "./index-f3df0c33.js";
+import "node:path";
+import "node:fs";
+import "lodash.upperfirst";
+import "lodash.camelcase";
+import "lodash.kebabcase";
+import "lodash.lowerfirst";
+import "lodash.template";
+import "@done-coding/cli-utils";
+import "@done-coding/cli-template";
+export {
+  b as crateAsSubcommand,
+  c as handler
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "done-coding-component",
+  "version": "0.3.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/component"
+  },
+  "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.camelcase": "^4.3.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": "^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-alpha.1",
+    "@done-coding/cli-utils": "^0.6.0-alpha.0",
+    "lodash.camelcase": "^4.3.0",
+    "lodash.kebabcase": "^4.1.1",
+    "lodash.lowerfirst": "^4.3.1",
+    "lodash.template": "^4.5.0",
+    "lodash.upperfirst": "^4.3.1"
+  },
+  "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 { Options } from './utils';
+import { SubcommandEnum } from './utils';
+import type { CliHandlerArgv } from "@done-coding/cli-utils";
+/** 命令处理函数 */
+export declare const handler: (command: SubcommandEnum, argv: CliHandlerArgv<Options>) => Promise<void>;

package/types/index.d.ts

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

package/types/injectInfo.json.d.ts

@@ -0,0 +1,11 @@
+declare const _default: {
+  "name": "@done-coding/cli-component",
+  "version": "0.3.8-alpha.1",
+  "description": "组件命令行工具",
+  "cliConfig": {
+    "namespaceDir": ".done-coding",
+    "moduleName": "component"
+  }
+};
+
+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/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/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,6 @@
+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 { CompileOptions } from "@done-coding/cli-template";
+/** 子命令枚举 */
+export declare enum SubcommandEnum {
+    /** 新增组件 */
+    ADD = "add",
+    /** 移除组件 */
+    REMOVE = "remove",
+    /** 展示列表 */
+    LIST = "list"
+}
+export interface Options {
+    /**
+     * 组件名
+     * ---
+     * 新增时必传
+     */
+    name?: string;
+}
+/** 模版配置输入路径 */
+export type TemplateConfigInputByPath = Pick<CompileOptions, "input" | "output">;
+/** 模版配置输入数据 */
+export type TemplateConfigInputByData = Pick<CompileOptions, "inputData" | "output">;
+/** 模版配置 */
+export type TemplateConfig = TemplateConfigInputByPath | TemplateConfigInputByData;
+/** 模版配置完整 */
+export type TemplateConfigFull = Pick<CompileOptions, "input" | "inputData" | "output">;
+/** 列表item */
+export interface ConfigListItem {
+    /** 入口文件 */
+    entry: TemplateConfig;
+    /** 索引文件 */
+    index?: TemplateConfig;
+}
+/** 组件配置 */
+export interface Config {
+    /** 组件系列 */
+    series: string;
+    /** 组件名排除列表 */
+    nameExcludes: string[];
+    /** 组件目录 */
+    componentDir: string;
+    /** 配置列表 */
+    list: ConfigListItem[];
+}