@xmqd/webpack-oss-plugin

@xmqd/webpack-oss-plugin 是一款用于在 webpack 构建时自动上传构建资源到阿里云上的 webpack 插件。

Table of Contents

• Installation
• Usage
• Options
• License

Installation

@xmqd/webpack-oss-plugin requires webpack v4.0.0 or higher.

• Install with npm

  $ npm install @xmqd/webpack-oss-plugin --save-dev

• Install with yarn

  $ yarn add @xmqd/webpack-oss-plugin --dev

Usage

• require @xmqd/webpack-oss-plugin

  const OSSPlugin = require('@xmqd/webpack-oss-plugin');

• configure webpack.prod.config.js

  // ...
  plugins: [
      // ...
      new OSSPlugin({
          accessKeyId: 'your oss accessKeyId',
          accessKeySecret: 'your oss accessKeySecret',
          bucket: 'your oss bucket',
          region: 'your oss region',
          isSilent: 'production' !== process.env.NODE_ENV
      }),
      // ...
  ],
  // ...

Options

Required

Name	Type	Default	Description
accessKeyId	{string}	-	阿里云控制台创建的 AccessKey
accessKeySecret	{string}	-	阿里云控制台创建的 AccessKeySecret
bucket	{string}	-	阿里云控制台创建的 bucket 或通过 putBucket 方法创建的 bucket
region	{string}	-	数据中心所在地域

Optional

Name	Type	Default	Description
endpoint	{string}	${bucket}.${region}.aliyuncs.com	阿里云控制台创建的 AccessKey
internal	{boolean}	false	是否通过内网访问，内网访问不收费
cname	{boolean}	false	是否支持上传自定义域名，如果 cname 为 true ，自定义域名需要先同 bucket 进行绑定
isRequestPay	{boolean}	false	bucket 是否开启请求者付费模式
secure	{boolean}	false	是否启用安全协议
timeout	{number}	300000	请求超时毫秒数
exclude	{RegExp}	undefined	不需要上传的文件规则，是一个正则表达式
include	{RegExp}	undefined	需要上传的文件规则，是一个正则表达式
isSilent	{boolean}	false	禁用插件

License

MIT