create-for-yeyu 3.2.0 → 3.3.0

package/README.md

@@ -56,6 +56,56 @@ npx create-for-yeyu my-project --template vite
 npx create-for-yeyu my-project --template next
 ```
 
+### 常用选项
+
+```bash
+# 查看版本
+npx create-for-yeyu -v
+npx create-for-yeyu --version
+
+# 查看所有可用模板
+npx create-for-yeyu --list-templates
+
+# 使用默认值快速创建
+# 默认项目名: my-project
+# 默认模板: vite
+npx create-for-yeyu --yes
+
+# 目录已存在时直接覆盖
+npx create-for-yeyu my-project --template next --force
+
+# 关闭欢迎 Banner
+npx create-for-yeyu my-project --template vite --no-banner
+
+# Git 模板跳过 git 初始化
+npx create-for-yeyu my-project --template nest --no-git
+```
+
+### 更新 CLI
+
+```bash
+# 自动检测当前包管理器并更新到最新版本
+create-for-yeyu update
+
+# 指定包管理器更新
+create-for-yeyu update --manager pnpm
+create-for-yeyu update --manager npm
+```
+
+## 命令选项
+
+| 选项 | 说明 |
+| ---- | ---- |
+| `-v, --version` | 显示当前 CLI 版本 |
+| `-h, --help` | 显示帮助信息 |
+| `-t, --template <template>` | 指定模板 |
+| `-f, --force` | 目标目录已存在时直接覆盖 |
+| `-y, --yes` | 尽可能使用默认值，跳过交互 |
+| `--git` | Git 模板直接初始化仓库 |
+| `--no-git` | Git 模板跳过仓库初始化 |
+| `--list-templates` | 输出所有可用模板并退出 |
+| `--no-banner` | 不显示欢迎 Banner |
+
 ## 可用模板
 
 | 模板名称             | 命令参数       | 说明                  |
@@ -97,6 +147,9 @@ pnpm build
 
 # 本地测试运行
 pnpm start
+
+# 查看帮助
+pnpm start -- --help
 ```
 
 ## 项目结构

package/dist/index.js

@@ -1,7 +1,8 @@
 #!/usr/bin/env node
 
 // src/cli.ts
-import { Command } from "commander";
+import { createRequire } from "module";
+import { Command, Option } from "commander";
 import chalk4 from "chalk";
 
 // src/prompts.ts
