ranma's Introduction

A converter between CommonJS/AMD/CMD/Module/other

ranma取自同名动漫人物乱马，意指同一个事物的不同形式。

为满足所写的代码能同时运行于server环境和web环境，而不需手动修改，所以做了个转换方法，使得几者之间的模块能够互相等价转化。

需要注意的是AMD模块的写法应遵守文件和模块一对一的原则。

INSTALL

npm install ranma

API

cjsify(code:String):String
- 将代码转换为CommonJS
- 对于AMD和CMD，会将define的factory提取，改写return为module.exports并删除define，如果define父语句有if判断也会删除
- 对于es6 module，会将module和import变为require，export变为exports，export default变为module.exports
- 对于普通文件，会将全局声明的变量作为exports，全局使用的未声明变量作为require
amdify(code:String):String
- 将代码转换为AMD
- 在cjsify的基础上进行define包裹
- 如果代码是CMD不做修改，因为AMD兼容这种写法
cmdify(code:String):String
- 将代码转换为CMD
- 在cjsify的基础上进行define包裹
- 如果code是AMD类型，会进行依赖转化——即将factory的参数改为CMD的require, exports, module固定参数，同时依赖变为require变量声明
type.isCommonJS(code:String):Boolean
- code是否是CommonJS
type.isAMD(code:String):Boolean
- code是否是AMD
type.isCMD(code:String):Boolean
- code是否是CMD
type.isModule(code:String):Boolean
- code是否是es6 module

AMD和CMD的区分依据

是否出现define.amd的判断
factory的参数是否为固定的require, exports, module

License

[MIT License]

ranma's People

Contributors

Stargazers

Watchers

ranma's Issues

下一版本考虑增加es6 module和目前代码之间的转换

将AMD转CMD时,存在文件路径转换不正确的情况.

原项目结构如下图:

通过使用在grunt构建时使用ranma 后的结果:

尝试转换zrender的js为CommonJS时，部分文件报错

https://github.com/ecomfe/zrender/blob/master/src/dep/excanvas.js

    if(ast.first() && ast.first().name() == Es6Node.MODULEBODY) {
           ^
TypeError: Object #<Object> has no method 'first'
    at Object.exports.analyse (e:\code\zrender\node_modules\ranma\type.js:94:12)
    at Object.exports.isCommonJS (e:\code\zrender\node_modules\ranma\type.js:119:11)
    at modify.fileModifier (e:\code\zrender\gulpfile.js:10:29)
    at DestroyableTransform._transform (e:\code\zrender\node_modules\gulp-modify\index.js:18:21)
    at DestroyableTransform.Transform._read (e:\code\zrender\node_modules\through2\node_modules\readable-stream\lib\_st
eam_transform.js:184:10)
    at DestroyableTransform.Transform._write (e:\code\zrender\node_modules\through2\node_modules\readable-stream\lib\_s
ream_transform.js:172:12)
    at doWrite (e:\code\zrender\node_modules\through2\node_modules\readable-stream\lib\_stream_writable.js:237:10)
    at writeOrBuffer (e:\code\zrender\node_modules\through2\node_modules\readable-stream\lib\_stream_writable.js:227:5)
    at DestroyableTransform.Writable.write (e:\code\zrender\node_modules\through2\node_modules\readable-stream\lib\_str
am_writable.js:194:11)
    at write (e:\code\zrender\node_modules\through2\node_modules\readable-stream\lib\_stream_readable.js:623:24)
    at flow (e:\code\zrender\node_modules\through2\node_modules\readable-stream\lib\_stream_readable.js:632:7)
    at DestroyableTransform.pipeOnReadable (e:\code\zrender\node_modules\through2\node_modules\readable-stream\lib\_str
am_readable.js:664:5)

Recommend Projects