generator-module-imweb v0.0.4

Module Generator

Create a module with Yeoman, including grunt-jsdoc and bower.json for publish

安装

如果没安装yo：npm install -g yo

npm install -g generator-module-imweb

新建模块

1. mkdir <package-name>
2. cd <package-name>
3. yo module-imweb

开发

目录说明：

• dist： 压缩合并后的文件
• doc ： 静态文档页面所在目录， index.html 是入口
• src ： 源文件所在目录
• gruntfile.js ： grunt配置文件
• package.json : 开发时包的信息跟依赖
• README.md： 模块说明文档，生成静态文档页面时会作为 index.html
• bower.json： 发布时,作为bower包的信息

组件开发：

1. 修改组件说明文档 README.md
2. 将组件代码放到 src 文件夹，使用 jsdoc3 规则对模块进行注释
3. 命令说明：
   • grunt doc： 自动分析 src 中代码的注释跟 README.md, 在文件夹 doc 中生成html文档
   • grunt dev： 将 src 中的js代码压缩到 dist
   • grunt clean： 清空 doc 跟 dist 文件夹
   • grunt build： 同时运行 grunt doc 跟 grunt dev， 用于最后发布组件

发布

1. 在github上新建对应的远程仓库
2. 添加本地代码，打上版本tag（bower发布需要git仓库上的项目有版本tag）
3. 将代码和tag上传到远程仓库
4. 输入 bower register <module-name> <repository-url>

License

MIT License