0.1.5 • Published 7 years ago
this_is_a_test_module v0.1.5
组件README
Wait for your magic hand!
构建
如果能够确定运行环境仅会在node端,那么可以直接使用es6的源码。
如果运行环境是不确定的,例如同时支持浏览器和node端,则需要进行构建
构建的方式有两种:
方式1: 打包为一个bundle
npm run build
构建结果会输出到 ./dist
目录下,如果需要自定义目录,请修改 ./builder/webpack.config.prod.js
;
构建之后, 将 ./package.json
的 main
修改为你打包后的文件,例如
{
"main": "./dist/bundle.js"
}
方式2: 使用babel进行compile,不打包
这种场景适合 Preact, React, lodash 作为 peerDependencies 的组件, 如果按照 方式1 打包为一个文件的话,会产生冗余,所以仅使用 babel 将es6 的代码转为es5。
npm run compile
编译结果会输出到 ./lib
目录下, 如果需要自定义目录,请修改 package.json
文件中的 script 脚本, 默认为 babel src -d lib
构建之后, 将 ./package.json
的 main
修改为打包后的入口文件,并添加对应的 peerDependencies
例如
{
"main": "./lib/index.js",
"peerDependencies": {
"preact": "^6.0.2",
"preact-redux": "^1.2.0",
"redux": "^3.5.2"
}
}
组件发布规范
基础组件需要完善的测试用例
基础组件影响面大,一旦出现问题,会有连锁效应。所以,一定要有完善的测试用例。另外,发布前一定要测试例通过才能发布。
不兼容的版本一定要发布major版本
比如当前版本号为 v1.3.4
, 修改了一个不向后兼容的功能,发miror 和 patch 版本都会导致依赖的项目出现问题,为了避免对线上项目造成影响,需要升 major 版本,直接升级到 v2.0.0