[分享]现代化的JavaScript项目make工具:Package.js
jamcode
2012-11-15
Package.js项目地址:http://code.google.com/p/package-js/
Package.js是一个很方便的JavaScript包依赖管理及Make工具。它的设计目标是使浏览器端的JavaScript Component/App 开发更加模块化。如果您只是在开发一个小型的网站,只会混杂在HTML中写几行JS代码用于改善一下用户体验,那么Package.js也许并不适合您。如果您正在开发一个中到大型的WebApp,有几十甚至几百几千个JS文件和CSS文件、HTML模板文件,如果您正在为管理这些JS模块之间的依赖和加载而烦恼,为发布到生产环境时将JS文件合并打包而写Makefile写得头晕,那么,Package.js,这就是你想要的!赶快来了解并使用Package.js吧! Package.js主要包含两个部分
Package.js浏览器端的API参照了CommonJS/AMD规范,兼容此规范的最简单形式,并在此基础扩展了一些语法,以便于开发包含CSS及HTML模板的JavaScript UI组件。 直接来看一下使用Package.js开发的项目的目录结构吧,简单明了: Test ├── dom │ └── Style.js #命名空间为Test.dom.Style的模块文件 ├── init.js #根命名空间初始化文件 ├── _nsconf_.js #Package.js会读取的配置文件 ├── ui │ ├── Button │ │ ├── img │ │ │ └── bg.png │ │ ├── init.js #Test.ui.Button命名空间的模块文件 │ │ ├── style.css #UI组件的CSS文件 │ │ └── tpl.html #UI组件的HTML模板文件 │ └── Form │ ├── init.js │ ├── style.css │ └── tpl.html ├── util │ └── Cookie.js #命名空间为Test.util.Cookie的JS包 └── _xproxy_.html -> ../Package/_xproxy_.html #此文件为Soft Link指向Package.js源码中的Package/_xproxy_.html,用于跨域加载HTML模板文件 使用Package.js,模块的定义语法—— Root/ui/Button/init.js代码: Package.define("Root.ui.Button",["Root.ui.Pane","Root.util.Tpl","Root.util.Event"], function (Pane,Tpl,Event) { //Pane为Root.ui.Pane //Tpl对应Root.util.Tpl //依此类推 //..... }); 与CommonJS的AMD规范不同,在Package.js的语法中,一个JS模块,不但可以依赖其它JS包,还可以依赖CSS及HTML模板文件、及其它的JSON数据文件,并在运行时,获取到依赖的其它文件的内容。定义语法如下: Package.define("NS.ui.Button",["MT.ui.Component"], { tpl:"tpl.html", _style:"style.css" },function (Component) { //通过this.assets.tpl访问tpl.html内容 var bgImgUrl=this.path+"img/bg.png",tpl=this.assets.tpl; function Button(opt) { //也可以通过当前Package对象的_pkgMeta_属性访问assets this.tpl=String2Dom(opt.tpl || Button._pkgMeta_.assets.tpl); } return Button; }) 在浏览器中,可以使用下面的方法导入一个JS模块, 在导入的过程中,Package.js自动帮您做了后勤工作:1、加载这个模块的依赖模块。2、加载依赖的HTML及CSS文件。 Package.imports(["Root.ui.Button"],function (Button) { var btn=new Button(); btn.renderTo(document.body); }); 在开发时,为了模块化,您需要将JS分成一个一个小的模块文件,但发布到生产环境时,为了加载速度上的考虑,您需要将这些JS文件合并成单个的JS文件并压缩,同样,CSS文件也要合并到一起。 借助Package.js,完成这个功能,您只需要写三四行JSON配置代码,执行一个命令,就一切OK了。 //您的打包配置文件 //build-config.json文件内容 { "staticUrls": {"defaults":"http://statics.iwt.macrotarget.com/jslibs/"}, "nsconfs":["../../statics/jslibs/XLib/_nsconf_.js"], "includes":["XLib.apps.MainApp","XLib.ui.*"], "compress":true //使用UglifyJS和UglifyCSS进行压缩 } #执行命令 build.js build-config.json js all.min.js build.js build-config.json css all.min.css #腰不酸了,腿不疼了! 引用 PS:build.js还帮您做掉一个小事:将CSS文件中的background:url()之类的相对路径转换成绝对URL。您在开发时,CSS中url()始终只需要写相对路径,在部署到生产环境时,build.js合并后的CSS会自动将其转换成绝对URL。甚至,如果你有使用IE6 Png AlphaImageLoader滤镜,使用wui4ie6的loader,您在开发时仍然可以在src=里写相对路径,在开发模式下,Package.js也会自动生成使用绝对URL的CSS Rule,在打包时也会对 AlphaImageLoader的src作转换,CSS中永远不需要写绝对URL Package.js相比于其它模块加载器及AMD实现(RequireJS,SeaJS...)有什么优势或缺点?
听完这些简单的介绍或许您对Package.js已经跃跃欲试了,在使用之前,您可以参考下 Package.js的详细文档:http://package-js.googlecode.com/hg/docs/Package.html。 好!不要再用落后的方式开发JavaScript App,不要再做Out Man,赶快使用Package.js吧 ^O^ |