GithubHelp home page GithubHelp logo

aliyunoss-webpack-plugin's Introduction

##aliyunoss-webpack-plugin webpack的插件,用于自动上传静态资源到阿里的oss上,以便作为静态资源使用,当然你也可以用于自动存储大文件。

Installation

Install the plugin with npm:

$ npm install aliyunoss-webpack-plugin --save-dev

Basic Usage

add the plugin to your webpack config as follows:

var AliyunossWebpackPlugin = require('aliyunoss-webpack-plugin')
var webpackConfig = {
  entry: 'index.js',
  output: {
    path: 'dist',
    filename: 'index_bundle.js'
  },
  plugins: [new AliyunossWebpackPlugin({
    buildPath:'your build path',
    region: 'your region',
    accessKeyId: 'your key',
    accessKeySecret: 'your secret',
    bucket: 'your bucket',
    getObjectHeaders: function(filename) {
      return {
        Expires: 6000
      }
    }
  })]
}

don't depend webpack,just as follows:

var AliyunossWebpackPlugin = require('aliyunoss-webpack-plugin')
var oss = new AliyunossWebpackPlugin({
  buildPath:'your build path',
  region: 'your region',
  accessKeyId: 'your key',
  accessKeySecret: 'your secret',
  bucket: 'your bucket',
  deleteAll: true,
  generateObjectPath: function(filename) {
    return filename
  },
  getObjectHeaders: function(filename) {
    return {
      Expires: 6000
    }
  }
});
oss.apply()

Configuration

The plugin allowed values are as follows:

  • buildPath: 需要上传的文件路径,支持整个文件夹的遍历。支持node-glob风格路径,具体可以参见node-glob的文档
  • region: oss的区域,如:oss-cn-shanghai。
  • accessKeyId: 阿里云的权限访问的key。
  • accessKeySecret: 阿里云的权限访问的secret。
  • bucket: 阿里云OSS上的命名空间。
  • deleteAll: 先删除oss上的代码之后再上传,默认为false
  • generateObjectPath: 函数(可选),函数参数为上传的文件名,必须返回一个字符串作为文件名,默认为文件原名。通过该函数可以让使用者自定义上传的文件名或者修改oss的路径,比如加一个前缀等
  • getObjectHeaders: 函数(可选),函数参数为上传的文件名,返回设置的headers对象,默认为空,具体可以参见ali-oss的文档
  • internal: 使用内网还是外网(可选),默认外网

aliyunoss-webpack-plugin's People

Contributors

daqi avatar iamhades avatar jackfengji avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

aliyunoss-webpack-plugin's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.