nut-generator-cli 1.0.1

package/REDAME.MD

@@ -0,0 +1,3 @@
+# NUT-CLI
+
+快速创建 wepack/vite 工程化模板实例

package/bin/nut.js

@@ -0,0 +1,53 @@
+#!/usr/bin/env node
+import figlet from "figlet";
+import chalk from "chalk";
+import { templates } from "../constants.js";
+import initAction from "../initAction.js";
+import { program } from "commander";
+import { readFile } from 'fs/promises';
+
+// es-module 默认不支持读取json文件
+// 方法一
+// const pkg = JSON.parse(
+//   await readFile(new URL("../package.json", import.meta.url))
+// )
+
+// 方法二
+import { createRequire } from "module";
+const require = createRequire(import.meta.url);
+const pkg = require('../package.json');
+
+// 方法三：使用插件fs-extra的api来读取json
+
+program.version(pkg.version, "-v, --version");
+
+program.name("nut")
+  .description(chalk.cyan("坚果 一个简单的脚手架工具"))
+  .usage("<command> [options]")
+  .on("--help", () => {
+    console.log("\r\n" + chalk.cyan(figlet.textSync("Nut Present", {
+      font: "Standard",
+      horizontalLayout: "default",
+      verticalLayout: "default",
+      width: 80,
+      whitespaceBreak: true
+    })));
+  })
+
+program.command("create <app-name>")
+  .description("create a project")
+  .option("-t --template [template]", "输入模板名称创建项目")
+  .option("-f --force", "强制覆盖本地同名项目")
+  .option("-i --ignore", "忽略项目相关描述，快速创建项目")
+  .action(initAction);
+
+program.command("list")
+  .description("查看所有可用的模板")
+  .action(() => {
+    console.log(chalk.bgCyanBright("所有可用模板："));
+    templates.forEach((item, index) => {
+      console.log(`${index + 1}. ${chalk.cyan(item.name)} ${item.desc}`);
+    })
+  })
+
+program.parse(process.argv);

package/build/release.sh

@@ -0,0 +1,42 @@
+#! /usr/bin/env sh
+# 告诉脚本在任何命令出错的时候立即退出。这样可以确保在脚本执行过程中遇到错误时立即停止
+set -e
+# 输出提示信息
+echo "输入新发布的版本号:"
+# 等待用户在终端输入，输入的内容将赋值给变量 VERSION
+read VERSION
+# 输出信息并且让用户输入信息
+# -p 选项用于在输出前显示提示信息， -n1 选项表示只接受一个字符的输入
+read -p "确认发布 $VERSION ? (y/n)" -n1
+
+# echo "\r\n----$VERSION----$REPLY\r\n"
+# 直接输出一个空行
+echo
+
+# if []是直接判断 if [[]]是模糊判断
+if [[ $REPLY =~ ^[Yy]$ ]];
+then
+  if [[ `git status --porcelain` ]]; # 如果有未提交的文件
+  then
+    echo "\r\n---工作目录不干净，需要提交---\r\n"
+    git add -A
+    git commit -m "[commit]: $VERSION" # 提交版本信息log
+  else
+    echo "\r\n---工作目录没有任何需要提交的内容，不建议生产新的版本---\r\n"
+    exit 1
+  fi
+
+  # 修改package.json中的版本号
+  npm version $VERSION --message "[release]: $VERSION"
+
+  # 提交修改到远程仓库main分支
+  git push origin main
+
+  # 提交tag到仓库
+  git push origin refs/tags/v$VERSION
+
+  # 发布到npm
+  npm publish
+else
+  echo "发布取消"
+fi

package/constants.js

@@ -0,0 +1,32 @@
+export const templates = [
+  {
+    name: "webpack-template",
+    value: "yingside/webpack-template",
+    desc: "基于webpack5自定义初始化vue3项目模板"
+  },
+  {
+    name: "vite-template",
+    value: "yingside/vite-template",
+    desc: "基于vite的vue3 + 前端工具链项目模板"
+  },
+  {
+    name: "vue-cli-template",
+    value: "yingside/vue-cli-template",
+    desc: "基于vue-cli自定义初始化vue3项目模板"
+  }
+];
+
+export const message = [
+  {
+    message: "请输入作者",
+    name: "author"
+  },
+  {
+    message: "请输入项目关键词（，分割）",
+    name: "keywords"
+  },
+  {
+    message: "请输入项目描述",
+    name: "description"
+  }
+]

package/gitClone.js

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

package/initAction.js

