ftp-cos-deploy 1.0.0

package/README.md

@@ -0,0 +1,36 @@
+# git-push-dir
+- 基于Git的部署工具
+- 可将指定目录推送至远程Git仓库
+
+## 使用方法
+
+1. 安装依赖
+   ```bash
+   npm install git-push-dir
+   ```
+
+2. 引入模块
+```javascript
+  // deploy.js
+  import { deploy } from 'git-push-dir'
+
+  deploy({
+    /** 远程仓库地址 (例如: https://gitee.com/user/repo.git) */
+    remoteUrl: string;
+    /** 推送的分支名，默认为 'dist' */
+    branch?: string;
+    /** 项目根目录，默认为 process.cwd() */
+    rootDir?: string;
+    /** 构建输出目录名 (相对于 rootDir)，默认为 'dist' */
+    distDir?: string;
+    /** 需要从根目录复制到发布目录的文件列表 */
+    filesToCopy?: string[];
+    /** 自定义日志打印函数 */
+    logger?: (msg: string) => void;
+  });
+```
+
+3. 控制台执行
+```bash
+  node deploy.js
+```

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "ftp-cos-deploy",
+  "version": "1.0.0",
+  "description": "一款基于FTP和COS的部署工具，可将指定目录推送至远程FTP服务器并上传至COS存储桶。",
+  "type": "module",
+  "main": "./src/index.js",
+  "module": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "require": "./src/index.js",
+      "import": "./src/index.js"
+    }
+  },
+  "files": [
+    "src"
+  ],
+  "keywords": [
+    "deploy",
+    "ftp",
+    "cos"
+  ],
+  "author": "hsg",
+  "license": "MIT",
+  "dependencies": {
+    "basic-ftp": "^5.1.0",
+    "chalk": "^5.6.2",
+    "cli-progress": "^3.12.0",
+    "cos-nodejs-sdk-v5": "^2.15.4"
+  }
+}

package/src/cos.js

