gulp-commonizor

gulp-commonizor

plugin for building js file to support commonjs

最新版本

0.1.0

Getting Started

This plugin requires Gulp ~3.9.0

安装本插件：

npm install gulp-commonizor --save-dev

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

var commonizor = require('gulp-commonizor');

创建gulp任务

Overview

本gulp插件根据配置将对应文件（比如env.js）输出为.common.js文件（比如env.common.js），输出后的文件可以通过commonJS规范的require方法引入。配合tnpm publish命令打包发布到tnpm上：

tnpm publish

发布到npm以后可以直接通过以下方式引用该组件了：

var env = require('env');

Options

• namespace: 发布到哪个名字空间（可选，值可以是'@ali'/'@alife'等，默认为'@ali'）
• name: 组件名字（可选，请按照组件命名规范命名，默认从package.json的name字段解析）
• type: 组件类型（可选，值可以是lib/ctrl/app，默认从package.json的name字段解析）
• pkg: 组件的package.json对象（可选，默认为根目录下的package.json）
• dest: build目录的相对路径。（可选，默认为'./build')，如果pipe的目录不是build，这里应修改为对应的相对路径
• concat: 是否多个文件拼接打包到一个common.js文件，默认为false

使用方法

在gulpfile.js里加入以下任务（如果要打包到成一个文件则使用concat参数）：

// 方式一：打包每个文件成为单一的.common.js文件
gulp.task('common', function() {
    return gulp.src(['./build/a.js', './build/b.js'])
        .pipe(commonizor())
        .pipe(gulp.dest('./build'));
});
 
// 方式二：打包所有文件为一个.common.js文件
gulp.task('common', function() {
    return gulp.src(['./build/a.js', './build/b.js'])
        .pipe(commonizor({
            concat: true
        })).pipe(gulp.dest('build'));
});

在命令行里运行下面的命令即可打包出xxx.common.js文件。该文件支持commonjs依赖加载标准。

sudo gulp common