数云PC angular1.x 组件库 (不再维护更新)
开发指南 Angular1.x + ES6 开发风格指南 ccms开发指南
# 安装 ccms-components 和相关依赖
npm install --save ccms-components angular angular-resource angular-ui-router
import angular from 'angular';
import ngResource from 'angular-resource';
import uiRouter from 'angular-ui-router';
import ccmsComponents from 'ccms-components';
angular.module('app', [ngResource, uiRouter, ccmsComponents]);
<link rel="stylesheet" href="/node_modules/ccms-components.css">
<script src='/node_modules/angular/angular.js'></script>
<script src='/node_modules/angular-resource/angular-resource.js'></script>
<script src="/node_modules/angular-ui-router/release/angular-ui-router.js"></script>
<script src='/node_modules/ccms-components.js'></script>
使用 ccms-portal 的项目不需要重复打包 ccms-components。
由于 ccms-portal 中已经引入 ccms-components,所以相关项目在使用 webpack 打包时可忽略 ccms-components,配置如下:
externals: {'ccms-components': '\'ccms.components\''}
在 console 中运行下面这条语句可以查看 ccms-components 版本:
angular.module('ccms.components').version
在遵照基本的开发指南基础上,组件库额外的规范:
$cc
为前缀,如 $ccModal
cc-xx
形式提供,如cc-grid
. (cc => ccms-component 首字母)# 对于 ccms-components 组内的人员,在 dev 分支拉取更新
git pull
# 对于 fork 本项目的人员,需要先将本项目添加为一个 git remote,再拉取更新,参考以下操作
# step 1,添加一个 remote
git remote add ccms https://github.com/ShuyunFF2E/ccms-components
# step 2, 在 dev 分支拉取 ccms 的更新
git pull ccms
提交代码的 commit message 和 pull request 标题需按如下格式:
<type>(<scope>): <subject>
<type>
,变更的类型,可用的类型有以下几种:
<scope>
,标记变更的范围,通常为你的模块名<subject>
,用于描述的文字release 脚本
# 正式版本
npm run release -- <version_category: major | minor | patch>
# 测试版本
npm run release -- <version_category: major | minor | patch> --branch <branch_name>
以下是 release 脚本内部所执行的子任务,包含[1, 2, 3]。当 release 脚本出错中断时,可以手动运行对应的脚本进行发布(需要注意参数)。
处理分支,打标签
# 正式版本
npm run prepare-production -- <version_category: major | minor | patch>
# 测试版本
npm run prepare-test -- <version_category: major | minor | patch> --branch <branch_name>
build
# build 代码,产出到 dist/ 中
# 可以指定 git_revision 参数(如 master / v2.0.1 / 0abcdef),默认 build 当前 working tree 代码
npm run build [-- <git_revision>]
发布 npm 包
# 将 dist/ 中 build 好的代码上传到 npm 仓库
npm run publish:package