@@ -0,0 +1,231 @@
+/**
+ * 腾讯云COS文件/文件夹上传模块(Node.js版)
+ * ES6语法实现带进度条功能
+ * @param {Object} config - COS配置参数
+ * @param {string} config.SecretId - 腾讯云SecretId
+ * @param {string} config.SecretKey - 腾讯云SecretKey
+ * @param {string} config.Bucket - 存储桶名称
+ * @param {string} config.Region - 存储桶地域
+ * @param {Function} onProgress - 上传进度回调函数
+ * @returns {Object} 包含upload方法的对象
+ */
+import COS from 'cos-nodejs-sdk-v5';
+import fs from 'fs/promises';
+import path from 'path';
+import { createReadStream } from 'fs';
+// 导入进度条模块
+import { createFileProgressBar } from './progress.js';
+
+/**
+ * 创建COS上传工具实例
+ * @param {Object} config - COS配置参数
+ * @returns {Object} 上传工具对象
+ */
+export function createCos(config) {
+  // 配置参数验证
+  if (!config || !config.SecretId || !config.SecretKey || !config.Bucket || !config.Region) {
+    throw new Error('缺少必要的配置参数');
+  }
+
+  // 默认配置
+  const cosConfig = {
+    ...config,
+    timeout: config.timeout || 300000, // 5分钟超时时间
+    chunkSize: config.chunkSize || 1024 * 1024 * 5, // 5MB分片大小
+    showProgress: config.showProgress !== false, // 默认显示进度条
+  };
+
+  // 初始化COS实例
+  const cos = new COS({
+    SecretId: cosConfig.SecretId,
+    SecretKey: cosConfig.SecretKey,
+  });
+
+  /**
+   * 递归遍历目录并上传文件
+   * @param {string} dirPath - 目录路径
+   * @param {string} baseDir - 基础目录路径
+   * @param {string} remotePrefix - 远程存储路径前缀
+   * @param {Function} fileHandler - 文件处理函数
+   */
+  const traverseDirectory = async (dirPath, baseDir, remotePrefix, fileHandler) => {
+    const entries = await fs.readdir(dirPath, { withFileTypes: true });
+    
+    for (const entry of entries) {
+      const fullPath = path.join(dirPath, entry.name);
+      
+      if (entry.isDirectory()) {
+        await traverseDirectory(fullPath, baseDir, remotePrefix, fileHandler);
+      } else if (entry.isFile()) {
+        await fileHandler(fullPath);
+      }
+    }
+  };
+
+  /**
+   * 上传单个文件到COS
+   * @param {string} filePath - 本地文件路径
+   * @param {string} baseDir - 基础目录路径
+   * @param {string} remotePrefix - 远程存储路径前缀
+   */
+  const uploadFileToCOS = async (filePath, baseDir, remotePrefix) => {
+    try {
+      // 获取相对路径以保持目录结构
+      const relativePath = path.relative(baseDir, filePath);
+      const key = remotePrefix 
+        ? path.posix.join(remotePrefix, relativePath.replace(/\\/g, '/'))
+        : relativePath.replace(/\\/g, '/');
+
+      // 获取文件信息
+      const stats = await fs.stat(filePath);
+      const fileSize = stats.size;
+      
+      // 创建文件进度条
+      let fileBar = null;
+      if (cosConfig.showProgress) {
+        fileBar = createFileProgressBar(filePath);
+      }
+
+      // 小文件直接上传
+      if (fileSize <= cosConfig.chunkSize) {
+        return new Promise((resolve) => {
+          cos.putObject({
+            Bucket: cosConfig.Bucket,
+            Region: cosConfig.Region,
+            Key: key,
+            Body: createReadStream(filePath),
+            ContentLength: fileSize,
+            onProgress: (progressData) => {
+              // 更新文件进度条
+              if (fileBar) {
+                fileBar.update(progressData.loaded);
+              }
+              
+              // 调用用户提供的进度回调
+              cosConfig.onProgress?.({
+                key,
+                percent: progressData.percent * 100,
+                loaded: progressData.loaded,
+                total: progressData.total,
+                file: filePath
+              });
+            }
+          }, (err, data) => {
+            // 结束文件进度条
+            if (fileBar) {
+              fileBar.end();
+            }
+            
+            if (err) {
+              resolve({
+                success: false,
+                key,
+                path: filePath,
+                error: err.message
+              });
+            } else {
+              resolve({
+                success: true,
+                key,
+                path: filePath,
+                etag: data.ETag,
+                requestId: data.RequestId
+              });
+            }
+          });
+        });
+      }
+
+      // 大文件分片上传
+      return new Promise((resolve) => {
+        cos.sliceUploadFile({
+          Bucket: cosConfig.Bucket,
+          Region: cosConfig.Region,
+          Key: key,
+          FilePath: filePath,
+          SliceSize: cosConfig.chunkSize,
+          onProgress: (progressData) => {
+            // 更新文件进度条
+            if (fileBar) {
+              fileBar.update(progressData.loaded);
+            }
+            
+            // 调用用户提供的进度回调
+            cosConfig.onProgress?.({
+              key,
+              percent: progressData.percent * 100,
+              loaded: progressData.loaded,
+              total: progressData.total,
+              file: filePath
+            });
+          }
+        }, (err, data) => {
+          // 结束文件进度条
+          if (fileBar) {
+            fileBar.end();
+          }
+          
+          if (err) {
+            resolve({
+              success: false,
+              key,
+              path: filePath,
+              error: err.message
+            });
+          } else {
+            resolve({
+              success: true,
+              key,
+              path: filePath,
+              etag: data.ETag,
+              requestId: data.RequestId
+            });
+          }
+        });
+      });
+    } catch (error) {
+    
+      return {
+        success: false,
+        path: filePath,
+        error: error.message
+      };
+    }
+  };
+
+  /**
+   * 上传文件或文件夹
+   * @param {string} localPath - 本地文件或文件夹路径
+   * @param {string} [remotePrefix=''] - 远程存储路径前缀
+   */
+  const upload = async (localPath, remotePrefix = '') => {
+    // 验证路径是否存在
+    try {
+      await fs.access(localPath);
+    } catch (error) {
+      throw new Error(`路径不存在: ${localPath}`);
+    }
+
+    // 获取路径信息
+    const stats = await fs.stat(localPath);
+    const results = [];
+
+    if (stats.isDirectory()) {
+      // 处理文件夹
+      const baseDir = path.dirname(localPath);
+      await traverseDirectory(localPath, baseDir, remotePrefix, (filePath) => {
+        results.push(uploadFileToCOS(filePath, baseDir, remotePrefix));
+      });
+    } else {
+      // 处理单个文件
+      results.push(uploadFileToCOS(localPath, path.dirname(localPath), remotePrefix));
+    }
+
+    return Promise.all(results);
+  };
+
+  // 返回公共方法
+  return {
+    upload
+  };
+}

