@geoway/online-mapping-ui

在线制图组件库@武汉吉威空间信息技术研究院有限公司

Usage no npm install needed!

<script type="module">
  import geowayOnlineMappingUi from 'https://cdn.skypack.dev/@geoway/online-mapping-ui';
</script>

README

@geoway/online-mapping-ui

在线制图简版组件库

常用命令

# 安装项目依赖
npm install

# 启动开发模式(热替换)
npm run dev

# 生产版本构建
npm run build

# 发布新版本,并根据提交记录自动生成changlong.md
npm run release

# 自动fix代码格式问题
npm run lint

# 运行单元测试
npm run unit

# 运行所有测试
npm test

// version = v1.0.0
npm version patch
// v1.0.1
npm version prepatch
// v1.0.2-0
npm version minor
// v1.1.0
npm version major
// v2.0.0

代码提交

项目推荐采用 git 作为代码管理工具,当通过 git 提交代码时,会采用commitlint进行提交信息校验,信息格式遵循Angular commit convention,以保证每次提交信息清楚明确,有利于回退及问题排查。

代码提交格式:
<类型>(<域>): <主题>

<主体>

<补充>

类型包括:
build: 系统构建后提交
ci: 持续集成脚本或者配置变更
chore: 杂项及周期性任务
docs: 文档变更
feat: 新功能
fix: bug修复
perf: 代码性能优化
refactor: 代码重构(修复bug或者增加新功能)
style: 界面样式变更
test: 添加或者修改测试脚本

主题:
简明阐述本次提交修改的内容

主体(可选):
详细阐述为什么修改,如何修改

补充(可选):
BREAKING CHANGE: 不兼容性更新说明

实例:
bug修复: git commit -a -m "fix(user): 修复user模块用户无法登陆的bug。"
功能开发: git commit -a -m "feat(dashboard): 新增首页导航栏,现在可以正确进行功能页面导航。"
破坏性变更(不兼容性更改): git commit -a -m "feat(mapdoc): 新增地图文档功能。
BREAKING CHANGE: 新保存的地图文档格式将不兼容老版本格式。迁移文档见: xxxx"
文档更新: git commit -a -m "docs: 修复文档中存在的错别字及语法错误。"

详情见: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines

版本发布

// 发布新版本
npm run release

首次使用请运行 `npm run release --first-release`

自动增加 package.json 中的版本号,并作为git tag提交,其利用每次commit标准化提交信息,自动生成版本更新日志,并发布到私有仓库。