Doumi_framework_web NPM

doumi_framework_web 命令行工具

旨在使得框架核心与业务解耦，提高核心代码的可维护性，同时提供一整套命令行工具，提高开发效率降低学习成本。

框架包含如下内容：

nodejs 与 npm 配合完成的此命令行工具
使用 colors、shelljs、yargs 第三方库

Usage【用法】

1、Installing

sudo npm install -g doumi_framework_web

2、Command Overview 【命令概览】

doumi create --project [project name]	# 等价于 doumi create -p [project name] , 在当前目录创建新项目
doumi create --module [module name]     # 等价于 doumi create -m [module name] , 在当前项目中创建一个页面模块
doumi remove --module [module name]     # 等价于 doumi remove -m [module name] , 在当前项目中移除指定一个页面模块
doumi update          	# 更新框架核心，增量更新
doumi update --all      # 等价于 doumi update -a , 更新框架核心，全量更新
doumi init     			# 在当前文件夹内注入项目
doumi install     		# 安装core
doumi build --client	# 等价于 doumi build -c , 用于构建客户端用项目，相当于gulp build
doumi build —-web       # 等价于 doumi build -w , 用于构建web用项目，相当于 gulp build --web
doumi server -p [port]  # 启动server，供客户端远程调试
doumi --version			# 等价于 doumi -v , 查看版本
doumi -—help			# 等价于 doumi -h , 查看帮助

3、Command reference 【命令参考】

doumi create -p project name *

此命令用于创建一个全新的H5项目，项目名称为你提供的 project name 参数，生成项目的目录结构如下

├── project name -------------------------------- 项目目录
│   ├── core ------------------------------------ 框架核心
│   ├── html ------------------------------------ 业务目录
│   ├── output ---------------------------------- 输出目录

开发者只需要关注的就是业务目录即html目录，html的目录结构介绍点击这里

如何使用这种方式创建项目的话，那么这个项目是一个还没有被git管理的项目，可以手动关联远程仓库：

git remote add origin [rope] # rope 为你要关联的仓库地址

还有一点需要知道，项目中，只有 html 目录会被git管理，核心目录(core) 和输出目录(output) 都不会被管理，所以这也减少了仓库代码，同时屏蔽了核心代码在团队内不同成员间改动不同的问题。

doumi create -m module name *

此命令用于创建一个页面模块，避免手动复制黏贴去开发新的页面模块，提高开发效率

doumi remove -m module name *

此命令用于移除指定的页面模块，注意，该过程是不可逆的，所以请谨慎操作

doumi update *

这是一条核心命令，用于更新框架核心，当框架核心有所变动时，everybody 只需要执行update命令，即可同步最新的框架核心代码，注意，如果不加任何选项，则更新的方式为增量跟新，也就是说你本地的核心代码不会减少任何东西，只会在原来的基础上增加依赖，这种更新的好处是快速，并且不影响应用，坏处是代码可能会有冗余。

doumi update -a *

全量更新框架核心，优点是与远端的核心代码完全同步，缺点是速度较慢。所以如果是平时更新，建议执行执行 doumi update , 如果要上线，建议使用该命令进行核心框架的更新。

doumi init *

该命令也是用于创建项目，更能与 doumi create 相同，唯一不同的是，doumi init 不需要你提供要创建的项目的名称，它会在当前目录注入代码，之所以要这样设计，是因为使用 doumi create 创建的项目需要手动去关联git仓库，假如你已经在本地clone了远程的仓库，那么你只需要进入你的目录执行 doumi init 就ok了。