🔧 chore(feature): 增加 script 命令

Author: OSpoon

README.md

@@ -374,6 +374,26 @@ import { impSort } from "../src/index";
 ```
 
 PS: 依赖 `eslint` API 模式, 依赖 `simple-import-sort` 插件的同时依旧会读取项目配置的 `.eslintignore` 和 `.eslintrc.json` 文件.
+
+## script 命令
+
+代理运行 `package.scripts` 脚本, 仅支持询问模式;
+
+### 询问模式
+
+```bash
+# 启动询问模式
+codeg script
+```
+
+```
+# 询问过程
+
+1. 请选择项目运行脚本
+```
+
+PS: 第一次使用 `script` 命令会初始化 `scripts.config.json`, 可以为它增加对应的描述, 以后每次使用均会同步 `package.scripts` 的变化.
+
 ## 其他命令
 
 | 命令       | 参数              | 默认值 | 功能描述                                      |

package.json

@@ -43,10 +43,10 @@
     "node": ">=14.17"
   },
   "scripts": {
-    "prepare": "npx esno scripts/prepare.ts",
-    "build": "npx unbuild",
-    "stub": "npx unbuild --stub",
-    "release": "npx release-it"
+    "prepare": "esno scripts/prepare.ts",
+    "build": "unbuild",
+    "stub": "unbuild --stub",
+    "release": "release-it"
   },
   "keywords": [
     "CodeGenius",

scripts.config.json

@@ -0,0 +1,24 @@
+{
+  "scripts": [
+    {
+      "cmd": "prepare",
+      "script": "esno scripts/prepare.ts",
+      "desc": "预执行脚本, 用来初始化 hooks 等配置"
+    },
+    {
+      "cmd": "build",
+      "script": "unbuild",
+      "desc": "使用 unbuild 构建项目, 输出到 dist 目录"
+    },
+    {
+      "cmd": "stub",
+      "script": "unbuild --stub",
+      "desc": "使用 unbuild 软构建项目, 方便调试"
+    },
+    {
+      "cmd": "release",
+      "script": "release-it",
+      "desc": "发布项目到 npm 仓库, 并推送 Github"
+    }
+  ]
+}

src/command/npm-run.ts

@@ -24,7 +24,7 @@ export const root = async () => {
     {
       name: "command",
       type: "select",
-      message: "请选择正确执行的 CodeG 命令",
+      message: "请选择待执行的 CodeG 命令",
       choices: commandChoices,
     },
   ]);

src/command/root.ts

@@ -0,0 +1,57 @@
+import path from "node:path";
+
+import type { CAC } from "cac";
+import enquirer from "enquirer";
+import { readJsonSync } from "fs-extra";
+
+import { generateScripts } from "@/helper";
+import { execCommand } from "@/helper";
+import { CommandOptions } from "@/types";
+
+export async function scriptRun() {
+  const { scripts } = readJsonSync(
+    path.join(process.cwd(), "scripts.config.json"),
+  );
+
+  const scriptChoices = scripts.map((script: CommandOptions) => {
+    const formatCmd = `${script.cmd}`.padEnd(15);
+    return {
+      name: script.script,
+      message: `${formatCmd} ${script.desc}`,
+    };
+  });
+
+  const result = await enquirer.prompt<{ script: string }>([
+    {
+      name: "script",
+      type: "select",
+      message: "请选择项目运行脚本",
+      choices: scriptChoices,
+    },
+  ]);
+
+  if (result.script) {
+    const script = result.script;
+    if (script.startsWith("npx")) {
+      const cmd = script.split(" ")[0];
+      const args = script.split(" ").slice(1);
+      execCommand(cmd, args, { stdio: "inherit" });
+    } else {
+      execCommand("npx", script.split(" "), { stdio: "inherit" });
+    }
+  }
+}
+
+export default function scriptRunInstaller(cli: CAC) {
+  return {
+    name: "scriptRunInstaller",
+    setup: () => {
+      cli
+        .command("script", "代理运行 package.scripts 脚本")
+        .action(async () => {
+          await generateScripts();
+          await scriptRun();
+        });
+    },
+  };
+}

src/command/script.ts

@@ -250,6 +250,10 @@ export const commands = [
     command: "quantity",
     description: "运行 cloc 分析并统计代码量",
   },
+  {
+    command: "script",
+    description: "代理执行 package.scripts 脚本",
+  },
   {
     display: "help",
     command: "--help",

src/config.ts

@@ -6,11 +6,12 @@ import boxen from "boxen";
 import { CAC } from "cac";
 import type { Options } from "execa";
 import execa from "execa";
+import fsExtra from "fs-extra";
 import { gray, green, red, yellow } from "kolorist";
 
 import { ACTIVATION, FRAMEWORKS, TEMPLATES } from "@/config";
 
-import { CodeGeniusOptions } from "./types";
+import { CodeGeniusOptions, CommandOptions } from "./types";
 
 const boxenBorderStyle = {
   padding: 1,
@@ -291,9 +292,69 @@ export function generateRandom(length: number) {
 export const defineConfig = (config: CodeGeniusOptions): CodeGeniusOptions =>
   config;
 
-export function cmdInstaller(cli: CAC, config: CodeGeniusOptions) {
+export async function cmdInstaller(cli: CAC, config: CodeGeniusOptions) {
   const { plugins } = config;
   for (const plugin of plugins) {
     plugin(cli).setup();
   }
 }
+
+export function genScriptConfig(scripts: { [key: string]: string }) {
+  return Object.keys(scripts).map((key) => {
+    return {
+      cmd: key,
+      script: scripts[key],
+      desc: "describe the function of this cmd command",
+    };
+  });
+}
+
+export function syncScripts(
+  pkgScripts: Array<CommandOptions>,
+  configScripts: Array<CommandOptions>,
+) {
+  const mergedScripts = [...configScripts];
+
+  for (const pkgScript of pkgScripts) {
+    const configScript = mergedScripts.find(
+      (itemB) => itemB.cmd === pkgScript.cmd,
+    );
+
+    if (configScript) {
+      if (configScript.script !== pkgScript.script) {
+        configScript.script = pkgScript.script;
+      }
+    } else {
+      mergedScripts.push(pkgScript);
+    }
+  }
+
+  const syncScripts = mergedScripts.filter((configScript) => {
+    return pkgScripts.find((i) => i.cmd === configScript.cmd);
+  });
+
+  return syncScripts;
+}
+
+export const generateScripts = async () => {
+  const pkg = await fsExtra.readJSONSync(
+    path.join(process.cwd(), "package.json"),
+  );
+  let configContent = genScriptConfig(pkg.scripts);
+  const configfile = path.join(process.cwd(), "scripts.config.json");
+  if (fs.existsSync(configfile)) {
+    const { scripts } = await fsExtra.readJSONSync(configfile);
+    configContent = syncScripts(configContent, scripts);
+  }
+  await fsExtra.outputFileSync(
+    configfile,
+    JSON.stringify(
+      {
+        scripts: configContent,
+      },
+      null,
+      2,
+    ),
+  );
+  printInfo("代理脚本 scripts.config.json 已完成同步");
+};

src/helper.ts

@@ -25,6 +25,7 @@ import prettierFormatInstaller, {
 } from "@/command/prettier-format";
 import quantityInstaller, { quantity } from "@/command/quantity";
 import rootInstaller, { root } from "@/command/root";
+import scriptRunInstaller from "@/command/script";
 import templateInstaller, { template } from "@/command/template";
 import { defineConfig } from "@/helper";
 
@@ -45,6 +46,7 @@ const config = defineConfig({
     templateInstaller,
     lighthouseInstaller,
     quantityInstaller,
+    scriptRunInstaller,
   ],
 });
 

src/index.ts

@@ -81,3 +81,19 @@ export interface ImpSortOptions {
 export interface RegistryOptions {
   url: string;
 }
+
+export type CommandOptions = {
+  /**
+   * 指令
+   */
+  cmd: string;
+  /**
+   * 要执行的脚本
+   */
+  script: string;
+
+  /**
+   * 描述
+   */
+  desc: string;
+};