4 Star 1 Fork 2

gitee-fe / base-library

加入 Gitee
与超过 800 万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README.md

base-library

介绍

Gitee FE 基础库。

代码组织

使用lerna进行多模块的管理,使用yarn进行依赖管理。

所有的模块放置在/packages/下,不进行发布的包(如演示用模块)在package.json中增加"private": true字段即可。

模块要求

模块名

模块对应的文件夹名字能说明模块的作用,如ui表示组件库,icon表示图标库等。

package.json中的模块名采用@gitee/*的方式,@gitee/后的部分与文件夹名保持一致。

建议模块初始版本为0.8.0,由lerna管理版本发布,稳定时发布到1.0.0版本。

所有模块必须在package.json下的scripts字段中声明以下脚本:

  • lint:进行代码规范检查。
  • build:进行一次完整的构建。
  • build-check:进行快速的构建测试,如使用tsc做类型检查。这一命令的作用是确认构建是否能够通过,并不要求一定有构建产物。
  • test:进行单元或集成测试。

以上命令失败时退出码不为0即可。

代码提交

统一使用约定式提交,常用以下前缀:

  • feat:表示有新功能增加。
  • fix:表示修复BUG。
  • docs:表示补充文档和说明等内容。
  • build:表示修改构建脚本等。
  • test:表示增加或修改测试。
  • ci:表示修改CI/CD相关内容,如代码检查等。
  • chore:表示日常维护,如升级依赖等。
  • refractor:表示对功能和BUG没有影响的内部重构,包括增加注释等。

编码规范

暂时统一使用@ecomfe/eslint-config作为规则集,由reskript提供检测能力,后续讨论后再调整相应的规则。

具体当前的编码规范参考:https://github.com/ecomfe/spec

发布

更新版本

确保没有未提交文件的情况下,使用yarn release发布包,过程中会提示所有包的更新前后版本,确认后继续,会生成相应的提交记录。

通过git log确认提交记录正常,随后git push --follow-tags将最新的代码推送至远端。

注意:更新版本的操作仅能在master分支上操作,且操作完后务必不要再更改提交历史,否则会导致后续的版本更新失败。

发布包

使用lerna publish from-package --registry=xxx命令发布包,选择正确的镜像发布即可。

包索引

包名 作用
ui 导出与antd一致的组件
ui-theme 提供色盘变量、CSS变量,覆盖antd样式
side-navigation 侧边导航组件
reskript-plugins 用于reskript构建的插件
ui-site 组件演示用站点

仓库评论 ( 0 )

你可以在登录后,发表评论

简介

Gitee FE 基础库,使用monorepo管理 展开 收起
TypeScript
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
TypeScript
1
https://gitee.com/gitee-fe/base-library.git
git@gitee.com:gitee-fe/base-library.git
gitee-fe
base-library
base-library
master

搜索帮助