mirror of
https://github.com/zhigang1992/bundlewatch.git
synced 2026-01-12 22:46:14 +08:00
Update documentation, enforce minimum node version
This commit is contained in:
2
.babelrc
2
.babelrc
@@ -3,7 +3,7 @@
|
||||
[
|
||||
"env",
|
||||
{
|
||||
"targets": { "node": "6.10" }
|
||||
"targets": { "node": "6.11.5" }
|
||||
}
|
||||
]
|
||||
],
|
||||
|
||||
@@ -8,5 +8,4 @@ make bundlesize FLAGS="--help"
|
||||
|
||||
|
||||
Hit us on Slack if you need more information
|
||||
[bundlesize-bundlesize on slack](https://join.slack.com/t/bundlesize-bundlesize/shared_invite/enQtMzUwNjYxNTMwMzcyLWE5NGI4MzZjMjM4MTRlYzllOTMwYzIzZWNjM2MyMjBmMzNjNGM0ZGVhODc2YjFkNzIwMzNkYjk3NzE0MjZkOTc)
|
||||
|
||||
[Join us on Slack](https://join.slack.com/t/bundlesize-bundlesize/shared_invite/enQtMzUwNjYxNTMwMzcyLWE5NGI4MzZjMjM4MTRlYzllOTMwYzIzZWNjM2MyMjBmMzNjNGM0ZGVhODc2YjFkNzIwMzNkYjk3NzE0MjZkOTc) and start contributing
|
||||
|
||||
82
README.md
82
README.md
@@ -1,38 +1,74 @@
|
||||
# bundlesize
|
||||
[](https://circleci.com/gh/bundlesize/bundlesize)
|
||||
<div align="center">
|
||||
<a href="http://bundlesize.io">
|
||||
<img src="https://cdn.rawgit.com/bundlesize/bundlesize.io/master/docs/_assets/logo-large.svg" height="100px">
|
||||
</a>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
[![npm][npm]][npm-url]
|
||||
|
||||
[![bundlesize]https://img.shields.io/badge/bundlesize-checked-green.svg](http://bundlesize.io)
|
||||
[![node][node]][node-url]
|
||||
[![deps][deps]][deps-url]
|
||||
[![builds][builds]][builds-url]
|
||||
[![licenses][licenses]][licenses-url]
|
||||
|
||||
|
||||
<br>
|
||||
<a href="https://npmcharts.com/compare/@bundlesize/bundlesize?minimal=true">
|
||||
<img src="https://img.shields.io/npm/dm/@bundlesize/bundlesize.svg">
|
||||
</a>
|
||||
<a href="https://github.com/@bundlesize/bundlesize/graphs/contributors">
|
||||
<img src="https://img.shields.io/github/contributors/@bundlesize/bundlesize.svg">
|
||||
</a>
|
||||
<h1>bundlesize</h1>
|
||||
<p>
|
||||
bundlesize is a file size checker. Its main purpose is to ensure bundled browser assets don't jump in file size (e.g. added a package that bloaded the slug, wrong import, forgot to minify).
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Inspired by the original [Siddharth Kshetrapal / Bundlesize](https://github.com/siddharthkp/bundlesize)
|
||||
|
||||
# In this fork of bundlesize we are aiming to:
|
||||
# Getting Started and Configuration
|
||||
Follow the documentation on [bundlesize.io](http://bundlesize.io/)
|
||||
|
||||
|
||||
|
||||
## Why the change in direction from the original?
|
||||
- The original bundlesize has entered maintenance mode, pull requests are left hanging, we wanted to reboost the community and start growing bundlesize out
|
||||
- Split store into seperate app -> bundlesize/service with infrastructure as code
|
||||
- Launched documentation website
|
||||
- Enough test coverage to support CD
|
||||
- Node API Support
|
||||
- Lower the barier to contributing
|
||||
- Lots lots more
|
||||
|
||||
|
||||
## Want to help? Join us on slack and find out
|
||||
[bundlesize-bundlesize on slack](https://join.slack.com/t/bundlesize-bundlesize/shared_invite/enQtMzUwNjYxNTMwMzcyLWE5NGI4MzZjMjM4MTRlYzllOTMwYzIzZWNjM2MyMjBmMzNjNGM0ZGVhODc2YjFkNzIwMzNkYjk3NzE0MjZkOTc)
|
||||
|
||||
|
||||
This is a work in progress, watch this space
|
||||
## TODO
|
||||
- [x] Obtain parity with bundlesize (using Node API approach)
|
||||
- [x] Support new features
|
||||
- [x] Split store into service
|
||||
- [ ] Docs on how to CONTRIBUTE/LOCAL SETUP etc
|
||||
- [ ] Better tests
|
||||
- Lower the barrier to contributing, build a trusted community of contributors to have continous improvement
|
||||
|
||||
|
||||
### Additional features:
|
||||
- [x] Config validation to stop users guessing why bundlesize won't work
|
||||
- [x] Better details breakdown
|
||||
- [x] Support branches other than master
|
||||
- [x] Better comparisons between branches, support branches other than master
|
||||
- [x] Support for your own server for storing data
|
||||
- [x] CI Status Reporting improvements
|
||||
- [ ] Show history of bundlesizes over time
|
||||
- [x] New and improved CI behaviour
|
||||
- [ ] Show history of bundlesizes over time (Coming soon)
|
||||
|
||||
|
||||
## Want to help?
|
||||
[See the Contributing docs](_CONTRIBUTING.md) or [Join us on Slack](https://join.slack.com/t/bundlesize-bundlesize/shared_invite/enQtMzUwNjYxNTMwMzcyLWE5NGI4MzZjMjM4MTRlYzllOTMwYzIzZWNjM2MyMjBmMzNjNGM0ZGVhODc2YjFkNzIwMzNkYjk3NzE0MjZkOTc) and start contributing
|
||||
|
||||
### Enabling for CI:
|
||||
https://github.com/login/oauth/authorize?scope=repo%3Astatus&client_id=04fcf325dd26ca2a159f
|
||||
|
||||
[npm]: https://img.shields.io/npm/v/@bundlesize/bundlesize.svg
|
||||
[npm-url]: https://npmjs.com/package/@bundlesize/bundlesize
|
||||
|
||||
[node]: https://img.shields.io/node/v/@bundlesize/bundlesize.svg
|
||||
[node-url]: https://nodejs.org
|
||||
|
||||
[deps]: https://img.shields.io/david/@bundlesize/bundlesize.svg
|
||||
[deps-url]: https://david-dm.org/@bundlesize/bundlesize
|
||||
|
||||
[builds]: https://img.shields.io/circleci/project/github/bundlesize/bundlesize.svg
|
||||
[builds-url]: https://circleci.com/gh/bundlesize/bundlesize
|
||||
|
||||
[licenses-url]: https://img.shields.io/npm/l/@bundlesize/bundlesize.svg
|
||||
[licenses]: https://github.com/bundlesize/bundlesize/master/LICENSE
|
||||
|
||||
@@ -42,9 +42,6 @@
|
||||
"lodash.merge": "^4.6.1",
|
||||
"read-pkg-up": "^3.0.0"
|
||||
},
|
||||
"optionalDepdencies": {
|
||||
"brotli-size": "0.0.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"axios-mock-adapter": "^1.15.0",
|
||||
"babel-cli": "^6.26.0",
|
||||
@@ -67,6 +64,9 @@
|
||||
"jest": {
|
||||
"testEnvironment": "node"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=6.11.5"
|
||||
},
|
||||
"bundlesize": {
|
||||
"files": [
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user