Skip to content

Latest commit

 

History

History
99 lines (65 loc) · 4.36 KB

Cmd-Api.md

File metadata and controls

99 lines (65 loc) · 4.36 KB

#Buildjs命令行API 先确保在linux下已经部署好环境,参照:使用教程之环境安装

所有命令行运行都需要切换到项目所在的文件夹下,才可执行。以下API以项目路径 xx/front为例。



##buildjs -init

初始化配置文件、实时文件监听、同步、html片段文件转化为seajs模块

// 确保项目目录结构与Buildjs给出的标准目录规范一致
xx/front: buildjs -init

在当前文件夹下新建新的文件夹:__ buildjs,用于放置buildjs相关的配置文件;初始化后该文件夹下有五个文件:CONFIG.json、XGETTEXT_CONFIG.json、GETTEXT_CONFIG.json、mconf.log、mrsync.log,分别用于实时文件监听同步&html片段转化、国际化提取待翻译字段、国际化翻译、记录生成seajs前端配置文件的实时文件监听inotifywait的pid、其他文件实时监听&同步的inotifywait的pid。配置文件的字段描述已在文档Build-Process.md详细给出。如果目录结构与标准目录规范不一致,可修改生成的配置文件对应的字段并重启监听脚本。

初始化成功的wording提示:

xx/front: Inotifywait of xx/front/__src/ was started!
Please press ctrl+c to quit the cmd!
Inotifywait of xx/front/conf was started!
Please press ctrl+c to quit the cmd!
|



##buildjs -wstart

启动buildjs实时文件监听+同步+转化

xx/front: buildjs -wstart

此命令用于重启buildjs的实时文件监听功能,wstart为watch start的缩写。当-init不成功时,需要对配置文件进行修改,修正后再运行此命令即可重启监听功能(或已经用过-wstop停止监听,想要重启项目的监听功能)。此命令启动时会先调用-wstop来停止可能已有运行的inotifywait进程,再重新开启。

只要监听的项目文件夹有做任何文件的增删改动作,都会根据变动的文件类型做相应的文件同步、合成或转化。

具体以下三种操作:

  1. 将__src的非view层资源同步到xx/front/src路径下,同时将其view层资源同步到xx/views/src路径下;
  2. 将自定义html片段模板类型.htpl转化为seajs模块,主要是分离在js中编写html字符串,为可选编程方式;
  3. xx/front/conf下的源文件有做变动,则生成新的前端配置文件。



##buildjs -wstop

停止buildjs实时文件监听功能

xx/front: buildjs -wstop

此命令用于停止buildjs的实时文件监听功能,停止后,对__src的任何操作都不会触发文件同步,同时,构建时也不会将 __src的文件先进行实时同步再构建。(这里的逻辑有待改进,应该需要确保构建的时候需要做一次初始化同步,-wstart的脚本也存在一样的问题)



##buildjs -xgettext [lang]

提取待翻译的字符串

参数[lang]:支持多语言,以","隔开,如:en-US,zh-TW,zh-CN

xx/front: buildjs -xgettext en

此命令用于提取代码中需要翻译的字符串,字符串的标记方式遵循以下四种方式:

__('***')
__("***")
__'("***")'
__"('***')"

其中,后两者适合在js中做提取标记,这样不会有在src下源文件的开发预览可能出现的代码报错问题。

默认提出成po文件,会输出到xx/front/__buildjs/i18n文件夹下,文件命名以i18n.{lang}.po格式命名。已存在的po文件不会被提取的直接覆盖,而是保留已经提取且翻译好的条目,并新增后续编码新产生的条目。



##buildjs -gettext [lang]

翻译代码中已做提取标记的字符串

参数[lang]同-xgettext

xx/front: buildjs -gettext en

会以xx/front/__buildjs/i18n/i18n.en.po文件为翻译源,对xx/front/src和xx/views/src中有做提取标记的字符串进行翻译,分别生成到xx/front/en和xx/views/en。



##buildjs -release [lang]

构建发布版本

参数[lang]同-xgettext

xx/front: buildjs -release en

集成构建发布,自动化处理css的图片资源相对路径、css压缩(尚未支持同步请求的合并)、seajs模块合并压缩(包括css转化成的seajs模块)。



##buildjs -v

打印当前buildjs的版本号

~: buildjs -v
// ouput: Version: 1.2.0

读取package.json的version字段。



11/28/2014 By pakinguo