@wagq/wa-cli 0.1.0

package/README.md

@@ -0,0 +1,19 @@
+# cli 工具
+
+使用方式 全局安装后 可使用 wa [命令]
+
+- 初始化项目
+  wa init
+
+- 启动本地服务
+  wa server [path]
+  参数
+  -P 指定端口
+
+- 转换 xlsx 文件为多语言配置
+  wa xlsx2Config [path] [name] [ext]
+  参数
+
+  - path 文件路径
+  - name 被转换目标文件名称
+  - ext 转换后文件扩展名 json 或 ts

package/bin/wa.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+const { program } = require("commander");
+
+const packageJson = require("../package.json");
+const init = require("../lib/init/index.js");
+const command = require("../config/command.js");
+
+program.version(packageJson.version);
+
+command.forEach((item) => {
+  const c = program
+    .command(item.name)
+    .alias(item.alias)
+    .description(item.description);
+  if (item.options) {
+    Object.keys(item.options).forEach((key) => {
+      c.option(item.options[key], key);
+    });
+  }
+  c.action(item.action);
+});
+
+program.parse(process.argv);

package/config/command.js

@@ -0,0 +1,65 @@
+const init = require("../lib/init");
+const server = require("../lib/server");
+const xlsx2Config = require("../lib/locale/xlsx2Config");
+
+const command = [
+  {
+    name: "init",
+    alias: "i",
+    description: "项目初始化工具",
+    action: (name) => {
+      init(name);
+    },
+  },
+  {
+    name: "server [path]",
+    alias: "s",
+    description: "启动本地服务",
+    action: server,
+    options: {
+      端口: "-P, --port <port>",
+      https: "-S, --https <boolean>",
+    },
+    positional: [
+      {
+        key: "path",
+        option: {
+          default: "dist",
+          describe: "文件路径",
+          type: "string",
+        },
+      },
+    ],
+  },
+  {
+    name: "xlsx2Config [path] [name] [ext]",
+    alias: "l",
+    description: "xlsx文件转多语言配置",
+    positional: [
+      {
+        key: "path",
+        option: {
+          describe: "文件路径",
+          type: "string",
+        },
+      },
+      {
+        key: "name",
+        option: {
+          describe: "xlsx文件名称",
+          type: "string",
+        },
+      },
+      {
+        key: "ext",
+        option: {
+          describe: "转换文件格式(ts or json)",
+          type: "string",
+        },
+      },
+    ],
+    action: xlsx2Config,
+  },
+];
+
+module.exports = command;

package/config/lib.js

@@ -0,0 +1,18 @@
+const modeOptions = ["pnpm", "yarn", "npm"];
+
+const libBin = {
+  pnpm: "pnpm i",
+  yarn: "yarn",
+  npm: "npm i",
+};
+
+const libQuestions = () => [
+  {
+    type: "list",
+    name: "selectMode",
+    message: `请选择依赖安装方式`,
+    choices: modeOptions,
+  },
+];
+
+module.exports = { libQuestions, libBin };

package/lib/clone/index.js

@@ -0,0 +1,23 @@
+const { promisify } = require("util");
+const ora = require("ora");
+const chalk = require("chalk");
+const download = promisify(require("download-git-repo"));
+
+const clone = async function (repo, dir, opotions = {}) {
+  const process = ora(`开始下载 ${chalk.blue(repo)}`);
+  process.start();
+  process.color = "yellow";
+  process.text = `正在下载..... ${chalk.yellow(repo)} `;
+
+  try {
+    await download(repo, dir, opotions);
+    process.color = "green";
+    process.succeed("下载成功");
+  } catch (error) {
+    process.color = "red";
+    console.log(error);
+    process.fail("下载失败");
+  }
+};
+
+module.exports = clone;

package/lib/init/after.js

