Grunt-nl-builder NPM

grunt-nl-builder

The grunt plugin used by Company NengLong to build html project.

Getting Started

This plugin requires Grunt ~0.4.5

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-nl-builder --save-dev

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

grunt.loadNpmTasks('grunt-nl-builder');

The "nl_builder" task

Overview

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

    grunt.initConfig({
        nl_builder: {
            //你自己的项目名称
            yourProjectName: {
                //build_index_html任务
                build_index_html: {
                    //是否启用build_index_html任务，默认为true
                    enable: true,
                    //buildItem数组
                    buildItemList: [
                        {
                            //脚本类型(dev|pro)，默认为dev
                            scriptType: 'pro',
                            //源文件相对路径
                            srcUrl: 'index.dev.html',
                            //目标文件相对路径
                            destUrl: 'index.html'
                        }
                    ]
                }
            }
        },
    });

规则

占位符

%nlVersion%

%nlVersion% ===》 20151120153000 ，根据当前时间生成一个版本号

%nlVersionForQueryString%

%nlVersionForQueryString% ===》 nlVersion=20151120153000 ,根据当前时间生成一个用于queryString的字符串

buildItem

buildItem.scriptType

当buildItem.scriptType='dev'时，

<script type="text/javascript" charset="utf-8" src="grunt-build/dev/app_config.dev.js?%nlVersionForQueryString%"></script>

===》

<script type="text/javascript" charset="utf-8" src="grunt-build/dev/app_config.dev.js?nlVersion=20151120150523"></script>

当buildItem.scriptType='pro'时，

<script type="text/javascript" charset="utf-8" src="grunt-build/dev/app_config.dev.js?%nlVersionForQueryString%"></script>

===》

<script type="text/javascript" charset="utf-8" src="grunt-build/pro/app_config.min.js?nlVersion=20151120150523"></script>

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.