package/src/ftp.js

@@ -0,0 +1,148 @@
+import ftp from 'basic-ftp';
+import fs from 'fs';
+import path from 'path';
+import { createFileProgressBar } from './progress.js';
+
+/**
+ * FTP文件/文件夹上传模块(Node.js版)
+ * ES6语法实现带进度条功能
+ * @param {Object} config - FTP配置参数
+ * @param {string} config.host - 服务器主机名，默认值：localhost
+ * @param {number} [config.port=21] - 服务器端口号，默认值：21
+ * @param {string} config.user - 用户名，默认值：anonymous
+ * @param {string} config.password - 密码，默认值：guest
+ * @param {boolean|string} [config.secure=false] - 是否使用显式 FTPS 加密，默认值：false。如果需要支持旧版隐式 FTPS，请设置为 "implicit"。
+ * @param {Object} [config.secureOptions=null] - TLS 选项，与 Node.js 中的 tls.connect() 相同。默认值：null
+ * @param {string} [config.remoteDir='/'] - 远程目录，默认值：/
+ * @returns {Object} 包含upload方法的对象
+ */
+export function createFtp(config) {
+    const ftpConfig = {
+        ...config,
+        remoteDir: config.remoteDir.replace(/\\/g, '/').endsWith('/') 
+            ? config.remoteDir.replace(/\\/g, '/') 
+            : config.remoteDir.replace(/\\/g, '/') + '/'
+    }
+
+    /**
+     * 上传文件或文件夹到FTP（支持进度条）
+     * @param {string} localPath - 本地文件/文件夹路径
+     * @param {string} [remoteName] - 远程保存名称（文件夹上传时可选，默认使用本地名称）
+     */
+    async function upload(localPath, remoteName) {
+        const client = new ftp.Client();
+        try {
+            await client.access(ftpConfig);
+            const stats = fs.statSync(localPath);
+            
+            const safeRemoteName = remoteName ? remoteName.replace(/\\/g, '/') : path.basename(localPath).replace(/\\/g, '/');
+            const remoteFolderPath = ftpConfig.remoteDir + safeRemoteName;
+            
+            // 1. 如果是文件，直接上传
+            if (stats.isFile()) {
+                await uploadSingleFile(client, localPath, remoteFolderPath);
+            } else if (stats.isDirectory()) {
+                // 2. 如果是文件夹，递归上传所有内容
+                
+                // 创建远程文件夹（如果不存在）
+                await client.ensureDir(remoteFolderPath);
+                console.log(`📂 开始上传文件夹：${localPath} → ${remoteFolderPath}`);
+
+                // 获取文件夹内所有文件（含子目录）
+                const allFiles = getAllFilesInDir(localPath);
+                const totalFiles = allFiles.length;
+                
+                // 初始化总进度条
+                const mainBar = createFolderProgressBar(totalFiles);
+
+                // 逐个上传文件
+                for (let i = 0; i < allFiles.length; i++) {
+                    const file = allFiles[i];
+                    // 计算远程文件路径（保持目录结构）
+                    const relativePath = path.relative(localPath, file);
+                    const remoteFilePath = path.join(remoteFolderPath, relativePath);
+                    
+                    // 上传单个文件，并更新总进度条
+                    await uploadSingleFile(client, file, remoteFilePath, false);
+                    mainBar.update(i + 1);
+                }
+                mainBar.end();
+                console.log(`\n✅ 文件夹上传完成：共 ${totalFiles} 个文件`);
+            }
+
+        } catch (err) {
+            console.error('\n❌ 上传失败：', err.message);
+        } finally {
+            client.close();
+        }
+    }
+
+    /** 
+     * 上传单个文件（内部使用，支持进度条）
+     * @param {ftp.Client} client - FTP客户端实例
+     * @param {string} localFilePath - 本地文件路径
+     * @param {string} remoteFilePath - 远程文件路径
+     * @param {boolean} [showProgress=true] - 是否显示单个文件进度条
+     */
+    async function uploadSingleFile(client, localFilePath, remoteFilePath, showProgress = true) {
+        let fileBar = null;
+
+        // 初始化单个文件进度条（如果需要）
+        if (showProgress) {
+            fileBar = createFileProgressBar(localFilePath);
+        }
+
+        // 读取文件流并监听进度
+        const fileStream = fs.createReadStream(localFilePath);
+        let uploadedBytes = 0;
+        
+        fileStream.on('data', (chunk) => {
+            uploadedBytes += chunk.length;
+            if (showProgress) {
+                fileBar.update(uploadedBytes);
+            }
+        });
+
+        try {
+            // 执行上传
+            await client.uploadFrom(localFilePath, remoteFilePath);
+            
+            // 清理进度条
+            if (showProgress) {
+                fileBar.end();
+                // console.log(`✅ ${path.basename(localFilePath)} 上传完成\n`);
+            }
+        } catch (error) {
+            fileBar.end();
+            throw error
+        }
+    }
+
+    /**
+     * 递归获取文件夹内所有文件路径
+     * @param {string} dir - 文件夹路径
+     * @returns {string[]} 文件路径列表
+     */
+    function getAllFilesInDir(dir) {
+        let results = [];
+        const list = fs.readdirSync(dir);
+        
+        list.forEach((file) => {
+            const fullPath = path.join(dir, file);
+            const stats = fs.statSync(fullPath);
+            
+            if (stats.isDirectory()) {
+            // 递归处理子目录
+            results = results.concat(getAllFilesInDir(fullPath));
+            } else {
+            // 添加文件路径
+            results.push(fullPath);
+            }
+        });
+        return results;
+    }
+
+    return {
+        upload
+    }
+}

