grunt-lego-upload

grunt plugin for lego upload

Getting Started

This plugin requires Grunt ~0.4.2

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-lego-upload --save-dev

Or

cnpm install grunt-lego-upload --save-dev

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

grunt.loadNpmTasks('grunt-lego-upload');

The "lego_upload" task

Run this task with grunt lego_upload command.

Overview

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

grunt.initConfig({
  lego_upload: {
    do_insert: {
      options: {
        namespace: '<%= pkg.namespace %>',
        usage: 'insert',                       //`insert` or `update`
        components: {
          'addToAlbum': '0.1.0',               //['0.1.0']
          'featuredItem': ['0.2.0', '0.3.0'],
          'productDetail': '*'                 //upload all versions of this component
        }
      }
    },

    do_update: {
      options: {
        namespace: '<%= pkg.namespace %>',
        usage: 'update',                       //`insert` or `update`
        components: {
          'addToAlbum': '0.1.0',               //['0.1.0']
          'featuredItem': ['0.2.0', '0.3.0'],
          'productDetail': '*'                 //upload all versions of this component
        }
      }
    }
  },
});

Options

options.namespace

Type: String Default value: ''

组件命名空间。required

options.components

Type: Array or Object Default value: undefined

组件配置。required 支持两种配置方式：

1、Array配置：

components: ['featuredItem', 'addToAlbum']

包括组件目录下的所有版本。

2、Object配置：

components: {
  'featuredItem': ['0.1.0', '0.2.0'],
  'addToAlbum': '*'
}

设置特定的组件版本，*代表该组件的所有版本。

options.basedir

Type: String Default value: public

组件根目录的上级目录。组件根目录：path.join(process.cwd(), options.basedir)

options.usage

Type: String Default value: 'insert'

上传操作：新增(insert) 或者 覆盖(update)，默认：新增。

options.mode

Type: String Default value: 'loose'

上传模式：宽容(loose) 或者 严格(strict)， 默认：宽容。

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 released