1.5.1 • Published 1 year ago

oss-publish-webpack-plugin v1.5.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago
npm i --save-dev oss-publish-webpack-plugin

该插件可以帮助你在完成前端单页面应用项目在完成编译打包后,将 dist 目录中的内容发布到云计算运营商的对象存储桶(空间)中,点此 查看 目前已支持(和计划支持)的云计算运营商情况。

1. webpack.config.js 配置

下面仅为示例代码,具体详细描述查看下文 构造方法参数描述

const OSSPublishPlugin = require('oss-publish-webpack-plugin')
module.exports = {
  // ......
  plugins: [
    // ...... 等其他webpack插件
    new OSSPublishPlugin({
      // 构造方法配置参数, 下面仅为示例,具体描述见后面构造方法参数描述
      provider: 'qiniu',
      providerConfig:  {
        region: 'Zone_z2',
        accessKey: 'P********************b',
        secretKey: 'd********************A',
        bucket: '{bucketName}'
      },
      autoPublish: true,
      clearPrefixList: ['static/css', 'static/js', 'static/img']
    })
  ]
}

2. vue.config.js 配置(基于 webpack-chain

下面仅为示例代码,具体详细描述查看下文 构造方法参数描述

const OSSPublishPlugin = require('oss-publish-webpack-plugin')
module.exports = {
  // ......
  chainWebpack: config => {
    // ......其他 config 定义逻辑, 
    // Tips: chain-webpack模式支持通过逻辑代码根据当前环境使用对应的发布配置
    config.plugin('oss-plugin').use(OSSPublishPlugin, [{ 
      provider: 'qiniu',
      providerConfig:  { /** ...同上 */ },
      autoPublish: true,
      clearPrefixList: ['static/css', 'static/js', 'static/img']
    }])
  }
}

以下具体介绍 oss-publish-webpack-plugin 支持的构造方法参数

参数名描述类型默认值
provider云计算运营商标识(详见下文 provider 介绍)String'aliyun'
providerConfig 重要运营商SDK对应工具方法的配置对象(详见下文 providerConfig 介绍)Object--
clearPrefixList每次上传文件前需要清空存储桶中文件前缀,如果不传或空数组则代表不需要清空Array[]
autoPublish是否无需命令行询问直接在编译后上传云端, true表示直接上传,false则需要询问后发布Booleanfalse
answerautoPublish 为false时,定义发布前命令行询问后填写的正确回复选项,输入数组内任一值都允许发布Array'y','Y','yes'
thread定义最多支持同时执行的上传任务数,性能和网速越强,数额可以设置越大,建议取数在 1~10之间Number5

provider 云计算运营商标识

运营商名称标识状态支持日期
阿里云 OSSaliyunV0.3.0 已支持2022-12-27
七牛云 KodoqiniuV0.9.0 已支持2022-12-28
腾讯云 COStencentv1.2.0 已支持2022-12-29
华为云 OBShuaweicloudv1.4.0 已支持2023-01-16
亚马逊云 S3awsv1.5.0 BETA2023-01-17

providerConfig 对象存储配置详述

  1. 阿里云 OSS
参数名类型描述
regionString存储桶所在地域名称,以华东1(杭州)为例,Region填写为oss-cn-hangzhou,点击查看公共云下OSS Region详细对照表
accessKeyIdString阿里云账号的accessKeyId。注意:阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维,请登录RAM控制台创建RAM用户
accessKeySecretString阿里云账号的accessKeySecret
bucketString存储桶的名称
  1. 七牛云 Kodo
参数名类型描述
regionString存储空间所在地域标识:华东 Zone_z0、 华北 Zone_z1、 华南 Zone_z2 和 北美 Zone_na0
accessKeyString七牛云账号的accessKey
secretKeyString七牛云账号的secretKey
bucketString存储空间的名称
  1. 腾讯云 COS
参数名类型描述
regionString腾讯云存储桶托管机房分布地区的地域标识,以广州为例,Region填写为ap-guangzhou,点击查看公有云地域列表
secretIdString腾讯云账号的secretId
secretKeyString腾讯云账号的secretKey
bucketString存储桶的名称
  1. 华为云 OBS
参数名类型描述
serverString华为云存储桶地域标识(EndPoint),在存储桶 -> 概览 -> 基本信息 中即可查到 EndPoint
access_key_idString华为云账号的访问密钥ID
secret_access_keyString华为云账号的访问密钥
bucketString存储桶的名称
  1. AWS S3
参数名类型描述
regionString亚马逊云存储空间服务所在地域标识(EndPoint),点此查看AWS服务端点列表
accessKeyIdString亚马逊云账号的访问密钥ID
secretAccessKeyString亚马逊云账号的访问密钥
bucketString存储桶的名称

阿里云OSS存储桶配置引导

七牛云kodo存储桶配置引导

  • 查看七牛云 静态页面管理 引导说明 【温馨提示:本插件会将编译打包后的 dist 目录中 index.html 文件复制出一个新的文件并命名为 errno-404,同时会一并上传到七牛云存储空间,不需要开发者再单独操作】

腾讯云COS存储桶配置引导

华为云OBS存储桶配置引导

亚马逊云 S3 存储桶配置引导

验证中,后续补充...

1.5.1

1 year ago

1.5.0

1 year ago

1.4.0

1 year ago

1.3.0

1 year ago

1.2.3

1 year ago

1.2.2

1 year ago

1.2.1

1 year ago

1.2.0

1 year ago

1.1.0

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago

0.9.0

1 year ago

0.3.0

1 year ago

0.2.1

1 year ago

0.2.0

1 year ago

0.1.0

1 year ago