alvis-cli 1.0.0

package/index.js

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+
+/**
+ * 1. 增加终端标题
+ * 2. 下载仓库
+ * 3. 美化下载仓库的过程
+ * 4. 解析命令行参数
+ * 	4.1 alvis create <app-name> -t xxx -f -i
+ *  4.2 alvis list
+ * 5. 终端输出美化
+ */
+import { useTitle } from "./lib/title.js";
+import { program } from "commander";
+import chalk from "chalk";
+import { listTable } from "./lib/list.js";
+import { createProject } from "./lib/create.js";
+import fs from "fs-extra";
+
+const pkg = fs.readJsonSync(new URL("./package.json", import.meta.url));
+
+program.version(pkg.version, "-v, --version", "alvis-cli版本");
+
+program
+  .name("alvis")
+  .description("一个简单的脚手架工具")
+  .usage("<command> [options]")
+  .on("--help", () => {
+    useTitle("ALVIS");
+    console.log(
+      `\r\n Run ${chalk.cyan(`alvis <command> --help`)} for detailed usage of given command.`
+    );
+  });
+
+// 命令 alvis create
+program
+  .command("create <app-name>")
+  .description("创建项目")
+  .usage("<app-name> [options]")
+  .option("-t, --template [template]", "使用模版创建项目")
+  .option("-f, --force", "强制覆盖本地同名项目")
+  .option("-i, --ignore", "忽略项目相关描述，快速创建项目")
+  .action(createProject);
+
+// 命令 alvis list
+program.command("list").description("列举所有可用的模版").action(listTable);
+
+// 解析命令
+program.parse(process.argv);

package/lib/create.js