@@ -0,0 +1,87 @@
+import clone from "./gitClone.js";
+import logSymbols from "log-symbols";
+import shell from "shelljs";
+import chalk from "chalk";
+import figlet from "figlet";
+import fs from "fs-extra";
+import { templates, message } from "./constants.js";
+import { inquirerConfirm, inquirerChoose, inquirerInputs } from './interactive.js';
+import { removeDir, changePackageJson, npmInstall } from "./utils.js";
+
+const initAction = async (name, option) => {
+  // 检测用户是否安装了git
+  if (!shell.which("git")) {
+    console.log(logSymbols.error, chalk.red("必须安装git后才能运行脚本！"));
+    shell.exit(1);
+  }
+
+  let repository = '';
+  if (option.template) {
+    const template = templates.find(item => item.name === option.template);
+    if (!template) {
+      console.log(logSymbols.error, chalk.red(`不存在模板${chalk.yellow(option.template)}`));
+      console.log(`\r\n 可输入命令 ${chalk.cyan("nut list")} 查看模板列表`);
+      return;
+    }
+    repository = template.value;
+  } else {
+    // 选择模板
+    const answer = await inquirerChoose("请选择一个项目模板", templates);
+    repository = answer.choose;
+  }
+
+  // 验证项目名称是否符合规范
+  if (name.match(/[\u4E00-\u9FFF`~!@#$%&^*[\]()\\;:<.>/?]/g)) {
+    console.log(logSymbols.error, chalk.red("项目名称存在非法字符！"));
+    return; 
+  }
+
+  // 验证是否存在同名文件夹
+  if(fs.existsSync(name) && !option.force) {
+    console.log(logSymbols.warning, `检测已存在项目文件夹：${chalk.yellow(name)}`);
+    const answer = await inquirerConfirm("是否进行删除?");
+    if (answer.confirm) {
+      await removeDir(name);
+    } else {
+      console.log(logSymbols.error, chalk.red("项目创建失败，存在同名文件夹！"));
+      return;
+    }
+  } else if (fs.existsSync(name) && option.force) {
+    await removeDir(name);
+  }
+
+  // 拉取模板
+  try {
+    await clone(repository, name);
+  } catch (err) {
+    console.log(logSymbols.error, chalk.red("项目创建失败！"));
+    console.log("🚀 ~ initAction ~ err:", err);
+    shell.exit(1);
+  }
+
+  // 写入项目信息
+  let resMes;
+  if (!option.ignore) {
+    resMes = await inquirerInputs(message);
+  }
+  await changePackageJson(name, resMes, !option.ignore);
+
+  // 是否自动安装依赖
+  const answer = await inquirerConfirm("是否自动安装依赖?");
+  if (answer.confirm) {
+    npmInstall(name);
+  }
+  
+  // 底部展示信息
+  console.log("\r\n" + chalk.cyan(figlet.textSync("welcome  to  NUT", {
+    font: "Standard",
+    horizontalLayout: "default",
+    verticalLayout: "default",
+    width: 80,
+    whitespaceBreak: true
+  })));
+
+  console.log(`\r\n Run ${chalk.cyan("nut <command> --help")} for detailed usage of given command.`);
+}
+
+export default initAction;

package/interactive.js

@@ -0,0 +1,29 @@
+import inquirer from "inquirer";
+
+export const inquirerConfirm = async (message) => {
+  const answer = await inquirer.prompt({
+    type: "confirm",
+    name: "confirm",
+    message
+  });
+  return answer;
+}
+
+export const inquirerChoose = async (message, choices, type = 'rawlist') => {
+  const answer = await inquirer.prompt({
+    type,
+    name: "choose",
+    message,
+    choices
+  });
+  return answer;
+}
+
+export const inquirerInputs = async (message) => {
+  const answer = await inquirer.prompt(message.map((item) => ({
+    type: "input",
+    name: item.name,
+    message: item.message
+  })));
+  return answer;
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "nut-generator-cli",
+  "version": "1.0.1",
+  "description": "",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "release": "sh build/release.sh"
+  },
+  "bin": {
+    "nut": "./bin/nut.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^14.0.3",
+    "download-git-repo": "^3.0.2",
+    "figlet": "^1.10.0",
+    "fs-extra": "^11.3.4",
+    "inquirer": "^13.3.0",
+    "log-symbols": "^7.0.1",
+    "ora": "^9.3.0",
+    "shelljs": "^0.10.0"
+  }
+}

package/utils.js

@@ -0,0 +1,61 @@
+import fs from "fs-extra";
+import ora from "ora";
+import chalk from "chalk";
+import path from "path";
+import shell from "shelljs";
+import logSymbols from "log-symbols";
+
+const appDirectory = fs.realpathSync(process.cwd());
+const resolveApp = (relativePath) => path.resolve(appDirectory, relativePath);
+
+// 删除文件夹
+export async function removeDir(dir) {
+  const spinner = ora({
+    text: `正在删除文件夹${chalk.cyan(dir)}`,
+    color: "yellow"
+  }).start();
+
+  try {
+    await fs.remove(resolveApp(dir));
+    spinner.succeed(chalk.green(`删除文件夹 ${chalk.yellow(dir)} 成功`));
+  } catch(err) {
+    spinner.fail(chalk.red(`删除文件夹 ${chalk.yellow(dir)} 失败`));
+    console.log(err);
+    return;
+  }
+}
+
+export async function changePackageJson(name, info, isIgnore) {
+  try {
+    const pkg = await fs.readJson(resolveApp(`${name}/package.json`));
+    pkg.name = name;
+    if (isIgnore) {
+      Object.keys(info).forEach((item) => {
+        if (item === "keywords") {
+          if (info[item] && info[item].trim()) {
+            pkg[item] = info[item].split(",");
+          } else {
+            pkg[item] = [];
+          }
+        } else {
+          pkg[item] = info[item];
+        }
+      });
+    }
+    await fs.writeJson(resolveApp(`${name}/package.json`), pkg, { spaces: 2 });
+  } catch (err) {
+    console.log(logSymbols.warning, chalk.yellow(`自定义修改信息失败！可以去 ${name}/package.json 手动修改`));
+    console.log(err);
+  }
+}
+
+export function npmInstall(dir) {
+  const spinner = ora("正在安装依赖......").start();
+  if (shell.exec(`cd ${shell.pwd()}/${dir} && npm install --force -d`).code !== 0) {
+    console.log(
+      logSymbols.warning, 
+      chalk.yellow(`自定义修改信息失败！可以去 ${name}/package.json 手动修改`)
+    );
+  }
+  spinner.succeed(chalk.green("~~~依赖安装成功~~~"));
+}