package/src/index.d.ts

@@ -0,0 +1,66 @@
+declare module 'ftp-cos-deploy' {
+    interface CosOptions {
+        Bucket: string
+        Region: string
+        SecretId: string
+        SecretKey: string
+        timeout?: number // 超时时间，单位毫秒
+        chunkSize?: number // 分片大小，单位字节
+        showProgress?: boolean // 是否显示进度条
+    }
+
+    interface CosClient {
+        /**
+         * 上传文件或文件夹
+         * @param {string} localPath - 本地文件或文件夹路径
+         * @param {string} [remotePrefix=''] - 远程存储路径前缀
+         */
+        uploadFile: (localPath: string, remotePrefix?: string) => Promise<void>
+    }
+
+    interface FtpOptions {
+        host: string // 服务器主机名，默认值：localhost
+        port?: number // 服务器端口号，默认值：21
+        user: string // 用户名，默认值：anonymous
+        password: string // 密码，默认值：guest
+        secure: boolean | "implicit" // 是否使用显式 FTPS 加密，默认值：false。如果需要支持旧版隐式 FTPS，请设置为 "implicit"。
+        secureOptions?: any // TLS 选项，与 Node.js 中的 tls.connect() 相同。默认值：null
+        remoteDir?: string // 远程目录，默认值：/
+    }
+
+    interface FtpClient {
+        /**
+         * 上传文件或文件夹到FTP（支持进度条）
+         * @param {string} localPath - 本地文件/文件夹路径
+         * @param {string} [remoteName] - 远程保存名称（文件夹上传时可选，默认使用本地名称）
+         */
+        upload: (localPath: string, remoteName?: string) => Promise<void>
+    }
+    /**
+     * 腾讯云COS文件/文件夹上传模块(Node.js版)
+     * ES6语法实现带进度条功能
+     * @param {Object} config - COS配置参数
+     * @param {string} config.SecretId - 腾讯云SecretId
+     * @param {string} config.SecretKey - 腾讯云SecretKey
+     * @param {string} config.Bucket - 存储桶名称
+     * @param {string} config.Region - 存储桶地域
+     * @param {Function} onProgress - 上传进度回调函数
+     * @returns {Object} 包含upload方法的对象
+     */
+    export function createCos(options: CosOptions): CosClient
+
+    /**
+     * FTP文件/文件夹上传模块(Node.js版)
+     * ES6语法实现带进度条功能
+     * @param {Object} config - FTP配置参数
+     * @param {string} config.host - 服务器主机名，默认值：localhost
+     * @param {number} [config.port=21] - 服务器端口号，默认值：21
+     * @param {string} config.user - 用户名，默认值：anonymous
+     * @param {string} config.password - 密码，默认值：guest
+     * @param {boolean|string} [config.secure=false] - 是否使用显式 FTPS 加密，默认值：false。如果需要支持旧版隐式 FTPS，请设置为 "implicit"。
+     * @param {Object} [config.secureOptions=null] - TLS 选项，与 Node.js 中的 tls.connect() 相同。默认值：null
+     * @param {string} [config.remoteDir='/'] - 远程目录，默认值：/
+     * @returns {Object} 包含upload方法的对象
+     */
+    export function createFtp(options: FtpOptions): FtpClient
+}

