grunt-kmc

Grunt plugin for KISSY Module Compiler

Getting Started

This plugin requires Grunt ~0.4.1

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-kmc --save-dev

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

grunt.loadNpmTasks('grunt-kmc');

The "kmc" task

Overview

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

grunt.initConfig({
  kmc: {
    options: {
      // Task-specific options go here.
      // for options, please refer to [kmc](https://github.com/daxingplay/ModuleCompiler).
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.packages

Type: Array Default value: []

KISSY package configuration.

options.charset

Type: String Default value: utf-8

output charset.

Usage Examples

Simple Example

grunt.initConfig({
  kmc: {
    main:
        options: {
            packages: [
                {
                    name: 'test',
                    path: 'assets/src',
                    charset: 'gbk'
                }
            ]
        },
        files: [{
            src: 'assets/src/test/index.js',
            dest: 'assets/dist/test/index.combo.js'
        }]
  }
})

For detailed options configuration, please refer kmc homepage.

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

(Nothing yet)

feichang/grunt-kmc