@@ -461,11 +462,11 @@ async function updatePackageJsonName(targetPath, projectName) {
   try {
     const packageJsonPath = path2.join(targetPath, "package.json");
     const packageJsonContent = await fsExtra.readFile(packageJsonPath, "utf-8");
-    const packageJson = JSON.parse(packageJsonContent);
+    const packageJson2 = JSON.parse(packageJsonContent);
     const newPackageJson = {
       name: projectName
     };
-    for (const [key, value] of Object.entries(packageJson)) {
+    for (const [key, value] of Object.entries(packageJson2)) {
       if (key !== "name") {
         newPackageJson[key] = value;
       }
@@ -554,6 +555,78 @@ async function createNextProject(projectName) {
   }
 }
 
+// src/actions/update-cli.ts
+import { execa as execa4 } from "execa";
+var SUPPORTED_PACKAGE_MANAGERS = ["npm", "pnpm", "yarn", "bun"];
+function getSupportedPackageManagers() {
+  return SUPPORTED_PACKAGE_MANAGERS;
+}
+function isPackageManager(value) {
+  return SUPPORTED_PACKAGE_MANAGERS.includes(value);
+}
+function normalizePackageManager(value) {
+  const normalized = value.trim().toLowerCase();
+  if (!isPackageManager(normalized)) {
+    throw new Error(
+      `Unsupported package manager: ${value}. Use one of: ${SUPPORTED_PACKAGE_MANAGERS.join(", ")}`
+    );
+  }
+  return normalized;
+}
+function detectPackageManager() {
+  const userAgent = process.env.npm_config_user_agent ?? "";
+  if (userAgent.startsWith("pnpm")) {
+    return "pnpm";
+  }
+  if (userAgent.startsWith("yarn")) {
+    return "yarn";
+  }
+  if (userAgent.startsWith("bun")) {
+    return "bun";
+  }
+  return "npm";
+}
+function getUpdateCommand(packageName, packageManager) {
+  switch (packageManager) {
+    case "pnpm":
+      return {
+        command: "pnpm",
+        args: ["add", "-g", `${packageName}@latest`]
+      };
+    case "yarn":
+      return {
+        command: "yarn",
+        args: ["global", "add", `${packageName}@latest`]
+      };
+    case "bun":
+      return {
+        command: "bun",
+        args: ["add", "-g", `${packageName}@latest`]
+      };
+    case "npm":
+    default:
+      return {
+        command: "npm",
+        args: ["install", "-g", `${packageName}@latest`]
+      };
+  }
+}
+async function updateCLI(packageName, preferredManager) {
+  const packageManager = preferredManager ? normalizePackageManager(preferredManager) : detectPackageManager();
+  const { command, args } = getUpdateCommand(packageName, packageManager);
+  logger.info(`Updating ${packageName} with ${packageManager}...`);
+  logger.log("");
+  try {
+    await execa4(command, args, {
+      cwd: process.cwd(),
+      stdio: "inherit"
+    });
+    logger.success(`${packageName} has been updated to the latest version`);
+  } catch (error) {
+    throw error;
+  }
+}
+
 // src/utils/cats.ts
 import os from "os";
 var cats = [
@@ -618,8 +691,22 @@ Today is ${date}`;
 }
 
 // src/cli.ts
-var VERSION = "1.0.0";
-async function executeTemplate(template, projectName, shouldOverwrite) {
+var require2 = createRequire(import.meta.url);
+var packageJson = require2("../package.json");
+var PACKAGE_NAME = packageJson.name;
+var VERSION = packageJson.version;
+var DEFAULT_PROJECT_NAME = "my-project";
+var DEFAULT_TEMPLATE = "vite";
+var AVAILABLE_TEMPLATES = templates.map((template) => template.value);
+function resolveGitOption(argv = process.argv) {
+  const gitIndex = argv.lastIndexOf("--git");
+  const noGitIndex = argv.lastIndexOf("--no-git");
+  if (gitIndex === -1 && noGitIndex === -1) {
+    return void 0;
+  }
+  return gitIndex > noGitIndex;
+}
+async function executeTemplate(template, projectName, shouldOverwrite, options) {
   if (shouldOverwrite) {
     logger.info(`Removing existing directory ${projectName}...`);
     await removeDirectory(projectName);
@@ -629,12 +716,18 @@ async function executeTemplate(template, projectName, shouldOverwrite) {
       logger.error("Template repository not configured");
       process.exit(1);
     }
-    const initGit = await promptInitGit();
+    const initGit = options.git ?? (options.yes ? true : await promptInitGit());
     await cloneRepo(template.repo, projectName, { initGit });
     printSuccessMessage(projectName);
   } else if (template.type === "vite") {
+    if (options.git !== void 0) {
+      logger.warning("`--git` and `--no-git` only apply to Git starter templates");
+    }
     await createViteProject(projectName);
   } else if (template.type === "next") {
+    if (options.git !== void 0) {
+      logger.warning("`--git` and `--no-git` only apply to Git starter templates");
+    }
     await createNextProject(projectName);
   }
 }
@@ -653,32 +746,105 @@ function printBanner() {
   console.log(chalk4.cyan(catSay(getGreetingMessage())));
   console.log();
 }
+function printTemplateList() {
+  logger.log(chalk4.cyan("Available templates:"));
+  logger.log("");
+  for (const template of templates) {
+    logger.log(
+      `  ${chalk4.yellow(template.value.padEnd(14))} ${template.name.padEnd(22)} ${template.description}`
+    );
+  }
+  logger.log("");
+}
+function getDefaultTemplate() {
+  const template = getTemplateByValue(DEFAULT_TEMPLATE);
+  if (!template) {
+    throw new Error(`Default template not found: ${DEFAULT_TEMPLATE}`);
+  }
+  return template;
+}
+async function resolveProjectTarget(projectName, options) {
+  if (!checkDirectoryExists(projectName)) {
+    return {
+      projectName,
+      shouldOverwrite: false
+    };
+  }
+  if (options.force) {
+    return {
+      projectName,
+      shouldOverwrite: true
+    };
+  }
+  if (options.yes) {
+    return {
+      projectName: generateUniqueProjectName(projectName),
+      shouldOverwrite: false
+    };
+  }
+  return resolveProjectName(projectName);
+}
 async function run() {
   const program = new Command();
-  program.name("create-for-yeyu").description("A CLI tool to scaffold projects from templates").version(VERSION).argument("[project-name]", "Project name").option(
-    "-t, --template <template>",
-    "Specify template (nest, evm-dapp, vite, next)"
-  ).action(async (projectName, options) => {
-    printBanner();
-    try {
-      let inputProjectName = projectName;
-      let template;
-      if (!inputProjectName) {
-        inputProjectName = await promptProjectName();
+  program.name(PACKAGE_NAME).description("A CLI tool to scaffold projects from templates").version(VERSION, "-v, --version", "Display the current version").helpOption("-h, --help", "Display help for command").showHelpAfterError().showSuggestionAfterError().configureHelp({
+    sortOptions: true,
+    sortSubcommands: true
+  }).addHelpText(
+    "after",
+    `
+Examples:
+  $ ${PACKAGE_NAME} my-app --template vite
+  $ ${PACKAGE_NAME} my-app --template next-web-app --no-git
+  $ ${PACKAGE_NAME} --list-templates
+  $ ${PACKAGE_NAME} update --manager pnpm
+`
+  ).argument("[project-name]", "Project name").addOption(
+    new Option("-t, --template <template>", "Specify template").choices(
+      AVAILABLE_TEMPLATES
+    )
+  ).option("-f, --force", "Overwrite an existing directory without prompting").option("--git", "Always initialize git when the selected template supports it").option(
+    "--no-git",
+    "Skip git initialization when the selected template supports it"
+  ).option(
+    "-y, --yes",
+    `Use defaults when possible (${DEFAULT_PROJECT_NAME}, ${DEFAULT_TEMPLATE})`
+  ).option("--list-templates", "Print available templates and exit").option("--no-banner", "Disable the welcome banner").action(
+    async (projectName, options) => {
+      if (options.listTemplates) {
+        printTemplateList();
+        return;
       }
-      const { projectName: resolvedName, shouldOverwrite } = await resolveProjectName(inputProjectName);
-      if (options.template) {
-        const foundTemplate = getTemplateByValue(options.template);
-        if (!foundTemplate) {
-          logger.error(`Template not found: ${options.template}`);
-          logger.info("Available templates: nest, evm-dapp, vite, next");
-          process.exit(1);
+      if (options.banner) {
+        printBanner();
+      }
+      try {
+        const gitOption = resolveGitOption(process.argv);
+        const inputProjectName = projectName ?? (options.yes ? DEFAULT_PROJECT_NAME : await promptProjectName());
+        const { projectName: resolvedName, shouldOverwrite } = await resolveProjectTarget(inputProjectName, options);
+        const template = options.template !== void 0 ? getTemplateByValue(options.template) : options.yes ? getDefaultTemplate() : await promptTemplate();
+        if (!template) {
+          throw new Error("Selected template is not available");
         }
-        template = foundTemplate;
-      } else {
-        template = await promptTemplate();
+        await executeTemplate(template, resolvedName, shouldOverwrite, {
+          git: gitOption,
+          yes: options.yes ?? false
+        });
+      } catch (error) {
+        if (error instanceof Error) {
+          logger.error(error.message);
+        }
+        process.exit(1);
       }
-      await executeTemplate(template, resolvedName, shouldOverwrite);
+    }
+  );
+  program.command("update").description(`Update ${PACKAGE_NAME} to the latest version`).addOption(
+    new Option(
+      "-m, --manager <manager>",
+      "Package manager to use for the update"
+    ).choices(getSupportedPackageManagers())
+  ).action(async (options) => {
+    try {
+      await updateCLI(PACKAGE_NAME, options.manager);
     } catch (error) {
       if (error instanceof Error) {
         logger.error(error.message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-for-yeyu",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "A CLI tool to scaffold projects from templates",
   "type": "module",
   "bin": {
@@ -17,24 +17,23 @@
   "author": "yeyu",
   "license": "MIT",
   "dependencies": {
-    "@inquirer/core": "^11.1.1",
-    "@inquirer/prompts": "^7.2.1",
-    "@inquirer/type": "^4.0.3",
+    "@inquirer/core": "^11.1.8",
+    "@inquirer/prompts": "^8.4.1",
+    "@inquirer/type": "^4.0.5",
     "chalk": "^5.3.0",
-    "commander": "^14.0.2",
+    "commander": "^14.0.3",
     "degit": "^2.8.4",
     "execa": "^9.6.1",
-    "fs-extra": "^11.2.0",
-    "ora": "^9.0.0"
+    "fs-extra": "^11.3.4",
+    "ora": "^9.3.0"
   },
   "devDependencies": {
-    "@changesets/cli": "^2.29.8",
-    "@types/chalk": "^2.2.4",
+    "@changesets/cli": "^2.30.0",
     "@types/degit": "^2.8.6",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.11.0",
+    "@types/node": "^25.5.2",
     "tsup": "^8.0.1",
-    "typescript": "^5.3.3"
+    "typescript": "^6.0.2"
   },
   "engines": {
     "node": ">=18"