@noahyu/cd-cli 1.1.0 → 1.2.0

package/README.md

@@ -1,6 +1,6 @@
-# 简易项目部署工具
+# 简易的项目部署工具
 
-一个简易的部署工具，支持版本管理和零停机部署。
+> 一个简易的部署工具，支持版本管理和零停机部署。
 
 ## 功能特性
 
@@ -35,7 +35,8 @@ pcli-cd init
 
 这会在项目根目录创建 `pcli-cd.config.js` 配置文件。
 
-- **重要** `pcli-cd.config.js` 文件不应该提交到 Git
+> [!WARNING]
+> `pcli-cd.config.js` 配置文件存在敏感信息，不应该提交到 Git
 
 ### 2. 部署项目
 
@@ -87,7 +88,8 @@ PM2 配置始终指向软链接 `.output/server/index.mjs`，这样切换版本
 
 配置文件 `pcli-cd.config.js` 示例：
 
-> **重要** `pcli-cd.config.js` 文件不应该提交到 Git
+> [!WARNING]
+> `pcli-cd.config.js` 配置文件存在敏感信息，不应该提交到 Git
 
 ```javascript
 // pcli-cd 部署配置文件
@@ -106,13 +108,10 @@ export default {
     port: 22,
     /** 用户名 */
     username: 'root',
-    // SSH 认证方式（优先级：privateKey > privateKeyPath > password）
-    /** 私钥 */
-    privateKey: '-----BEGIN OPENSSH PRIVATE KEY-----\n...\n-----END OPENSSH PRIVATE KEY-----',
-    /** 私钥文件路径 */
-    privateKeyPath: '/home/user/.ssh/id_rsa',
-    /** 密码 */
-    password: 'your-password',
+    /** SSH 认证方式（优先级：privateKey > privateKeyPath > password） */
+    privateKey: '-----BEGIN OPENSSH PRIVATE KEY-----\n...\n-----END OPENSSH PRIVATE KEY-----', // 私钥
+    privateKeyPath: '/home/user/.ssh/id_rsa', // 私钥文件路径
+    password: 'your-password', // 密码
     /** 部署目录 */
     deployPath: '/var/www/your-app',
   },
@@ -344,7 +343,8 @@ pcli-cd rollback
 
 每个项目只需要一个 `pcli-cd.config.js` 配置文件，工具会自动读取当前目录下的配置。
 
-⚠️ **重要提醒** `pcli-cd.config.js` 文件不应该提交到 Git
+> [!WARNING]
+> `pcli-cd.config.js` 配置文件存在敏感信息，不应该提交到 Git
 
 ## 注意事项
 
@@ -420,7 +420,3 @@ ssh -p 22 root@your-server.com
 # 测试指定私钥连接
 ssh -i /home/user/.ssh/id_rsa -p 22 root@your-server.com
 ```
-
-## License
-
-MIT

package/dist/bin/cli.js

@@ -1,14 +1,16 @@
 #!/usr/bin/env node
 import { program } from 'commander';
 import { deployCommand, initConfig, listVersions, rollbackVersion } from '../src/index.js';
+import { getVersion } from '../src/utils/get-version.js';
 
-program.version('1.0.0').description('Simple CI/CD deployment tool');
+program.version(getVersion(), '-v, --version').description('Simple CI/CD deployment tool');
 program
     .command('deploy')
     .alias('cd')
     .description('Build and deploy project to server')
     .option('-c, --config <config>', 'Configuration file path', './pcli-cd.config.js')
     .option('-v, --version <version>', 'Specify version number')
+    .option('-n, --name <name>', 'Specify deployment environment name (dev, prod, staging, etc.). If not specified, will prompt to select interactively')
     .action(deployCommand);
 program.command('init').description('Initialize CD configuration file').action(initConfig);
 program
@@ -16,6 +18,7 @@ program
     .alias('ls')
     .description('List deployed versions on server')
     .option('-c, --config <config>', 'Configuration file path', './pcli-cd.config.js')
+    .option('-n, --name <name>', 'Specify environment name to list (dev, prod, staging, etc.). If not specified, will prompt to select interactively')
     .action(listVersions);
 program
     .command('rollback')
