Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make brotli-size optional #214

Merged
merged 8 commits into from
May 2, 2018
Merged

Make brotli-size optional #214

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d783078
Move brotli-size to optionalDependencies
styfle Apr 13, 2018
0387ea4
Add warning "Missing optional dependency"
styfle Apr 13, 2018
c9165fa
Bump brotli-size to 0.0.2
styfle Apr 14, 2018
52e72bd
Use prettycli to warn
styfle Apr 14, 2018
589833a
Change brotli-size to peerDependencies
styfle Apr 23, 2018
5e89752
Add note about peer depdendency for brotli-size
styfle Apr 23, 2018
088e8f7
Remove brotli-size
styfle Apr 23, 2018
eecc3f9
Move try/catch around require
styfle Apr 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@
"license": "MIT",
"dependencies": {
"axios": "^0.17.0",
"brotli-size": "0.0.1",
"bytes": "^3.0.0",
"ci-env": "^1.4.0",
"commander": "^2.11.0",
Expand All @@ -49,6 +48,9 @@
"prettycli": "^1.4.3",
"read-pkg-up": "^3.0.0"
},
"optionalDependencies": {
"brotli-size": "0.0.2"
Copy link
Contributor

@edmorley edmorley Apr 22, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure that both npm and yarn install optionalDependencies by default (they just don't exit with a non-zero exit code, if it wasn't able to be installed).

As such with default npm yarn options (which is what most users will use), this PR will solve the installation errors issue, however there will still be install time and size impact from brotli-size. Perhaps instead brotli-size should be removed from package.json entirely - and then users will install manually instead? (Which is what the error message added to src/compressed-size.js says to do anyway; though perhaps it would be good to also have a README.md mention?)

Many thanks for looking into this!

Copy link
Author

@styfle styfle Apr 23, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@edmorley You're right! I changed to peerDependency since this will give a hint to a developer looking at package.json

I also added a note to the README 👍

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately having in peerDependencies will result in warnings being shown when installing with yarn/npm, if it's not installed. Some users fail CI if these warnings are generated. I think the best plan is to omit it from package.json entirely.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@edmorley Yes I can see how that would be misleading for the users who only want to use gzip. I removed it completely now, thanks! 👍

},
"bundlesize": [
{
"path": "./index.js",
Expand Down
10 changes: 8 additions & 2 deletions src/compressed-size.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const { warn } = require('prettycli')
const gzip = require('gzip-size')
const brotli = require('brotli-size')

const getCompressedSize = (data, compression = 'gzip') => {
let size
Expand All @@ -8,7 +8,13 @@ const getCompressedSize = (data, compression = 'gzip') => {
size = gzip.sync(data)
break
case 'brotli':
size = brotli.sync(data)
try {
const brotli = require('brotli-size')
size = brotli.sync(data)
} catch (e) {
warn(`Missing optional dependency. Install it with:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If something else can throw too in brotli.sync, then the message would be misleading, wouldn't it?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@XhmikosR Good point. I fixed this 🔧

npm install --save brotli-size`)
}
break
case 'none':
default:
Expand Down