bundle-checker 🔎📦

> Compare the size of build files in two git branches.

!bundle-chercker

Summary:

- Usage
- Post result as PR comment
- Develop and test locally the CLI

Usage

If cloning a private repository, please make sure the GITHUB_TOKEN env variable is available.
``bash
$ npx bundle-checker compare \
--gitRepository='https://github.com/ramda/ramda.git' \
--installScript='yarn' \
--buildScript='yarn build:es' \
--currentBranch='CrossEye-patch-1' \
--targetBranch='master' \
--buildFilesPatterns='build//.js,build//.css'
`

All parameters are optionals, defaults:

| Parameter | Default |
| ------------------ | ---------------------------------- |
| buildScript | NODE_ENV=production npm run build |
| currentBranch | current branch detected |
| gitRepository | repo where command is run |
| installScript | npm ci |
| prComment | false |
| targetBranch | master |
| buildFilesPatterns | build/\\/\.js,build/\\/\.css |

Post result as PR comment

Add --prComment to post the results as pr Comment after a CI job.

`bash
$ npx bundle-checker --prComment
`

The command needs 3 env variable set:

| var | Desc |
| -------------------------- | ---------------------- |
| _PULL_REQUEST_NUMBER_ | Number of pull request |
| _PULL_REQUEST_SLUG_ | e.g. _facebook/react_ |
| _GITHUB_TOKEN_ | secret to be setup |

> If you're working with Travis, no need to setup env variables PULL_REQUEST_NUMBER or PULL_REQUEST_SLUG.
Those are read from TRAVIS_PULL_REQUEST and TRAVIS_PULL_REQUEST_SLUG automatically.

Develop and test locally the CLI

`bash
$ yarn pack
$ ./bin/run compare
``

> cli scaffoling built with https://github.com/oclif/oclif