@@ -23,5 +26,6 @@ program
     .description('Rollback to a previous version')
     .option('-c, --config <config>', 'Configuration file path', './pcli-cd.config.js')
     .option('-v, --version <version>', 'Version to rollback to')
+    .option('-n, --name <name>', 'Specify environment name to rollback (dev, prod, staging, etc.). If not specified, will prompt to select interactively')
     .action(rollbackVersion);
 program.parse(process.argv);

package/dist/src/index.js

@@ -8,24 +8,23 @@ import { NodeSSH } from 'node-ssh';
 import ora from 'ora';
 import chalk from 'chalk';
 import inquirer from 'inquirer';
+import { renderConfigTemplate } from './utils/template.js';
 
 async function deployCommand(options) {
     const configPath = resolve(process.cwd(), options.config);
-    if (!existsSync(configPath)) {
-        console.log(chalk.red(`❌ 配置文件不存在: ${configPath}`));
-        console.log(chalk.yellow('💡 请创建 pcli-cd.config.js 配置文件'));
-        process.exit(1);
-    }
+    const configResult = await resolveEnvConfig(configPath, options.name);
     let config;
-    try {
-        const configModule = await import(configPath);
-        config = configModule.default || configModule;
+    if (configResult.targetConfig) {
+        config = configResult.targetConfig;
     }
-    catch (error) {
-        console.log(chalk.red(`❌ 配置文件读取失败: ${error}`));
-        process.exit(1);
+    else {
+        const selected = await selectEnvironmentFromConfigs(configResult.allConfigs);
+        config = selected.targetConfig;
     }
-    if (!config.version && !options.version) {
+    console.log(chalk.blue(`🚀 部署环境: ${chalk.bold(config.name)}`));
+    console.log(chalk.gray(`📍 部署路径: ${config.server.deployPath}`));
+    let version = options.version;
+    if (!version) {
         const answers = await inquirer.prompt([
             {
                 type: 'input',
@@ -35,18 +34,14 @@ async function deployCommand(options) {
                 validate: (input) => input.trim() !== '' || '版本号不能为空',
             },
         ]);
-        config.version = answers.version;
-    }
-    else {
-        config.version = options.version || config.version;
+        version = answers.version;
     }
-    await deploy(config);
+    await deploy(config, version);
 }
-async function deploy(config) {
+async function deploy(config, version) {
     const spinner = ora();
     const tempDir = join(process.cwd(), '.deploy-temp');
     const zipPath = join(tempDir, 'build.zip');
-    const version = config.version || `v${Date.now()}`;
     const buildDirName = config.buildDir.split('/').pop() || 'build';
     try {
         await fse.remove(tempDir);
@@ -75,8 +70,10 @@ async function deploy(config) {
         spinner.succeed('服务器连接成功');
         await cleanTempLinks(ssh, config.server.deployPath, buildDirName);
         spinner.start('检查部署环境...');
-        await handleExistingDeployDir(ssh, config.server.deployPath, buildDirName);
-        spinner.succeed('部署环境检查完成');
+        await handleExistingDeployDir(ssh, config.server.deployPath, buildDirName, spinner);
+        if (spinner.isSpinning) {
+            spinner.succeed('部署环境检查完成');
+        }
         const versionDirName = `${buildDirName}-${version}`;
         const versionPath = join(config.server.deployPath, versionDirName);
         const currentLinkPath = join(config.server.deployPath, buildDirName);
@@ -204,6 +201,13 @@ async function cleanOldVersions(ssh, deployPath, buildDirName, keepCount) {
 async function initConfig() {
     console.log(chalk.blue('🚀 初始化配置文件'));
     const answers = await inquirer.prompt([
+        {
+            type: 'input',
+            name: 'envName',
+            message: '环境名称 (如: dev, prod, staging):',
+            default: 'dev',
+            validate: (input) => input.trim() !== '' || '请输入环境名称',
+        },
         {
             type: 'input',
             name: 'buildCommand',
@@ -251,44 +255,35 @@ async function initConfig() {
             message: 'PM2 应用名称 (可选):',
         },
     ]);
-    const config = {
+    const configContent = renderConfigTemplate({
+        envName: answers.envName,
         buildCommand: answers.buildCommand,
         buildDir: answers.buildDir,
-        server: {
-            host: answers.host,
-            port: parseInt(answers.port),
-            username: answers.username,
-            privateKeyPath: answers.privateKeyPath || undefined,
-            deployPath: answers.deployPath,
-        },
-        excludeFiles: [],
-    };
-    if (answers.pm2AppName) {
-        config.pm2 = {
-            appName: answers.pm2AppName,
-            restart: true,
-        };
-    }
-    const configContent = `// pcli-cd 部署配置文件
-export default ${JSON.stringify(config, null, 2)}`;
+        host: answers.host,
+        port: answers.port,
+        username: answers.username,
+        privateKeyPath: answers.privateKeyPath || undefined,
+        deployPath: answers.deployPath,
+        pm2AppName: answers.pm2AppName || undefined,
+    });
     await fse.writeFile('pcli-cd.config.js', configContent);
     console.log(chalk.green('✅ 配置文件已创建: pcli-cd.config.js'));
+    console.log(chalk.blue(`📝 默认环境: ${answers.envName}`));
+    console.log(chalk.gray('💡 可以在 apps 数组中添加更多环境配置'));
+    console.log(chalk.gray('💡 配置文件包含详细的注释说明'));
 }
 async function listVersions(options) {
     const configPath = resolve(process.cwd(), options.config);
-    if (!existsSync(configPath)) {
-        console.log(chalk.red(`❌ 配置文件不存在: ${configPath}`));
-        process.exit(1);
-    }
+    const configResult = await resolveEnvConfig(configPath, options.name);
     let config;
-    try {
-        const configModule = await import(configPath);
-        config = configModule.default || configModule;
+    if (configResult.targetConfig) {
+        config = configResult.targetConfig;
     }
-    catch (error) {
-        console.log(chalk.red(`❌ 配置文件读取失败: ${error}`));
-        process.exit(1);
+    else {
+        const selected = await selectEnvironmentFromConfigs(configResult.allConfigs);
+        config = selected.targetConfig;
     }
+    console.log(chalk.blue(`🔍 查看环境: ${chalk.bold(config.name)}`));
     const spinner = ora('正在获取版本列表...');
     spinner.start();
     try {
@@ -342,19 +337,16 @@ async function listVersions(options) {
 }
 async function rollbackVersion(options) {
     const configPath = resolve(process.cwd(), options.config);
-    if (!existsSync(configPath)) {
-        console.log(chalk.red(`❌ 配置文件不存在: ${configPath}`));
-        process.exit(1);
-    }
+    const configResult = await resolveEnvConfig(configPath, options.name);
     let config;
-    try {
-        const configModule = await import(configPath);
-        config = configModule.default || configModule;
+    if (configResult.targetConfig) {
+        config = configResult.targetConfig;
     }
-    catch (error) {
-        console.log(chalk.red(`❌ 配置文件读取失败: ${error}`));
-        process.exit(1);
+    else {
+        const selected = await selectEnvironmentFromConfigs(configResult.allConfigs);
+        config = selected.targetConfig;
     }
+    console.log(chalk.blue(`⏪ 回滚环境: ${chalk.bold(config.name)}`));
     const buildDirName = config.buildDir.split('/').pop() || 'build';
     let targetVersion = options.version;
     if (!targetVersion) {
@@ -451,6 +443,76 @@ async function performRollback(config, targetVersion, buildDirName) {
         process.exit(1);
     }
 }
+async function resolveEnvConfig(configPath, envName) {
+    if (!existsSync(configPath)) {
+        console.log(chalk.red(`❌ 配置文件不存在: ${configPath}`));
+        console.log(chalk.yellow('💡 请创建 pcli-cd.config.js 配置文件'));
+        process.exit(1);
+    }
+    let rawConfig;
+    try {
+        const configModule = await import(configPath);
+        rawConfig = configModule.default || configModule;
+    }
+    catch (error) {
+        console.log(chalk.red(`❌ 配置文件读取失败: ${error}`));
+        process.exit(1);
+    }
+    if (!rawConfig.apps || !Array.isArray(rawConfig.apps)) {
+        console.log(chalk.red('❌ 配置文件格式错误：缺少 apps 数组'));
+        console.log(chalk.yellow('💡 配置文件应该包含一个 apps 数组，每个元素都是一个环境配置'));
+        process.exit(1);
+    }
+    if (rawConfig.apps.length === 0) {
+        console.log(chalk.red('❌ 配置文件中没有任何环境配置'));
+        console.log(chalk.yellow('💡 请在 apps 数组中添加至少一个环境配置'));
+        process.exit(1);
+    }
+    if (!envName) {
+        return {
+            targetConfig: null,
+            allConfigs: rawConfig.apps,
+        };
+    }
+    const envConfig = rawConfig.apps.find((app) => app.name === envName);
+    if (!envConfig) {
+        console.log(chalk.red(`❌ 环境配置 "${envName}" 不存在`));
+        console.log(chalk.yellow('💡 可用的环境配置:'));
+        rawConfig.apps.forEach((app) => {
+            console.log(chalk.gray(`   - ${app.name}`));
+        });
+        process.exit(1);
+    }
+    return {
+        targetConfig: envConfig,
+        allConfigs: rawConfig.apps,
+    };
+}
+async function selectEnvironmentFromConfigs(allConfigs) {
+    if (allConfigs.length === 1) {
+        return {
+            envName: allConfigs[0].name,
+            targetConfig: allConfigs[0],
+        };
+    }
+    const envChoices = allConfigs.map((app) => ({
+        name: `${app.name} (${app.server.host})`,
+        value: app.name,
+    }));
+    const answers = await inquirer.prompt([
+        {
+            type: 'list',
+            name: 'envName',
+            message: '请选择环境:',
+            choices: envChoices,
+        },
+    ]);
+    const selectedConfig = allConfigs.find((app) => app.name === answers.envName);
+    return {
+        envName: answers.envName,
+        targetConfig: selectedConfig,
+    };
+}
 async function createSSHConnection(server) {
     const ssh = new NodeSSH();
     const connectConfig = {
@@ -486,7 +548,7 @@ async function cleanTempLinks(ssh, deployPath, buildDirName) {
         console.warn(chalk.yellow(`⚠️ 清理临时链接时出现警告: ${error}`));
     }
 }
-async function handleExistingDeployDir(ssh, deployPath, buildDirName) {
+async function handleExistingDeployDir(ssh, deployPath, buildDirName, spinner) {
     const currentLinkPath = join(deployPath, buildDirName);
     const checkResult = await ssh.execCommand(`test -e ${currentLinkPath}`);
     if (checkResult.code !== 0) {
@@ -500,6 +562,7 @@ async function handleExistingDeployDir(ssh, deployPath, buildDirName) {
     const fileType = typeResult.stdout.trim();
     if (fileType.includes('directory') || fileType === 'directory') {
         const backupPath = `${currentLinkPath}.backup.${Date.now()}`;
+        spinner.stop();
         console.log(chalk.yellow(`⚠️ 检测到已存在的目录: ${currentLinkPath}`));
         console.log(chalk.blue(`📁 将备份到: ${backupPath}`));
         const answers = await inquirer.prompt([
@@ -513,18 +576,25 @@ async function handleExistingDeployDir(ssh, deployPath, buildDirName) {
         if (!answers.proceed) {
             throw new Error('用户取消部署');
         }
+        spinner.start('正在备份已存在的目录...');
         const backupResult = await ssh.execCommand(`mv ${currentLinkPath} ${backupPath}`);
         if (backupResult.code !== 0) {
             throw new Error(`备份目录失败: ${backupResult.stderr}`);
         }
+        spinner.stop();
         console.log(chalk.green(`✅ 目录已备份到: ${backupPath}`));
     }
     else {
         const backupPath = `${currentLinkPath}.backup.${Date.now()}`;
+        spinner.stop();
+        console.log(chalk.yellow(`⚠️ 检测到已存在的文件: ${currentLinkPath}`));
+        console.log(chalk.blue(`📁 将备份到: ${backupPath}`));
+        spinner.start('正在备份已存在的文件...');
         const backupResult = await ssh.execCommand(`mv ${currentLinkPath} ${backupPath}`);
         if (backupResult.code !== 0) {
             throw new Error(`备份文件失败: ${backupResult.stderr}`);
         }
+        spinner.stop();
         console.log(chalk.green(`✅ 文件已备份到: ${backupPath}`));
     }
 }

package/dist/src/templates/config.ejs

@@ -0,0 +1,66 @@
+// pcli-cd.config.js
+
+export default {
+  apps: [
+    {
+      // 环境名称
+      name: '<%= envName %>',
+      
+      // 构建命令，部署前执行
+      buildCommand: '<%= buildCommand %>',
+      
+      // 构建输出目录
+      buildDir: '<%= buildDir %>',
+      
+      // 服务器配置
+      server: {
+        host: '<%= host %>',
+        port: <%= port %>,
+        username: '<%= username %>',<% if (privateKeyPath) { %>
+        privateKeyPath: '<%= privateKeyPath %>',<% } else { %>
+        // 私钥路径
+        // privateKeyPath: '~/.ssh/id_rsa',
+        
+        // 或者使用私钥内容
+        // privateKey: `-----BEGIN OPENSSH PRIVATE KEY-----
+        // ...
+        // -----END OPENSSH PRIVATE KEY-----`,
+        
+        // 或者使用密码
+        // password: 'your-password',<% } %>
+        deployPath: '<%= deployPath %>'
+      },<% if (pm2AppName) { %>
+      
+      // PM2 进程管理配置
+      pm2: {
+        appName: '<%= pm2AppName %>',
+        restart: true
+      },<% } else { %>
+      
+      // PM2 进程管理配置（可选）
+      // pm2: {
+      //   appName: 'my-app',
+      //   restart: true
+      // },<% } %>
+      
+      // 排除文件列表（可选）
+      excludeFiles: [
+        // 'node_modules/**',
+        // '*.log',
+        // '.env*'
+      ],
+      
+      // 部署前命令（可选）
+      // beforeDeploy: [
+      //   'npm test',
+      //   'npm run lint'
+      // ],
+      
+      // 部署后命令（可选）
+      // afterDeploy: [
+      //   'npm install --production',
+      //   'npm run migrate'
+      // ]
+    }
+  ]
+}

package/dist/src/utils/get-version.js

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+import fse from 'fs-extra';
+import parseJson from 'parse-json';
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+
+function getVersion() {
+    const __filename = fileURLToPath(import.meta.url);
+    const __dirname = dirname(__filename);
+    const packageJsonPath = join(__dirname, '../../package.json');
+    let packageJsonContent;
+    try {
+        packageJsonContent = fse.readFileSync(packageJsonPath, 'utf-8');
+    }
+    catch {
+        throw new Error(`无法找到 package.json 文件：${packageJsonPath}`);
+    }
+    let packageData;
+    try {
+        packageData = parseJson(packageJsonContent);
+    }
+    catch {
+        throw new Error('package.json 文件格式错误，请检查 JSON 语法');
+    }
+    if (!packageData.version) {
+        throw new Error('package.json 中缺少 version 字段');
+    }
+    return packageData.version || '0.0.0';
+}
+
+export { getVersion };

package/dist/src/utils/template.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+import { readFileSync } from 'fs';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import ejs from 'ejs';
+
+function renderConfigTemplate(templateData) {
+    const __filename = fileURLToPath(import.meta.url);
+    const __dirname = dirname(__filename);
+    const templatePath = join(__dirname, '../templates/config.ejs');
+    try {
+        const templateContent = readFileSync(templatePath, 'utf-8');
+        return ejs.render(templateContent, templateData);
+    }
+    catch (error) {
+        throw new Error(`模板渲染失败: ${error}`);
+    }
+}
+
+export { renderConfigTemplate };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@noahyu/cd-cli",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Global CLI tool for simple project deployment with version management",
   "type": "module",
   "main": "./dist/bin/cli.js",