dojo-amd-converter工具包简介

目前dojo-amd-coverter项目处于alpha版本阶段，它是一个帮助用户实现dojo代码版本升级的工具软件。

AMD模式比传统的dojo模块语法具有更多的优势，但是为了能够充分发挥dojo的AMD特性优势，开发人员经常面临升级和重构大量旧版本的dojo原代码来支持AMD新特性，例如从dojo.provide/dojo.require语法迁移到AMD模式下的define和require方法。我们在项目中讲传统的dojo方式升级到AMD模式，来利用这些最新版本的API特性，那么能够提供一套专门的转化工具包（dojo-amd-converter），这些工作在Dojo 2.0版本的早期的背景下，具有非常重要的作用。

值得注意的是，这个工具只能够覆盖人工转化过程的70%-80%，并且一般情况优于标准的dojo使用方法。通常我们需要等待更多的时间才宣布我们的项目，但是在早期的aplph状态这应该是有用的。我们知道这个工具有相当多的开放性问题需要进行修改，我们也邀请您一起来帮助改进该项目。

我们希望这种目前看来能够帮助将pre-AMD的代码转换为AMD代买的工具可以在整个社区的功能努力的下，成为一个代码迁移的基础工具，更加方便的从Dojo 1.x版本迁移到Dojo2.x。这项工作尚未开始，因为Dojo 2.0现在还没有付诸实施。

它是如何做到这一点的？

基于一个规则的集合，利用Node.js,libxml.js和esprima，解析器将使得现有的Dojo的源码树转化为以下内容

1.non-AMD模块到AMD模块

2.名字空间引用到模块引用

3.传统的HTML自定义属性到HTML5兼容的data-dojo-*

4.传统的i18n bundles到AMD bundles

5.旧版本的dojo API到改进后相应的替代版本

例如，在转化之前你的dojo源代码如下：

dojo.provide("my.namespace.i18n.Bundle");
dojo.requireLocalization("dijit","common");
dojo.requireLocalization("foo.package","Bundle");
dojo.requireLocalization("bar.package","Bundle2");
 
var foo = dojo.i18n.getLocalization("foo.package","Bundle"),bar = dojo.i18n.getLocalization("bar.package","Bundle2",foo.bar),baz = {
        locale: "en-lol",i18n: dojo.i18n.getLocalization("bar.package",this.locale)
    };

转化之后，如下

define([
    "dojo","dojo/i18n","dojo/i18n!bar/package/nls/Bundle2","dojo/i18n!dijit/nls/common","dojo/i18n!foo/package/nls/Bundle"
],function (dojo,i18n,i18nBundle2,i18ncommon,i18nBundle) {
 
    var foo = i18nBundle,bar = i18n.getLocalization("bar.package",baz = {
            locale: "en-lol",i18n: i18n.getLocalization("bar.package",this.locale)
        };
});

使用方法

使用dojo-amd-converter工具，在Mac和Linux平台，可以参考一下步骤：

1. 通过Git下载源代码

git clone --recursive https://github.com/SitePen/dojo-amd-converter.git

2. 更改提供的config.js文件，指明你的项目的一些基本的设置内容，如项目的源路径和目标路径

3. 在项目仓库的目录下，运行提供的shell脚本，指定刚才设定的配置文件

./parse.sh config.js

如果收到一个拒绝权限的错误，你需要利用chmod更改这个shell脚本：

chmod +x parse.sh

config.js的配置选项

1. exludePaths - 一个路径数组参数，包含所有排除在处理之外的路径列表。每个路径应该是一个正则表达式

2. srcDir - 待处理的文件的根目录

3. distDir - 处理后文件的输出目录

4. printOutput - 打印输出内容而不是把他发送到输出目录中

5. makeDeclareAnonymous - 使得declare函数调用匿名而不是留下的第一个参数是匿名。这将避免declare函数创建任何的全局变量

6. removeUnusedDependencies - 删除转换后未引用到的任何依赖关系

7. onlyProcessTemplates - 仅处理template目录下的HTML文件

AMD convert工具软件目前无法运行在windows平台上，是因为他依赖于libxmljs包。

参与方式

这个项目仍处于早期阶段，我们希望它能够被用在向Dojo 2.0的转换工作中。尽管我们目前有许多开放性的问题，但是我们已经明确在我们的项目中使用该工具。dojo-amd-converter这个工具与其他Dojo基金会项目按相同的条款和条件的授权方式相同。

dojo-amd-converter工具包简介

相关推荐