@@ -0,0 +1,115 @@
+import chalk from "chalk";
+import logSymbols from "../utils/logSymbols.js";
+import shell from "shelljs";
+import { messages, templateArr } from "../utils/constant.js";
+import {
+  inquirerChoose,
+  inquirerConfirm,
+  inquirerInput
+} from "../utils/inquirer.js";
+import { clone } from "../utils/gitClone.js";
+import fs from "fs-extra";
+import { removeDir, changePackageJson } from "../utils/fs.js";
+
+/**
+ * Alvis create命令执行
+ * @param {*} appName
+ * @param {*} options
+ */
+export async function createProject(appName, options) {
+  // 1. 校验
+  // 1.1 项目名称是否是合法字符校验
+  if (appName.match(/[\u4E00-\u9FFF`~!@#$%&^*[\]()\\;:<.>/?]/g)) {
+    console.log(
+      logSymbols.error,
+      chalk.redBright("对不起,项目名称存在非法字符")
+    );
+    return;
+  }
+  // 1.2 用户是否安装了git
+  if (!shell.which("git")) {
+    console.log(
+      logSymbols.error,
+      chalk.redBright("对不起,运行脚本必须安装git")
+    );
+    return;
+  }
+  // 2. 模版选择（-t xxx）
+  let repository = "";
+  // 2.1 模版存在，则比对输入的名称是否存在对应的仓库模版
+  if (options.template) {
+    const templateName = options.template.trim();
+    const template = templateArr.find((item) => item.name === templateName);
+    if (!template) {
+      console.log(
+        logSymbols.error,
+        `不存在模版${chalk.yellowBright(templateName)}`
+      );
+      console.log(
+        `\r\n 运行${logSymbols.arrow} ${chalk.cyanBright("alvis list")} 查看所有可用模板\r\n`
+      );
+      return;
+    }
+    repository = template.value;
+  } else {
+    // 2.2 模版不存在，则问答式交互，让用户选择一个模版
+    const answer = await inquirerChoose(
+      chalk.blueBright("请选择一个项目模版:"),
+      templateArr
+    );
+    repository = answer;
+  }
+
+  // 3. 是否覆盖已经存在的项目（-f）
+  // 3.1 如果不存在-f，则判断是否有同名项目
+  if (fs.existsSync(appName) && !options.force) {
+    console.log(
+      logSymbols.warning,
+      `已经存在项目文件夹${chalk.yellowBright(appName)}`
+    );
+    // 存在同名项目，则询问用户是否进行删除
+    const answer = await inquirerConfirm(
+      `是否删除文件夹${chalk.yellowBright(appName)}?`
+    );
+    // 3.1.1 删除
+    if (answer) {
+      removeDir(appName);
+    } else {
+      // 3.1.2 不删除则拉取项目失败
+      console.log(
+        logSymbols.error,
+        chalk.redBright(
+          `对不起,项目创建失败,存在同名文件夹,${chalk.yellowBright(appName)}`
+        )
+      );
+    }
+  } else if (fs.existsSync(appName) && options.force) {
+    // 3.2 如果存在-f
+    console.log(
+      logSymbols.warning,
+      `已经存在项目文件夹${chalk.yellowBright(appName)},强制删除`
+    );
+    // 3.2.1 强制删除文件夹以及下面的子文件
+    removeDir(appName);
+  }
+  // 4. 拉取项目
+  try {
+    await clone(repository, appName);
+  } catch (err) {
+    console.log(logSymbols.error, chalk.redBright("对不起,项目拉取失败"));
+  }
+  // 5. -i是否存在
+  // 5.1 存在没有任何问题（不用进行任何操作）
+  // 5.2 不存在
+  if (!options.ignore) {
+    // 5.2.1 交互式，让用户手动输入需要更改的内容，对package.json文件进行修改
+    const answer = {};
+    for (const item of messages) {
+      const res = await inquirerInput(item.message, item.validate);
+      answer[item.name] = res;
+    }
+
+    // 写入json文件
+    await changePackageJson(appName, answer);
+  }
+}

package/lib/list.js

@@ -0,0 +1,30 @@
+import { templateArr } from "../utils/constant.js";
+import chalk from "chalk";
+import { table } from "table";
+import logSymbols from "../utils/logSymbols.js";
+/**
+ * list 命令
+ * 表格的格式对list模版进行输出
+ */
+export function listTable() {
+  const data = templateArr.map((item) => [
+    chalk.greenBright(item.name),
+    chalk.blueBright(item.value),
+    chalk.yellowBright(item.desc)
+  ]);
+
+  data.unshift([
+    chalk.greenBright("模版名称"),
+    chalk.blueBright("模版仓库"),
+    chalk.yellowBright("模版描述")
+  ]);
+
+  const config = {
+    header: {
+      alignment: "center",
+      content: chalk.yellowBright(logSymbols.star, "所有可用的模板")
+    }
+  };
+
+  console.log(table(data, config));
+}

package/lib/title.js

@@ -0,0 +1,28 @@
+import figlet from "figlet";
+import chalk from "chalk";
+
+function gradient(text) {
+  const gradientColors = [
+    "#FF6B6B",
+    "#FF8E6B",
+    "#FFB36B",
+    "#FFD86B",
+    "#EFFF6B",
+    "#B8FF6B"
+  ];
+  return text
+    .split("")
+    .map((char, i) => {
+      const color =
+        gradientColors[
+          Math.floor((i / text.length) * (gradientColors.length - 1))
+        ];
+      return chalk.hex(color)(char);
+    })
+    .join("");
+}
+
+export function useTitle(message) {
+  const text = figlet.textSync(message);
+  console.log(gradient(text));
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "alvis-cli",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "bin": {
+    "alvis": "./index.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "packageManager": "pnpm@10.28.0",
+  "dependencies": {
+    "@inquirer/prompts": "^8.2.0",
+    "chalk": "^5.6.2",
+    "commander": "^14.0.2",
+    "download-git-repo": "^3.0.2",
+    "figlet": "^1.9.4",
+    "fs-extra": "^11.3.3",
+    "ora": "^9.0.0",
+    "shelljs": "^0.10.0",
+    "table": "^6.9.0"
+  },
+  "files": [
+    "lib/",
+    "utils/",
+    "index.js"
+  ]
+}

package/utils/constant.js

@@ -0,0 +1,47 @@
+export const templateArr = [
+  {
+    name: "webpack-template",
+    value: "yingside/webpack-template",
+    desc: "基于webpack5自定义初始化vue3项目模板"
+  },
+  {
+    name: "vue-cli-template",
+    value: "yingside/vue-cli-template",
+    desc: "基于vue-cli自定义vue3项目模板"
+  },
+  {
+    name: "vite-template",
+    value: "yingside/vite-template",
+    desc: "基于vite的vue3 + 前端工具链项目模板"
+  },
+  {
+    name: "vue-admin-box",
+    value: "cmdparkour/vue-admin-box",
+    desc: "cmdparkour vue3 + vite中后台项目模板"
+  }
+];
+
+export const messages = [
+  {
+    message: "请输入项目名称:",
+    name: "name",
+    validate(val) {
+      if (val.match(/[\u4E00-\u9FFF`~!@#$%&^*[\]()\\;:<.>/?]/g)) {
+        return "项目名称存在非法字符";
+      }
+      return true;
+    }
+  },
+  {
+    message: "请输入项目关键词(,分割):",
+    name: "keywords"
+  },
+  {
+    message: "请输入项目描述:",
+    name: "description"
+  },
+  {
+    message: "请输入作者名称:",
+    name: "author"
+  }
+];

