0.0.11 • Published 5 years ago
myruicomponent v0.0.11
react-component-template
react组件的模版
工程结构
├── LICENSE
├── README.md
├── dist // 产物外链版本
├── esm // 产物ES6版本
├── examples // 示例代码
├── lib // 产物ES5正常版本
├── node_modules
├── package-lock.json
├── package.json
├── rollup.config.js
├── src // 源代码
├── style // 源代码样式
└── webpack.config.js
使用说明
产出三种格式的代码:
dist
: 外链版本,通过script
标签引入esm
: es6语法版本lib
: es5语法常用版本
style独立放置
- 可仅提供
.css
,也可以额外提供.less
和.scss
- 可仅提供
命令
npm run build
: 构建产物npm run start
: 本地启动,默认端口8000
examples
中按照引用包的方式引用了react-component-template
组件,在webpack.config.js
中按照如下配置resolve: { alias: { 'react-component-template': path.resolve(__dirname), }, },
npm run format
: 格式化npm run lint
: 代码校验,配置规则在.eslintrc
中npm run test
: 运行测试用例- 测试用例语法参考:Jest
在
examples/dist
目录下启动服务serve
需要通过npm全局安装npm i -g serve serve -s examples/dist
修改项
package.json
中所有与仓库信息相关的字段,包含name
、repository
、bugs
、homepage
rollup.config.js
中output
相关字段:file
、name
ReactComponentTemplate
是通过script:src
引入方式时对外暴露的组件名
webpack.config.js
中resolve.alias
字段examples
示例中的相关字段需要修改的占位符参看下边描述
占位符号
- 为了保持本工程下载可用,占位符并没有加入一下常用的占位符号,目前有两个占位:
react-component-template
和ReactComponentTemplate
,使用时可按自己组件的名字进行修改 - 维护本仓库的人请勿乱用这两个名称,它们会被基于
yoeman
的脚手架generator-react-component-magic
使用
- 为了保持本工程下载可用,占位符并没有加入一下常用的占位符号,目前有两个占位:
TODO
- 添加自动生成CHANGELOG的脚本 conventional-github-releaser
- 浏览器兼容性这里不做,感兴趣的推荐方案如下:
SAUCELABS
+Nightwatch