环境依赖:Node、Npm,视频演示:http://ascii.io/a/4384。
npm install yo grunt-cli -g
安装Generator-Clam:
npm install -g generator-clam generator-kissy-gallery
命令:
yo clam:h
:打印帮助yo clam
:初始化一个标准的Projectyo clam:mod
:初始化一个模块yo clam:widget
:初始化一个标准kissy组件,首先创建组件空目录,进入空目录后执行此命令yo clam:widget x.y
:生成一个标准kissy组件的版本,进入到组件目录后执行。其中x.y是版本号yo clam:on
:启动web服务,服务支持SSI,推荐使用grunt server
yo clam:install <git>
:(TODO)git可以是git地址,也可以是Gallery模块名称,都将对应的git项目源码下载到本地,类似svn export
yo clam:search <name>
:(TODO)在Gallery中查找现有的匹配的模块名称yo clam:build
:(TODO)Build一个Page,将引用到的JS/CSS静态合并,并输出结构化好的HTMLyo clam:page
:生成一个Page
部分子业务线的构建命令(TODO):
yo clam:cp
彩票yo clam:trip
旅行yo clam:cph5
彩票h5yo clam:triph5
旅行h5yo clam:wt
网厅yo clam:tcc
充值
初始化完成的项目包含Gruntfile.js模板,可以辅助你完成:
grunt
: 执行构建grunt prepub
:执行预发grunt publish
:执行发布grunt info
:查看当前库git地址grunt newbranch
:创建新daily分支,基于当前版本累加grunt listen
:监听文件修改,实时编译grunt server
:开启本地调试模式
ps:grunt构建任务依赖
grunt-mytps
子任务,该子任务(上传本地图片到CDN并替换地址)依赖python,并需要安装tpsmate。
Generator-Clam 的目标是通过yo clam
来将你引路到Grunt,帮助你更熟练的使用Grunt。
Generator-Clam 面向阿里系前端工程师,帮助你创建标准的KISSY项目结构代码和Widgets代码。
愿景:打造一款无负担的前端开发脚手架工具,打破产品间的代码共享壁垒。
Clam
是 陶清 对于前端模块化开的实践和落地项目,它是一个工具,旨在建立标准的模块开发流程,提高代码共享和项目构建效率,同时提供一个本地轻服务,让我们“可以坐在美丽的沙滩上写代码”。
Clam
之后有两个衍生版本,Clam-tools
和Generator-Clam
。
1,Clam
clam包含一套完整的模块化开发思想,用来规范结构化越来越强的前端页面,Clam创建之初还没有Grunt,Clam用Grunt的思路来提供脚手架,用来应对页面结构较为固定的开发场景。
由于时间仓促,Clam没实现发布、自定义构建和对KISSY的解析,Clam-Tools弥补了这几个空缺,且提供了GUI工具,实现了基于Ant的一键式构建和发布,但前提是你的项目基于SVN发布。另外一个问题在于,实际上没几个前端玩的动Ant。
2013年淘系全面推广基于Gitlab的Assets发布,Generator-Clam与时俱进,延续了Clam模块化的思想,结合Yeoman和Grunt提供了面向淘系前端环境构建脚手架工具,包含前端开发/构建/发布的全流程。Generator-Clam 对代码单元做更自由的定义,根据适用范围,任何代码单元从三个维度管理:
- 项目(project)(代码集合最大单位)
- 模块(module)(业务功能单元,部分业务之间可共用)
- 组件(widget)(可全局共用)
最初Clam独立出了Page,Page本身也是一个模块,这里统一用模块来管理。这里的yo clam:page
只是生成一个引用了KISSY种子的空页面。
yo clam
可以引导你创建三种格式的目录结构,
第一种,src
目录和build
目录平行,src
目录中直接承载代码单元
./
├── build/ - 构建完成后发布目录
├── doc/ - 生成的文档目录
├── Gruntfile.js
└── src/ - 项目源码目录
├── mod1/ - 代码单元1
│ ├── img/
│ ├── index.css
│ ├── index.html
│ └── index.js
├── mod2/ - 代码单元2
│ ├── img/
│ ├── index.css
│ ├── index.html
│ └── index.js
└── widget1/ - 一个Kissy组件
├── 1.0
│ ├── build/
│ ├── demo/
│ │ └── index.html
│ ├── guide/
│ │ └── index.md
│ ├── index.js
│ ├── meta/
│ │ ├── alias.js
│ │ └── modules.js
│ ├── plugin/
│ └── spec/
└── Gruntfile.js
第二种,src
目录中划分出pages
/mods
/widgets
三个目录,主要是为了兼容老的Clam项目
第三种,代码单元和build
目录平行,即无src
目录:
./
├── build/
├── doc/
├── Gruntfile.js
├── index.css - 入口css文件样板
├── index.html - 入口html文件样板
├── index.js - 入口js文件样板
├── mod1/ - 模块1
│ ├── img/
│ ├── index.css
│ ├── index.html
│ └── index.js
├── mod2/ - 模块2
│ ├── img
│ ├── index.css
│ ├── index.html
│ └── index.js
└── widget1/ - 一个kissy组件
├── 1.0/
│ ├── build/
│ ├── demo/
│ │ └── index.html
│ ├── guide/
│ │ └── index.md
│ ├── index.js
│ ├── meta/
│ │ ├── alias.js
│ │ └── modules.js
│ ├── plugin/
│ └── spec/
└── Gruntfile.js
以上三种目录结构中,widget均和KissyGallery标准组件保持一致。
1,创建新项目
yo clam
构建新项目时会生成Gruntfile.js。之后你只需特别关注Gruntfile.js即可。
2,接手项目
如果你要接手一个项目,代码检出后即可进行调试;在运行grunt
命令之前需要运行npm install --link
。
3,标准格式的KISSY组件
KISSY标准组件的构建使用yo kissy-gallery x.y
,已经被映射为yo clam:widget
,KISSY标准组件是可以直接构建为可发布到淘宝CDN的代码,并提交至kissy gallery
中。因此,你的项目中所有widgets都应当和KISSY标准组件格式保持一致,方便被其他项目使用。
Generator-clam 提供一个轻服务(只提供静态文件服务器、Flex-Combo 和SSI支持),启动服务后你可以这样访问Demo:
http://localhost:8888/src/pages/detail.html?ks-debug
这里的SSI兼容apache,但这个Server还是功能很弱,且不支持脚本,我们强烈建议您使用更成熟的apache+php来作为本地demo服务,Clam只作为构建工具使用。
为了限制在daily分支上发布,我们将grunt构建也加了限制,非daily分支上禁止构建,(你当然可以随意修改Gruntfile.js去掉限制),只有build目录中的文件会被发布,所发布的项目中build目录中的文件地址为,前缀自选
http://a.tbcdn.cn/g/group-name/project-name/x.y.z/mods.js
对应到 g.tbcdn.cn 的地址:
http://g.tbcdn.cn/group-name/project-name/x.y.z/mods.js
1,'yo clam'安装node模块的时候报错?
npm ERR! Error: EACCES, mkdir '/usr/local/lib/node_modules/grunt-xx'
- 原因:没有sudo
- 解决办法:在当前目录执行
sudo npm install
2,tpsmate安装完了还是不能把图片自动上传CDN?
- 原因:需要首先找到
node_modules
中手动执行一次 - 解决办法:进入
node_modules/grunt-mytps/tasks/lib/tpsmate/src
,执行python ./cli.py upload
,这时提示你输入TMS用户名和密码,完成即可
3,tpsmate安装完成,但执行报错?
-
原因:依赖包不完整
-
解决办法:安装依赖
pip install -r node_modules/grunt-mytps/tasks/lib/tpsmate/src/requirements.txt
4,yo clam 构建好目录结构后安装npm包时间太长,怎么办?
- 原因:构建项目最后使用
npm install
安装npm包 - 解决办法:在首次构建项目的时候最后一步询问是否安装本地
node_modules
,输入N
,在当前目录使用npm install --link
,将包安装到全局。以后每次yo clam
最后都不安装本地包,使用npm install --link
来安装,速度会很快。
5,yo clam:mod 构建好一个模块后,怎么运行它?
直接访问生成好的html文件,xx/index.html?ks-debug
,会有弹框"ok"。
6,生成的默认Gruntfile.js只根据入口文件合并JS,我如何生成依赖关系表mods.js ?
修改Gruntfile.js,参照注释修改kmc任务。有一点需要注意,如果要生成依赖关系表,你的JS源文件必须带有模块名定义,比如:
// 模块名不能省略
KISSY.add('grp/header/index',function(S){
// your code
});
7,grunt server
启动报错Error: listen EACCES。
在Mac/Linux下需要root权限才能启用80端口,加上sudo
sudo grunt server
8,grunt server
为什么会提示Error: listen EADDRINUSE。
Flex Combo所需要使用的端口正在被使用中,如果这个端口是80端口,你需要检查系统中是否有其他web容器,比如Apache、Nginx等是否使用了80端口。如果不是,你需要检查是否系统中有其他Flex Combo正在运行。
- include JS和CSS文件的提取合并
- JSON接口模拟和映射
- 各条业务线的固定构建脚本
yo clam:install
/yo clam:list
,安装和查找Gallery模块