package/utils/fs.js

@@ -0,0 +1,47 @@
+import chalk from "chalk";
+import fs from "fs-extra";
+import ora from "ora";
+import path from "path";
+
+const pwd = process.cwd();
+
+const resolveApp = (relativePath) => path.resolve(pwd, relativePath);
+
+export function removeDir(dir) {
+  const spinner = ora("正在删除文件夹....").start();
+
+  try {
+    fs.rmSync(resolveApp(dir), {
+      recursive: true
+    });
+
+    spinner.succeed(chalk.greenBright(`删除文件夹${chalk.cyan(dir)}成功`));
+  } catch (err) {
+    spinner.fail(chalk.redBright(`删除文件夹${chalk.cyan(dir)}失败`));
+    console.log(err);
+  }
+}
+
+export async function changePackageJson(name, info) {
+  try {
+    const pkg = await fs.readJson(resolveApp(`${name}/package.json`));
+
+    Object.keys(info).forEach((item) => {
+      if (item === "name") {
+        pkg[item] = info[item] && info[item].trim() ? info[item].trim() : name;
+      } else if (item === "keywords" && info[item] && info[item].trim()) {
+        pkg[item] = info[item].split(",");
+      } else if (info[item] && info[item].trim()) {
+        pkg[item] = info[item];
+      }
+    });
+
+    await fs.writeJson(resolveApp(`${name}/package.json`), pkg, { spaces: 2 });
+  } catch (err) {
+    console.log(
+      logSymbols.error,
+      chalk.red("对不起,修改自定义package.json失败,请手动修改")
+    );
+    console.log(err);
+  }
+}

package/utils/gitClone.js

@@ -0,0 +1,19 @@
+import download from "download-git-repo";
+import ora from "ora";
+import chalk from "chalk";
+
+export function clone(remote, name, options = false) {
+  const spinner = ora("正在拉取项目....").start();
+  return new Promise((resolve, reject) => {
+    download(remote, name, options, (err) => {
+      if (err) {
+        spinner.fail(chalk.red(err));
+        reject(err);
+        return;
+      }
+
+      spinner.succeed(chalk.green("项目拉取成功"));
+      resolve();
+    });
+  });
+}

package/utils/inquirer.js

@@ -0,0 +1,22 @@
+import { select, confirm, input } from "@inquirer/prompts";
+
+export async function inquirerChoose(message, choices) {
+  return await select({
+    message,
+    choices
+  });
+}
+
+export async function inquirerConfirm(message) {
+  return await confirm({
+    message,
+    default: "y"
+  });
+}
+
+export async function inquirerInput(message, validate) {
+  return await input({
+    message,
+    validate
+  });
+}

package/utils/logSymbols.js

@@ -0,0 +1,44 @@
+import chalk from "chalk";
+
+/**
+ * 检查终端是否支持unicode
+ * @returns
+ */
+export function isUnicodeSupported() {
+  if (process.platform !== "win32") {
+    return process.env.TERM !== "linux"; // Linux console (kernel)
+  }
+
+  return (
+    Boolean(process.env.WT_SESSION) || // 是否是windows终端
+    Boolean(process.env.TERMINUS_SUBLIME) || // 是否Terminus (<0.2.27)
+    process.env.ConEmuTask === "{cmd::Cmder}" || // ConEmu and cmder
+    process.env.TERM_PROGRAM === "Terminus-Sublime" ||
+    process.env.TERM_PROGRAM === "vscode" ||
+    process.env.TERM === "xterm-256color" ||
+    process.env.TERM === "alacritty" ||
+    process.env.TERMINAL_EMULATOR === "JetBrains-JediTerm"
+  );
+}
+
+const main = {
+  info: chalk.blue("ℹ"),
+  success: chalk.green("✔"),
+  warning: chalk.yellow("⚠"),
+  error: chalk.red("✖"),
+  arrow: chalk.yellow("➦"),
+  star: chalk.cyan("✵")
+};
+
+const fallback = {
+  info: chalk.blue("i"),
+  success: chalk.green("√"),
+  warning: chalk.yellow("‼"),
+  error: chalk.red("×"),
+  arrow: chalk.yellow("->"),
+  star: chalk.cyan("*")
+};
+
+const logSymbols = isUnicodeSupported() ? main : fallback;
+
+export default logSymbols;