grunt-dj-qiniu-deploy

0.1.0 • Public • Published

grunt-dj-qiniu-deploy

这个插件是用来将指定的静态资源部署到qiniu

Getting Started

This plugin requires Grunt ~0.4.4

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-dj-qiniu-deploy --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-dj-qiniu-deploy');

The "qiniu" task

Overview

In your project's Gruntfile, add a section named qiniu to the data object passed into grunt.initConfig().

grunt.initConfig({
  qiniu: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.accessKey

Type: String Default: none

qiniu密钥里的AccessKey

options.secretKey

Type: String Default: none

qiniu密钥里的SecretKey

options.bucket

Type: String Default: none

qiniu空间名

options.domain

Type: String Default: http://{bucket}.qiniudn.com

qiniu域名

options.resources

Type: Object Array Default: none

resources中每个对象的数据结构为

{
  cwd: 'test/fixtures',
        pattern: '**/*.*'
}

通过glob模块匹配文件路径

options.keyGen

Type: Function Default:

    function(cwd, file) {
                return file;
            }

文件上传到qiniu上的存储路径(key)生成器,默认是匹配出来的文件路径(相对cwd的路径)

options.ignoreDup

Type: Boolean Default: true

是否忽略重复的文件,默认会判断cdn上是否存在此文件,有则不上传

options.uploadFaildFolder

Type: Boolean Default: true

配置了该参数,在将资源上传到七牛的过程中,不会由于某个文件失败而终止,而是忽略上传失败的文件,并将其复制到指定上传失败目录中,接着上传在一个文件

Usage Examples

可参见test, 目录结构:

    ├── Gruntfile.js
    └── test
    ├── config.js
    ├── expected
    ├── fixtures
    │   ├── css
    │   │   └── grunt_qiniu_deploy_test.css
    │   └── js
    │       └── grunt_qiniu_deploy_test.js
    └── qiniu_deploy_test.js

Gruntfile.js中的配置:

    qiniu: {
            config: {
                options: {
                    accessKey: config.accessKey,
                    secretKey: config.secretKey,
                    bucket: config.bucket,
                    domain: config.domain,
                    resources: [{
                        cwd: 'test/fixtures',
                        pattern: '**/*.*'
                    }]
                }
            }
        }

这个例子中会将test/fixtures下的所有文件上传的qiniu,css上传后的qiniu key:css/grunt_qiniu_deploy_test.css,其他文件类似。

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

  • 0.1.0

Readme

Keywords

Package Sidebar

Install

npm i grunt-dj-qiniu-deploy

Weekly Downloads

1

Version

0.1.0

License

none

Last publish

Collaborators

  • wangxin223