kmc
v1.2.2
Published
KISSY Module Compiler
Downloads
290
Readme
ModuleCompiler
简介
KISSY Module Compiler(kmc)是一个基于NodeJS的KISSY模块打包工具,目前适用于KISSY 1.2+的代码打包
如果您有任何问题,请邮件或者来往(daxingplay)上联系我,阿里巴巴厂内用户还可以联系紫英。
特点
- 支持GruntJS,参见grunt-kmc.
- 基于NodeJS,相比于KISSY自带的Java工具,打包快速
- 参照浏览器端的KISSY的config进行配置,无需额外知识,只需要改一下包路径即能快速打包
- 支持混合编码打包,不同的包可以使用不同的编码
- 支持GBK输出
- 支持KISSY 1.3的自动combo功能,可以生成依赖关系文件
- 提供底层依赖分析接口,方便集成到其他工具当中
- 支持map功能,可以使用正则自由替换输出的模块名
版本说明
- 0.0.7版本适用于KISSY 1.2、1.3的打包,目前已经在淘宝多个业务广泛使用,单纯打包没有任何问题,但是不具备依赖分析生成功能,此版本已经不再维护,推荐使用新版本。
- 1.0.0版本开始支持KISSY 1.3的自动combo功能,推荐使用
使用
安装
npm install kmc
or
git clone git://github.com/daxingplay/kmc.git
注意: 新版本的KISSY Module Compiler的npm包已经更名为kmc,如果使用老版本(此版已经不再维护),请npm install module-compiler
编写你的打包脚本
var kmc = require('kmc');
// 这里和KISSY.config一样,先配置包
kmc.config({
packages: [{
'name': 'sh',
'path': '这里建议写绝对路径,即sh这个包所在的目录',
'charset': 'gbk'
}]
});
// 将xxx.js打包为xxx.combine.js,输出编码为GBK
kmc.build('xxx.js', 'xxx.combine.js', 'gbk');
// 用node执行你这个打包脚本就ok啦~
高级使用指南
var kmc = require('kmc');
kmc.config({
// 和KISSY一样,可以配置多个包
packages: [{
'name': 'app1',
'path': 'app1这个包所在目录的绝对路径',
// 这里是指app1这个包中的文件的编码,同一个包内的编码请保持一致
'charset': 'gbk'
}, {
'name': 'app2',
'path': 'app2这个包所在目录的绝对路径',
// 这里是指app2这个包源码的编码
'charset': 'utf-8'
}],
// 可以设置哪些模块不打包进来。注意,这里exclude的是具体的模块名,支持正则
exclude: ['base', 'event'],
// 如果是对一个目录下的所有文件进行打包,可以设置哪些文件不打包进来,支持正则。注意和上面的exclude的配置的区别。
ignoreFiles: ['.combo.js', '-min.js'],
// 输出的文件名后缀,不带.js,比如打包后你想输出为xxx.combine.js,那么这里就配置为:.combine
suffix: '',
// 类似于KISSY的map方法,可以自己定义把模块名中的路径进行替换
map: [
// 这样配置的话,那么,如果原先输出的app1的模块名中含有app1/2.0/字样的话,就会被替换成app1/19891014/
['app1/2.0/', 'app1/19891014/']
],
// 这里设置的是最后打包出来的文件的编码,默认UTF-8,这里的设置相当于是全局设置,下面build中的设置是针对单一打包实例的
charset: 'gbk'
});
/**
* 打包一个文件/目录
* @param src {String} 源文件/目录的绝对路径.
* @param dest {String} 打包出来的文件/目录的路径.
* @param outputCharset {String} 输出编码,这里的设置会覆盖config.charset中的设置,默认UTF-8
* @return {Object} 打包出来的文件信息
*/
kmc.build({
src: 'xxx.js',
dest: 'xxx.combine.js',
outputCharset: 'gbk'
});
更详细的文档,请参见wiki。
API汇总
配置
配置包,返回当前所有配置信息。如果不带参数,直接返回当前所有配置信息。
kmc.config(cfg);
分析依赖
只分析该文件依赖,不打包。
kmc.analyze(src);
打包
打包函数,具体见wiki
kmc.build({
src: '\xxx\xxx\src\a.js', // 需要打包的文件
dest: '\xxx\xxx\build\a.js', // 打包后文件输出的路径
outputCharset: 'gbk', // 所有的输出文件编码,包括依赖文件
depPath: '\xxx\xxx\dep.js' // 依赖文件的路径
});
生成依赖
不打包,只生成KISSY 1.3的自动combo依赖文件
kmc.combo({
src: '', // 需要打包or生成依赖关系的文件
dest: '', // 模块最后输出的路径(fixModuleName === true的时候必须配置这个选项,否则源文件的内容会被修改)
depPath: '', // 依赖文件的输出路径
depCharset: '', // 依赖文件的编码
fixModuleName: '', // 是否给文件添加模块名,默认为true
showFullResult: '' // 函数的return结果会以对象的形式输出丰富的信息
});
获取依赖
kmc.info(inputFile) // => {modules: object, dependencies: object}
清空配置
可以清空config中的设置。因为ModuleCompiler是单例运行,所以如果出现一些特别情况,可以在config前执行clean方法清空之前的配置。
kmc.clean();
CHANGELOG
License
遵守 "MIT":https://github.com/daxingplay/kmc/blob/master/LICENSE.md 协议