vuecomponent-seed — 一个开箱即用的 Vue 3 组件库模板

最近一个月的时间都在写 Vue3 组件库,踩了不少坑,总结出一个次佳模板,希望能帮助到社区。

引言

组件库的两个重要的部分的体验是开发体验(DX)使用体验(UX);使用体验在于支持的够多,API 设计的足够合理,文档的清晰度。而组件的开发体验可能会被开发者忽视,实际上好的开发体验对于社区的推广和用户提 PR 的意愿和效率都是有正向引导的。

vuecomponent-seed 旨在提供较好的开发体验,较为清晰、美观的文档,助力同学们快速启动组件UI库的开发。

特性

  • 快如闪电的开发启动速度和构建速度
  • 自定义友好,无黑盒代码、无复杂逻辑
  • 基于 Vitepress,拥有它的所有特性的同时,还有更好看的文档、同时支持中英文、支持暗黑模式、支持自定义的代码高亮样式
  • 丰富的脚本,从生成文件到开发,再到构建发布,尽可能的自动化

开发与构建

随着 Vite 的普及,前端开发者总算是可以不用在项目冷启动的时候喝杯咖啡了(不是)。vuecomponent-seed 基于 Vite vue-ts 模板初始化,给开发者提供高效的开发速度。

构建时,vuecomponent-seed 使用 esbuildTypescript 提供几乎是 tsc 上百倍的速度编译效率,极大地缩短了构建时间。

令人遗憾的是,d.ts 的生成仍然依赖 tsc,这个速度也确实无法明显的降低。

文档

基于 Vitepress,自定义了相关的样式。支持 Dark mode,支持 i18n,支持 demo 接入,支持复制 demo 代码(部署站点需支持 HTTPS)。

脚本

自定义了丰富的脚本,包括:

  • 生成入口文件脚本
  • 开发与构建相关脚本
  • 发布脚本

最后,欢迎大家体验,觉得不错的可以给个 star,觉得哪里不好直接提 issue,我会及时响应。

项目地址:vuecomponent-seed

Thanks

© 版权声明
THE END
喜欢就支持一下吧
点赞0 分享