package/src/index.js

@@ -0,0 +1,3 @@
+
+export { createFtp } from './ftp.js'
+export { createCos } from './cos.js'

package/src/progress.js

@@ -0,0 +1,87 @@
+import cliProgress from 'cli-progress';
+import fs from 'fs';
+import path from 'path';
+import chalk from 'chalk'; // 导入chalk用于颜色处理
+
+/**
+ * 创建文件夹进度条
+ * @param {number} total - 总文件数
+ * @returns {object} - 包含更新和结束方法的对象
+ */
+export function createFolderProgressBar(total) {
+    const bar = new cliProgress.SingleBar(
+        {
+            format: '总进度 | {bar} | {percentage}% | {value}/{total} 文件',
+            barCompleteChar: '\u2588',
+            barIncompleteChar: '\u2591',
+            hideCursor: true
+        },
+        cliProgress.Presets.shades_classic
+    );
+    bar.start(total, 0);
+
+    return {
+        update: (current) => {
+            bar.update(current);
+        },
+        end: () => {
+            bar.stop();
+        }
+    }
+}
+
+export function createFileProgressBar(localFilePath, color='green') {
+    // 根据颜色参数获取对应的chalk颜色方法
+    const colorMethod = chalk[color] || chalk.green;
+    
+    const fileStats = fs.statSync(localFilePath);
+    const totalBytes = fileStats.size;
+    const { unit, scale } = getUnitAndScale(totalBytes);
+
+    const bar = new cliProgress.SingleBar(
+        {
+            format: `正在上传 ${colorMethod('[{bar}]')} {percentage}% | {value}/{total} | ${path.basename(localFilePath)}`,
+            barCompleteChar: '\u2588',
+            barIncompleteChar: '\u2591',
+            hideCursor: true,
+            formatValue: (value, options, type) => {
+                if (type === 'value' || type === 'total') {
+                    // 对value和total应用相同的单位和scale
+                    return `${(value / scale).toFixed(2)}${unit}`;
+                }
+
+                // 其他类型保持默认
+                return value.toString();
+            }
+        },
+        cliProgress.Presets.shades_classic
+    );
+    bar.start(totalBytes, 0);
+
+    return {
+        update: (current) => {
+            bar.update(current);
+        },
+        end: () => {
+            bar.stop();
+        }
+    }
+}
+
+// 根据总值动态确定单位
+function getUnitAndScale(totalBytes) {
+    const units = ['B', 'KB', 'MB']; // 最大支持MB
+    let scale = 1;
+    let unit = units[0];
+    
+    // 根据总值确定单位（如1024KB以上用MB）
+    if (totalBytes >= 1024 * 1024) {
+        scale = 1024 * 1024;
+        unit = units[2]; // MB
+    } else if (totalBytes >= 1024) {
+        scale = 1024;
+        unit = units[1]; // KB
+    }
+    
+    return { unit, scale };
+}