zhixuan-plugin-cli 1.0.0

package/bin/index.js

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+
+const program = require('commander');
+const chalk = require('chalk');
+const { version } = require('../package.json');
+
+program
+  .version(version, '-v, --version')
+  .usage('<command> [options]');
+
+// 注册 create 命令
+program
+  .command('create <project-name>')
+  .description('创建一个新的Vue2项目')
+  .option('-t, --template <template>', '指定模板类型 (default/ts/multi)')
+  .action((projectName, options) => {
+    require('../commands/create')(projectName, options);
+  });
+
+// 注册 config 命令
+program
+  .command('config')
+  .description('管理脚手架配置')
+  .option('-s, --set <key> <value>', '设置配置')
+  .option('-g, --get <key>', '获取配置')
+  .option('-l, --list', '列出所有配置')
+  .action((options) => {
+    require('../commands/config')(options);
+  });
+
+// 处理未知命令
+program
+  .arguments('<command>')
+  .action((cmd) => {
+    program.outputHelp();
+    console.log();
+    console.log(chalk.red(`  未知命令 ${chalk.yellow(cmd)}`));
+    console.log();
+  });
+
+program.parse(process.argv);
+
+// 如果没有参数，显示帮助
+if (!process.argv.slice(2).length) {
+  program.outputHelp();
+}

package/commands/config.js

@@ -0,0 +1,29 @@
+const Conf = require('conf');
+const chalk = require('chalk');
+
+const config = new Conf({
+  projectName: 'zhixuan-plugin-cli'
+});
+
+module.exports = function (options) {
+  if (options.list) {
+    console.log(chalk.cyan('当前配置:'));
+    console.log(config.store);
+    return;
+  }
+
+  if (options.get) {
+    const value = config.get(options.get);
+    console.log(chalk.cyan(`${options.get}=${value}`));
+    return;
+  }
+
+  if (options.set) {
+    const [key, value] = options.set;
+    config.set(key, value);
+    console.log(chalk.green(`设置 ${key}=${value} 成功`));
+    return;
+  }
+
+  console.log(chalk.yellow('请指定操作参数'));
+};

package/commands/create.js

@@ -0,0 +1,70 @@
+const chalk = require('chalk');
+const inquirer = require('inquirer');
+const downloadTemplate = require('../utils/download');
+const fs = require('fs-extra');
+const path = require('path');
+
+module.exports = async function create(projectName, options) {
+  console.log();
+  console.log(chalk.cyan(`✨  正在创建项目: ${projectName}`));
+
+  // 检查目录是否已存在
+  const targetDir = path.join(process.cwd(), projectName);
+  if (await fs.pathExists(targetDir)) {
+    const { action } = await inquirer.prompt([
+      {
+        name: 'action',
+        type: 'list',
+        message: `目标目录 ${chalk.cyan(targetDir)} 已存在，请选择操作:`,
+        choices: [
+          { name: '覆盖', value: 'overwrite' },
+          { name: '取消', value: false }
+        ]
+      }
+    ]);
+
+    if (!action) {
+      console.log(chalk.yellow('操作已取消'));
+      return;
+    }
+
+    if (action === 'overwrite') {
+      console.log(chalk.yellow(`\n移除目录 ${chalk.cyan(targetDir)} ...`));
+      await fs.remove(targetDir);
+    }
+  }
+
+  // 选择模板
+  let templateType = options.template;
+  if (!templateType) {
+    const answers = await inquirer.prompt([
+      {
+        name: 'template',
+        type: 'list',
+        message: '请选择项目模板:',
+        choices: [
+          { name: '标准模板 (h5)', value: 'default' },
+          { name: 'vue模板 (Vue2)', value: 'vue2' },
+        ]
+      }
+    ]);
+    templateType = answers.template;
+  }
+
+  try {
+    // 下载模板
+    await downloadTemplate(projectName, templateType);
+    
+    console.log();
+    console.log(chalk.green('✅  项目创建成功!'));
+    console.log();
+    console.log(chalk.cyan('cd ' + projectName));
+    console.log(chalk.cyan('npm install'));
+    console.log(chalk.cyan('npm run dev'));
+    console.log();
+    
+  } catch (err) {
+    console.log(chalk.red('❌  项目创建失败'));
+    console.log(chalk.red(err));
+  }
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "zhixuan-plugin-cli",
+  "version": "1.0.0",
+  "description": "zhixuan插件项目脚手架CLI工具",
+  "main": "bin/index.js",
+  "bin": {
+    "zhixuan-plugin-cli": "bin/index.js",
+    "zhixuan-cli": "bin/index.js",
+    "zx-cli": "bin/index.js"
+  },
+  "files": [
+    "bin/",
+    "commands/",
+    "utils/"
+  ],
+  "keywords": [
+    "zhixuan",
+    "plugin",
+    "cli"
+  ],
+  "author": "shituanquan",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "commander": "^9.4.1",
+    "conf": "^10.2.0",
+    "download-git-repo": "^3.0.2",
+    "fs-extra": "^10.1.0",
+    "inquirer": "^8.2.5",
+    "ora": "^5.4.1"
+  },
+  "engines": {
+    "node": ">=16.18.0"
+  }
+}

package/utils/download.js

@@ -0,0 +1,69 @@
+const download = require('download-git-repo');
+const ora = require('ora');
+const chalk = require('chalk');
+const path = require('path');
+const fs = require('fs-extra');
+
+// 模板仓库配置
+const templates = {
+  // 
+  'default': {
+    url: 'direct:https://gitee.com/zhixuan_stq/zhixuan-plugin-h5.git',
+    branch: 'master',
+    description: 'h5、css、js'
+  },
+  // Vue2基础模板
+  'vue2': {
+    url: 'direct:https://gitee.com/zhixuan_stq/zhixuan-plugin-vue2.git',
+    branch: 'v_1.0.0',
+    description: 'Vue2-cli'
+  },
+};
+
+/**
+ * 下载模板
+ * @param {string} projectName 项目名称
+ * @param {string} templateType 模板类型
+ */
+module.exports = async function downloadTemplate(projectName, templateType = 'default') {
+  const template = templates[templateType];
+
+  if (!template) {
+    console.log(chalk.red(`模板 ${templateType} 不存在`));
+    return;
+  }
+
+  // console.log(chalk.blue(`正在拉取模板: ${template.url}#${template.branch}`)); // 新增日志
+
+  const spinner = ora('正在拉取模板...').start();
+  const dest = path.join(process.cwd(), projectName);
+
+  return new Promise((resolve, reject) => {
+    download(
+      `${template.url}#${template.branch}`,
+      dest,
+      { clone: true },
+      async (err) => {
+        if (err) {
+          spinner.fail(chalk.red('模板拉取失败'));
+          console.error(chalk.red('详细错误:', err.message)); // 新增错误详情
+          reject(err);
+          return;
+        }
+
+        spinner.succeed(chalk.green('模板拉取成功'));
+
+        // 修改package.json中的项目名称
+        const pkgPath = path.join(dest, 'package.json');
+        if (await fs.pathExists(pkgPath)) {
+          const pkg = await fs.readJson(pkgPath);
+          pkg.name = projectName;
+          pkg.version = '1.0.0';
+          await fs.writeJson(pkgPath, pkg, { spaces: 2 });
+        }
+
+        resolve(dest);
+      }
+    );
+  });
+};