@@ -0,0 +1,86 @@
+const fs = require("fs");
+const path = require("path");
+const log = require("../../utils/log");
+const { execSync } = require("child_process");
+const ora = require("ora");
+const { libQuestions, libBin } = require("../../config/lib");
+const Prompt = require("inquirer");
+
+const cmdPath = process.cwd();
+
+const changeProjectInfo = async (packageName) => {
+  const cwd = process.cwd();
+  const packagePath = path.join(`${cwd}/${packageName}`, "package.json");
+  const packageContent = fs.readFileSync(packagePath, "utf-8");
+  const packageInfo = JSON.parse(packageContent);
+  packageInfo.name = packageName;
+  const readmePath = path.join(`${cwd}/${packageName}`, "README.md");
+  const readmeContent = fs.readFileSync(readmePath, "utf-8");
+  const newReadmeContent = readmeContent.replace("<%= project %>", packageName);
+
+  await fs.writeFileSync(
+    packagePath,
+    JSON.stringify(packageInfo, null, "  ") + "\n"
+  );
+  await fs.writeFileSync(readmePath, newReadmeContent);
+};
+
+const initGit = async (packageName) => {
+  const execConfig = { cwd: `${cmdPath}/${packageName}` };
+  await execSync("git init -b main", execConfig);
+};
+
+const initHusky = (packageName) => {
+  const execConfig = { cwd: `${cmdPath}/${packageName}` };
+  log.info("初始化Husky中...");
+  try {
+    execSync("npx --no-install husky install", {
+      cwd: `${cmdPath}/${packageName}`,
+    });
+  } catch (error) {
+    log.error("Husky 命令安装失败: \n" + error);
+  }
+  try {
+    execSync(
+      'npx --no-install husky add .husky/pre-commit "npx lint-staged"',
+      execConfig
+    );
+    execSync(
+      "npx --no-install husky add .husky/commit-msg  'npx --no -- commitlint --edit ${1}'",
+      execConfig
+    );
+    log.info("Husky 初始化完成");
+    execSync(`code ${packageName}`, { cwd: cmdPath });
+  } catch (error) {
+    log.error("Husky 命令写入失败: \n" + error);
+  }
+};
+
+const firstCommit = async (packageName) => {
+  const execConfig = { cwd: `${cmdPath}/${packageName}` };
+  await execSync("git add .", execConfig);
+  await execSync("git commit -m 'feat: 初始化项目' --no-verify", execConfig);
+};
+
+const installLibrary = async (packageName) => {
+  const { selectMode } = await Prompt.default.prompt(libQuestions());
+  const bin = libBin[selectMode];
+  const process = ora("安装依赖中...");
+  process.start();
+  process.color = "green";
+  await execSync(bin, {
+    cwd: `${cmdPath}/${packageName}`,
+  });
+  process.succeed("依赖安装完成");
+};
+
+const after = async (name) => {
+  const packageName = name;
+  changeProjectInfo(name);
+  await initGit(packageName);
+  await installLibrary(packageName);
+  await initHusky(packageName);
+  await firstCommit(packageName);
+};
+
+module.exports = after;

package/lib/init/check.js

@@ -0,0 +1,21 @@
+const glob = require("glob");
+const path = require("path");
+const update = require("../update");
+
+const check = async (name) => {
+  let hasProject = false;
+  const files = await glob.sync("*", { dot: true });
+
+  hasProject = files.some((f) => {
+    return f === name;
+  });
+
+  await update();
+
+  if (!hasProject) {
+    return Promise.resolve();
+  }
+  return Promise.reject("项目已存在,创建失败");
+};
+
+module.exports = check;

package/lib/init/index.js

