@yidun/cdn-upload-webpack-plugin 1.0.0 → 1.1.0

package/.eslintignore

@@ -0,0 +1,3 @@
+/dist/
+/dashboard/
+node_modules

package/.eslintrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true
+  },
+  extends: [
+    'standard'
+  ]
+}

package/README.md

@@ -1,45 +1,45 @@
-## cdn-upload-webpack-plugin, 用于将静态资源上传到 cdn
-
-### usage
-
-### 构造函数
-
-```
-  /**
-   * @param {Object} options
-   * @param {Array|String} dirs 待上传的文件目录
-   * @param {Boolean} includeRootDir 文件的相对路径计算时包不包含根目录，默认 true
-   * @param {RegExp|Array<RegExp>} ignore 排除特定文件
-   * @param {Object} client 上传 client 配置，目前只支持 NosClient，不同的 client 配置参数可能不同，以 nos 举例
-   * @param {String} accessId
-   * @param {String} secretKey
-   * @param {String} bucket 桶名
-   * @param {String} namespace 不同项目在使用同一个桶时做隔离
-   */
-  new CdnUploadWebpackPlugin(options)
-```
-
-### 以 vue-cli 项目举例
-
-```
-  configureWebpack: config => {
-    if (process.env.NODE_ENV === 'production') {
-      config.plugins.push(...[
-        new CdnUploadWebpackPlugin({
-          dirs: path.resolve(__dirname, './dist'),
-          ignore: /.html$/,
-          client: {
-            bucket: '',
-            accessId: '',
-            secretKey: '',
-            namespace: 'yidunfe/cdntest'
-          }
-        })
-      ])
-    }
-  },
-```
-
-### adaptor
-
+## cdn-upload-webpack-plugin, 用于将静态资源上传到 cdn
+
+### usage
+
+### 构造函数
+
+```
+  /**
+   * @param {Object} options
+   * @param {Array|String} dirs 待上传的文件目录
+   * @param {Boolean} includeRootDir 文件的相对路径计算时包不包含根目录，默认 true
+   * @param {RegExp|Array<RegExp>} ignores 排除特定文件
+   * @param {Object} client 上传 client 配置，目前只支持 NosClient，不同的 client 配置参数可能不同，以 nos 举例
+   * @param {String} accessId
+   * @param {String} secretKey
+   * @param {String} bucket 桶名
+   * @param {String} namespace 不同项目在使用同一个桶时做隔离
+   */
+  new CdnUploadWebpackPlugin(options)
+```
+
+### 以 vue-cli 项目举例
+
+```
+  configureWebpack: config => {
+    if (process.env.NODE_ENV === 'production') {
+      config.plugins.push(...[
+        new CdnUploadWebpackPlugin({
+          dirs: path.resolve(__dirname, './dist'),
+          ignore: /.html$/,
+          client: {
+            bucket: '',
+            accessId: '',
+            secretKey: '',
+            namespace: 'yidunfe/cdntest'
+          }
+        })
+      ])
+    }
+  },
+```
+
+### adaptor
+
 目前仅支持 nos 上传，后续如有其他的上传需求，可自行扩展 adaptor，可通过 client 参数区分

package/package.json

