light-toast-lm
v0.0.3
Published
轻量级提示
Downloads
2
Readme
利用 umi-library(father) 做组件打包。
本文的目标是带你开发一个组件库,并走通开发、测试、文档、打包还有发布流程。 参考链接
Features
- ✔︎ 基于 docz 的文档功能
- ✔︎ 基于 rollup 和 babel 的组件打包功能
- ✔︎ 支持 TypeScript
- ✔︎ 支持 cjs、esm 和 umd 三种格式的打包
- ✔︎ esm 支持生成 mjs,直接为浏览器使用
- ✔︎ 支持用 babel 或 rollup 打包 cjs 和 esm
- ✔︎ 支持多 entry
- ✔︎ 支持 lerna
- ✔︎ 支持 css 和 less,支持开启 css modules
- ✔︎ 支持 test
- ✔︎ 支持用 prettier 和 eslint 做 pre-commit 检查
##准备环境
创建目录 mkdir umi-library-demo && cd umi-library-demo 初始化 yarn create umi --library 安装依赖 yarn yarn run dev 浏览器访问 http://127.0.0.1:8001/ 即可看到我们的组件开发环境。
组件打包
组件开发测试完成后,需要打包成不同的产物以适应不同的场景。默认使用 rollup
打包生成三个格式的包:
- cjs: CommonJs,es5,能被 Node 和 打包工具如 webpack 使用。
- esm: ES Module,es6,支持静态分析可以 tree shaking。
- umd: Universal Module Definition 通用包,既能像 cjs 一样被使用,也可以发布到 cdn,通过 script 的方式被浏览器使用。
使用命令
yarn doc:build yarn doc:deploy 发布组件文档
umi-library 默认将文档部署到github.io
, url 规则是 https://{yourname}.github.io/{your-repo},我们需要修改 .fatherrc.js 配置一下文档静态资源的前缀base。
LICENSE
MIT