@@ -0,0 +1,64 @@
+const Prompt = require("inquirer");
+
+const clone = require("../clone/index.js");
+const check = require("./check.js");
+const log = require("../../utils/log.js");
+const after = require("./after.js");
+const { execSync } = require("child_process");
+
+const urls = {
+  vue单页面后台: { remote: "sdmu-gaoqi/vite-vue" },
+  vue多页面项目: { remote: "sdmu-gaoqi/vite-vue-multiple" },
+  vite: { bin: "npm create vite@latest" },
+  "vscode插件-vue版": { remote: "sdmu-gaoqi/vscode-plugin#vue" },
+  "vscode插件-react版": { remote: "sdmu-gaoqi/vscode-plugin#react" },
+};
+const modeOptions = Object.keys(urls);
+
+const initQuestions = () => [
+  {
+    type: "list",
+    name: "selectMode",
+    message: `请选择模板`,
+    choices: modeOptions,
+  },
+  {
+    type: "input",
+    name: "name",
+    message: `请输入项目名`,
+    choices: modeOptions,
+  },
+];
+
+const init = async () => {
+  try {
+    const { name, selectMode } = await Prompt.default.prompt(initQuestions());
+    if (name) {
+      const { remote, bin } = urls?.[selectMode];
+      await check(name);
+
+      const initByVite = bin;
+
+      if (initByVite) {
+        log.info("准备从vite创建");
+        execSync(`${bin} ${name}`, {
+          stdio: "inherit",
+          cwd: process.cwd(),
+          shell: true,
+        });
+      } else {
+        if (!remote) {
+          throw new Error(`未找到${selectMode}模板`);
+        }
+        await clone(remote, name);
+        await after(name, selectMode);
+      }
+    } else {
+      log.info("程序提前结束");
+    }
+  } catch (error) {
+    log.error(error);
+  }
+};
+
+module.exports = init;

package/lib/locale/xlsx2Config.js

@@ -0,0 +1,36 @@
+const xlsx = require("xlsx");
+const fs = require("fs");
+
+const xlsx2Config = async (path, name, ext) => {
+  try {
+    const file = xlsx.readFile(`${path}/${name}`);
+    const sheetNames = file.SheetNames; // 返回 ['sheet1', 'sheet2']
+    const l10n = {};
+    for (const sheetName of sheetNames) {
+      const jsonData = xlsx.utils.sheet_to_json(file.Sheets[sheetName]);
+      const fields = Object.keys(jsonData[0]);
+      jsonData.forEach((word) => {
+        // 0 是 key
+        for (let index = 1; index < fields.length; index++) {
+          const field = fields[index];
+          if (!l10n[field]) {
+            l10n[field] = {};
+          }
+          l10n[field][word.key] =
+            String(word[field || "zh-CN"] || word.key) || "";
+        }
+      });
+
+      Object.keys(l10n).forEach((key) => {
+        const content = JSON.stringify(l10n[key], null, 2);
+        const str = `export default ${content}\n`;
+        const writePath = `${path}/${key}.${ext}`;
+        fs.writeFileSync(writePath, ext === "json" ? content : str, "utf8");
+      });
+    }
+  } catch (err) {
+    console.log(err, "文件转换失败");
+  }
+};
+
+module.exports = xlsx2Config;

package/lib/server/index.js

@@ -0,0 +1,24 @@
+const { spawn, exec, execSync } = require("child_process");
+const fs = require("fs");
+// minimist(process.argv.slice(2))
+
+const server = (filePath, argv) => {
+  const https = argv.https ?? false;
+  const port = argv.port ?? 3000;
+
+  try {
+    const child = spawn(
+      "http-server",
+      [filePath, "-p", port, https ? `-S -C cert.pem -K key.pem` : ""],
+      {
+        cwd: process.cwd(),
+        stdio: "inherit",
+      }
+    );
+    child.on("close", (code) => process.exit(code));
+  } catch (error) {
+    console.log(error);
+  }
+};
+
+module.exports = server;

package/lib/update/index.js