@@ -1,14 +1,11 @@
 {
   "name": "@yidun/cdn-upload-webpack-plugin",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A webpack plugin for upload dist to cdn.",
   "main": "src/index.js",
   "scripts": {
     "test": "node test/index.js"
   },
-  "files": [
-    "src"
-  ],
   "author": "zhanglulu01",
   "license": "ISC",
   "devDependencies": {

package/src/adaptor/nos.js

@@ -1,45 +1,45 @@
-const { Task } = require('../task')
-const NosClient = require('nos-node-sdk2')
-const { normalizeObjectKey } = require('../utils')
-
-class NosUploadTask extends Task {
-  constructor (nosOptions, file) {
-    super(() => this.upload())
-    const nosClient = new NosClient()
-    const { accessId, secretKey, bucket, endpoint = 'nos.netease.com', port = 80, namespace = '' } = nosOptions
-    nosClient.setAccessId(accessId)
-    nosClient.setSecretKey(secretKey)
-    nosClient.setEndpoint(endpoint)
-    nosClient.setPort(port)
-    this._nosClient = nosClient
-    this._bucket = bucket
-    this._file = file
-    this._namespace = namespace
-  }
-
-  upload () {
-    return new Promise((resolve, reject) => {
-      const putCallback = result => {
-        if (result.statusCode !== 200) {
-          console.error(`upload to nos fail , because ${result}`)
-          return reject(result)
-        }
-        resolve(result)
-      }
-      try {
-        const map = {
-          bucket: this._bucket,
-          filepath: this._file.path,
-          key: normalizeObjectKey(`${this._namespace}/${this._file.relative}`)
-        }
-        // 最大为 100M
-        this._nosClient.put_file(map, putCallback)
-      } catch (error) {
-        console.error(`nos instance init fail , because ${error}`)
-        reject(error)
-      }
-    })
-  }
-}
-
-module.exports = NosUploadTask
+const { Task } = require('../task')
+const NosClient = require('nos-node-sdk2')
+const { normalizeObjectKey } = require('../utils')
+
+class NosUploadTask extends Task {
+  constructor (nosOptions, file) {
+    super(() => this.upload())
+    const nosClient = new NosClient()
+    const { accessId, secretKey, bucket, endpoint = 'nos.netease.com', port = 80, namespace = '' } = nosOptions
+    nosClient.setAccessId(accessId)
+    nosClient.setSecretKey(secretKey)
+    nosClient.setEndpoint(endpoint)
+    nosClient.setPort(port)
+    this._nosClient = nosClient
+    this._bucket = bucket
+    this._file = file
+    this._namespace = namespace
+  }
+
+  upload () {
+    return new Promise((resolve, reject) => {
+      const putCallback = result => {
+        if (result.statusCode !== 200) {
+          console.error(`upload to nos fail , because ${result}`)
+          return reject(result)
+        }
+        resolve(result)
+      }
+      try {
+        const map = {
+          bucket: this._bucket,
+          filepath: this._file.path,
+          key: normalizeObjectKey(`${this._namespace}/${this._file.relative}`)
+        }
+        // 最大为 100M
+        this._nosClient.put_file(map, putCallback)
+      } catch (error) {
+        console.error(`nos instance init fail , because ${error}`)
+        reject(error)
+      }
+    })
+  }
+}
+
+module.exports = NosUploadTask

package/src/index.js

@@ -1,40 +1,43 @@
-const { getFiles } = require('./utils')
-const { TaskDispatcher } = require('./task')
-const NosUploadTask = require('./adaptor/nos')
-
-module.exports = class CdnUploadWebpackPlugin {
-  /**
-   * @param {Object} options
-   * @param {Array|String} dirs 待上传的文件目录
-   * @param {Boolean} includeRootDir 文件的相对路径计算时包不包含根目录，默认 true
-   * @param {RegExp|Array<RegExp>} ignore 排除特定文件
-   * @param {Object} client 上传 client 配置，目前只支持 NosClient，不同的 client 配置参数可能不同，以 nos 举例
-   * @param {String} accessId
-   * @param {String} secretKey
-   * @param {String} bucket 桶名
-   * @param {String} namespace 不同项目在使用同一个桶时做隔离
-   */
-  constructor (options) {
-    const { dirs, includeRootDir, ignore, client } = options
-    this._dirs = dirs
-    this._includeRootDir = includeRootDir
-    this._ignore = ignore
-    this._client = client
-  }
-
-  apply (compiler) {
-    compiler.hooks.afterEmit.tapAsync('CdnUploadWebpackPlugin', (compiler, callback) => {
-      const files = getFiles(this._dirs, this._includeRootDir, this._ignore)
-      const tasks = files.map(file => new NosUploadTask(this._client, file))
-      const taskDispatcher = new TaskDispatcher(tasks, {
-        onSuccess: () => {
-          console.log(`[CdnUploadWebpackPlugin]: assets upload success, now timestamp is ${Date.now()}`)
-          callback()
-        },
-        onError: error => callback(error)
-      })
-      console.log(`[CdnUploadWebpackPlugin]: assets uploading ..., now timestamp is ${Date.now()}`)
-      taskDispatcher.dispatch()
-    })
-  }
-}
+const { getFiles } = require('./utils')
+const { TaskDispatcher } = require('./task')
+const NosUploadTask = require('./adaptor/nos')
+const CdnUploadVitePlugin = require('./vite')
+
+exports.CdnUploadWebpackPlugin = class CdnUploadWebpackPlugin {
+  /**
+   * @param {Object} options
+   * @param {Array|String} dirs 待上传的文件目录
+   * @param {Boolean} includeRootDir 文件的相对路径计算时包不包含根目录，默认 true
+   * @param {RegExp|Array<RegExp>} ignores 排除特定文件
+   * @param {Object} client 上传 client 配置，目前只支持 NosClient，不同的 client 配置参数可能不同，以 nos 举例
+   * @param {String} accessId
+   * @param {String} secretKey
+   * @param {String} bucket 桶名
+   * @param {String} namespace 不同项目在使用同一个桶时做隔离
+   */
+  constructor (options) {
+    const { dirs, includeRootDir, ignores, client } = options
+    this._dirs = dirs
+    this._includeRootDir = includeRootDir
+    this._ignores = ignores
+    this._client = client
+  }
+
+  apply (compiler) {
+    compiler.hooks.afterEmit.tapAsync('CdnUploadWebpackPlugin', (compiler, callback) => {
+      const files = getFiles(this._dirs, this._includeRootDir, this._ignores)
+      const tasks = files.map(file => new NosUploadTask(this._client, file))
+      const taskDispatcher = new TaskDispatcher(tasks, {
+        onSuccess: () => {
+          console.log('CdnUploadWebpackPlugin: assets upload success')
+          callback()
+        },
+        onError: error => callback(error)
+      })
+      console.log('CdnUploadWebpackPlugin: assets uploading ...')
+      taskDispatcher.dispatch()
+    })
+  }
+}
+
+exports.CdnUploadVitePlugin = CdnUploadVitePlugin

package/src/task.js

@@ -1,103 +1,103 @@
-const { noop } = require('./utils')
-
-const TASK_STATUS = {
-  PENDING: 'pending',
-  DOING: 'doing',
-  REJECTED: 'rejected',
-  FULFILLED: 'fulfilled'
-}
-
-let uid = 0 // 任务 id
-/**
- * task 基类，提供重试等功能,供 adaptor 继承，如 NosUploadTask
- */
-class Task {
-  constructor (invoke) {
-    this.status = TASK_STATUS.PENDING
-    this._id = uid++
-    this._invoke = invoke
-    this._retryCount = 3
-  }
-
-  async start () {
-    let retryCount = this._retryCount
-    let res
-    try {
-      this.status = TASK_STATUS.DOING
-      res = await this._invoke()
-    } catch (error) {
-      retryCount--
-      if (retryCount < 0) {
-        this.status = TASK_STATUS.REJECTED
-        return Promise.reject(error)
-      } else {
-        res = await this._invoke()
-      }
-    }
-    this.status = TASK_STATUS.FULFILLED
-    return res
-  }
-}
-
-const PARALLEL_COUNT = 3 // 上传并行数
-/**
- * 任务调度器，完成整个上传任务的调度
- */
-class TaskDispatcher {
-  constructor (tasks, callbacks = {}) {
-    this.status = TASK_STATUS.PENDING
-    this._tasks = tasks
-    this._activeTasks = []
-    this._onError = callbacks.onError || noop
-    this._onSuccess = callbacks.onSuccess || noop
-  }
-
-  getPendingTask (count) {
-    return this._tasks.filter(t => t.status === TASK_STATUS.PENDING).slice(0, count)
-  }
-
-  getPendingTaskCount () {
-    return this._tasks.filter(t => t.status === TASK_STATUS.PENDING).length
-  }
-
-  removeActiveTask (task) {
-    const index = this._activeTasks.findIndex(t => task._id === t._id)
-    if (index > -1) {
-      this._activeTasks.splice(index, 1)
-    }
-  }
-
-  isAllTaskFulfilled () {
-    return this._tasks.every(t => t.status === TASK_STATUS.FULFILLED)
-  }
-
-  /**
-   * 任务调度入口
-   * @param {Number} count
-   */
-  dispatch (count = PARALLEL_COUNT) {
-    if (TASK_STATUS.REJECTED === this.status) return
-
-    this._activeTasks = this._activeTasks.concat(this.getPendingTask(count))
-    this._activeTasks.forEach(task => {
-      if (task.status === TASK_STATUS.PENDING) {
-        task.start().then(res => {
-          this.removeActiveTask(task)
-          if (this.getPendingTaskCount() > 0) {
-            this.dispatch(1)
-          } else if (this.isAllTaskFulfilled()) {
-            this._onSuccess(this._tasks)
-          }
-        }).catch(error => {
-          this.status = TASK_STATUS.REJECTED
-          this._onError(error)
-        })
-      }
-    })
-  }
-}
-
-module.exports = {
-  Task,
-  TaskDispatcher
-}
+const { noop } = require('./utils')
+
+const TASK_STATUS = {
+  PENDING: 'pending',
+  DOING: 'doing',
+  REJECTED: 'rejected',
+  FULFILLED: 'fulfilled'
+}
+
+let uid = 0 // 任务 id
+/**
+ * task 基类，提供重试等功能,供 adaptor 继承，如 NosUploadTask
+ */
+class Task {
+  constructor (invoke) {
+    this.status = TASK_STATUS.PENDING
+    this._id = uid++
+    this._invoke = invoke
+    this._retryCount = 3
+  }
+
+  async start () {
+    let retryCount = this._retryCount
+    let res
+    try {
+      this.status = TASK_STATUS.DOING
+      res = await this._invoke()
+    } catch (error) {
+      retryCount--
+      if (retryCount < 0) {
+        this.status = TASK_STATUS.REJECTED
+        return Promise.reject(error)
+      } else {
+        res = await this._invoke()
+      }
+    }
+    this.status = TASK_STATUS.FULFILLED
+    return res
+  }
+}
+
+const PARALLEL_COUNT = 3 // 上传并行数
+/**
+ * 任务调度器，完成整个上传任务的调度
+ */
+class TaskDispatcher {
+  constructor (tasks, callbacks = {}) {
+    this.status = TASK_STATUS.PENDING
+    this._tasks = tasks
+    this._activeTasks = []
+    this._onError = callbacks.onError || noop
+    this._onSuccess = callbacks.onSuccess || noop
+  }
+
+  getPendingTask (count) {
+    return this._tasks.filter(t => t.status === TASK_STATUS.PENDING).slice(0, count)
+  }
+
+  getPendingTaskCount () {
+    return this._tasks.filter(t => t.status === TASK_STATUS.PENDING).length
+  }
+
+  removeActiveTask (task) {
+    const index = this._activeTasks.findIndex(t => task._id === t._id)
+    if (index > -1) {
+      this._activeTasks.splice(index, 1)
+    }
+  }
+
+  isAllTaskFulfilled () {
+    return this._tasks.every(t => t.status === TASK_STATUS.FULFILLED)
+  }
+
+  /**
+   * 任务调度入口
+   * @param {Number} count
+   */
+  dispatch (count = PARALLEL_COUNT) {
+    if (TASK_STATUS.REJECTED === this.status) return
+
+    this._activeTasks = this._activeTasks.concat(this.getPendingTask(count))
+    this._activeTasks.forEach(task => {
+      if (task.status === TASK_STATUS.PENDING) {
+        task.start().then(res => {
+          this.removeActiveTask(task)
+          if (this.getPendingTaskCount() > 0) {
+            this.dispatch(1)
+          } else if (this.isAllTaskFulfilled()) {
+            this._onSuccess(this._tasks)
+          }
+        }).catch(error => {
+          this.status = TASK_STATUS.REJECTED
+          this._onError(error)
+        })
+      }
+    })
+  }
+}
+
+module.exports = {
+  Task,
+  TaskDispatcher
+}

package/src/utils.js

@@ -1,41 +1,41 @@
-const Promise = require('bluebird')
-const fs = Promise.promisifyAll(require('fs'))
-const path = require('path')
-
-function getFiles (dirs, includeRootDir = true, ignores) {
-  if (typeof dirs === 'string') dirs = [dirs]
-  if (ignores instanceof RegExp) ignores = [ignores]
-
-  const res = []
-  dirs.forEach(dir => deep(dir, dir))
-
-  function deep (dir, rootDir) {
-    const files = fs.readdirSync(dir)
-    files.forEach(fileName => {
-      const pathName = `${dir}${path.sep}${fileName}`
-      const info = fs.lstatSync(pathName)
-      if (info.isDirectory()) {
-        deep(pathName, rootDir)
-      } else {
-        if (!ignores || ignores.every(ignore => !ignore.test(pathName))) {
-          res.push({
-            path: pathName,
-            relative: path.relative(includeRootDir ? path.join(rootDir, '../') : rootDir, pathName)
-          })
-        }
-      }
-    })
-  }
-
-  return res
-}
-
-function normalizeObjectKey (objectKey) {
-  return path.normalize(objectKey).replace(/\\/g, '/')
-}
-
-module.exports = {
-  getFiles,
-  normalizeObjectKey,
-  noop () {}
-}
+const Promise = require('bluebird')
+const fs = Promise.promisifyAll(require('fs'))
+const path = require('path')
+
+function getFiles (dirs, includeRootDir = true, ignores) {
+  if (typeof dirs === 'string') dirs = [dirs]
+  if (ignores instanceof RegExp) ignores = [ignores]
+
+  const res = []
+  dirs.forEach(dir => deep(dir, dir))
+
+  function deep (dir, rootDir) {
+    const files = fs.readdirSync(dir)
+    files.forEach(fileName => {
+      const pathName = `${dir}${path.sep}${fileName}`
+      const info = fs.lstatSync(pathName)
+      if (info.isDirectory()) {
+        deep(pathName, rootDir)
+      } else {
+        if (!ignores || ignores.every(ignore => !ignore.test(pathName))) {
+          res.push({
+            path: pathName,
+            relative: path.relative(includeRootDir ? path.join(rootDir, '../') : rootDir, pathName)
+          })
+        }
+      }
+    })
+  }
+
+  return res
+}
+
+function normalizeObjectKey (objectKey) {
+  return path.normalize(objectKey).replace(/\\/g, '/')
+}
+
+module.exports = {
+  getFiles,
+  normalizeObjectKey,
+  noop () {}
+}

package/src/vite.js

@@ -0,0 +1,38 @@
+const { getFiles } = require('./utils')
+const { TaskDispatcher } = require('./task')
+const NosUploadTask = require('./adaptor/nos')
+
+/**
+ * @param {Object} options
+ * @param {Array|String} dirs 待上传的文件目录
+ * @param {Boolean} includeRootDir 文件的相对路径计算时包不包含根目录，默认 true
+ * @param {RegExp|Array<RegExp>} ignores 排除特定文件
+ * @param {Object} client 上传 client 配置，目前只支持 NosClient，不同的 client 配置参数可能不同，以 nos 举例
+ * @param {String} accessId
+ * @param {String} secretKey
+ * @param {String} bucket 桶名
+ * @param {String} namespace 不同项目在使用同一个桶时做隔离
+ * @returns
+ */
+function CdnUploadVitePlugin (options) {
+  const { dirs, includeRootDir, ignores, client } = options
+  return {
+    name: 'vite-plugin-cdn-upload',
+    closeBundle () {
+      const files = getFiles(dirs, includeRootDir, ignores)
+      const tasks = files.map((file) => new NosUploadTask(client, file))
+      return new Promise((resolve, reject) => {
+        const taskDispatcher = new TaskDispatcher(tasks, {
+          onSuccess: () => {
+            console.log('CdnUploadWebpackPlugin: assets upload success')
+            resolve()
+          },
+          onError: (error) => reject(error)
+        })
+        console.log('CdnUploadWebpackPlugin: assets uploading ...')
+        taskDispatcher.dispatch()
+      })
+    }
+  }
+}
+module.exports = CdnUploadVitePlugin