@@ -0,0 +1,50 @@
+const { exec } = require("child_process");
+const config = require("../../package.json");
+const { compareVersions } = require("compare-versions");
+const log = require("../../utils/log");
+const ora = require("ora");
+
+module.exports = (argv) => {
+  const cmd = `npm view ${config.name} version --json --registry=http://registry.npmjs.org`;
+  const shellUpdate = argv && argv._ && argv._[0] === "update";
+  return new Promise((resolve, reject) => {
+    exec(cmd, (error, info) => {
+      if (error) {
+        reject();
+        log.error(`${config.name} 信息获取失败， 请尝试在命令前加入sudo`);
+      }
+      info = info.trim();
+      const version = info.substring(1, info.length - 1);
+      // 1: 当前版本大于等于最新版本 0: 当前版本等于最新版本 -1: 当前版本小于最新版本
+      const compareResult = compareVersions(config.version, version);
+      if (compareResult == 1 || compareResult == 0) {
+        if (shellUpdate) {
+          // shell 执行的,给个信息提示,引入执行不需要
+          log.info(`${config.name}@${config.version} 已最新`);
+        }
+
+        resolve({
+          needUpdate: false,
+        });
+      } else {
+        log.warn(`${config.name} 需要更新`);
+        const spinner = ora(`${config.name} 更新中......`).start();
+        const run = `npm install -g ${config.name}@latest --registry=http://registry.npmjs.org`;
+        exec(run, (err) => {
+          if (err) {
+            reject();
+            log.error(err);
+          }
+          if (!shellUpdate) {
+            log.info(`${config.name}版本更新,当前版本: ${version}`);
+          } else {
+            spinner.succeed(`${config.name} 更新结束,当前版本: ${version}`);
+          }
+          resolve({
+            needUpdate: true,
+          });
+        });
+      }
+    });
+  });
+};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@wagq/wa-cli",
+  "version": "0.1.0",
+  "description": "wa的脚手架",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "pub": "npm publish --access public"
+  },
+  "keywords": [
+    "wa的脚手架"
+  ],
+  "bin": {
+    "wa": "bin/wa.js"
+  },
+  "author": "GQ-og",
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "chalk": "^3.0.0",
+    "child_process": "^1.0.2",
+    "commander": "^13.1.0",
+    "compare-versions": "^6.1.1",
+    "download-git-repo": "^3.0.2",
+    "glob": "^11.0.1",
+    "inquirer": "^12.4.1",
+    "ora": "^4.0.3"
+  },
+  "devDependencies": {
+    "http-server": "^14.1.1",
+    "minimist": "^1.2.8",
+    "xlsx": "^0.18.5"
+  },
+  "directories": {
+    "lib": "lib"
+  }
+}

package/publish.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -e
+# 修改npm源地址
+npm config get registry
+npm config set registry=http://registry.npmjs.org
+# 登陆输入自己的npm账号和密码，还有邮箱
+echo '登录'
+npm login
+echo "发布中..."
+npm publish
+# 改回npm源地址
+npm config set registry=https://registry.npm.taobao.org
+echo -e "\n发布成功\n"
+exit

package/utils/log.js

@@ -0,0 +1,32 @@
+const chalk = require("chalk");
+
+const log = {
+  info(msg) {
+    msg = `\n[Info]: ${msg}\n`;
+    process.stdout.write(chalk.green(msg));
+  },
+  warn(msg) {
+    msg = `\n[Warn]: ${msg}\n`;
+    process.stdout.write(chalk.yellow(msg));
+  },
+  loading(msg) {
+    msg = `\n[Loading]: ${msg}\n`;
+    process.stdout.write(chalk.white(msg));
+  },
+  error(err) {
+    if (!(err instanceof Error)) {
+      err.message && (err = err.message);
+      err = new Error(err.message || err.toString());
+    }
+    if (exports.alert) {
+      err.message += "\u0007";
+    }
+
+    const msg = `\n[Error]: ${err.message}\n`;
+    process.stdout.write(chalk.red(msg));
+
+    process.exit(1);
+  },
+};
+
+module.exports = log;