feat: include only compressible mime types

[nathanchase]

🔗 Linked issue

https://github.com/nuxt/framework/discussions/9626

❓ Type of change

• 📖 Documentation (updates to the documentation or readme)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality like performance)
• ✨ New feature (a non-breaking change that adds functionality)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

The code for compressPublicAssets was double-compressing all image types (including .jpg, .png, .gif, .webp, etc.) when it really should only be compressible static file types that are text-based. I updated the code to use the following list of MIME types, and also added it to the docs for compressPublicAssets:

text/html
text/css
text/plain
text/xml
text/x-component
text/javascript
application/x-javascript
application/javascript
application/json
application/manifest+json
application/vnd.api+json
application/xml
application/xhtml+xml
application/rss+xml
application/atom+xml
application/vnd.ms-fontobject
application/x-font-ttf
application/x-font-opentype
application/x-font-truetype
image/svg+xml
image/x-icon
image/vnd.microsoft.icon
font/ttf
font/eot
font/otf
font/opentype

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly.

[codecov]

Codecov Report

Merging #761 (3cb1219) into main (fc75d47) will increase coverage by 0.03%.
The diff coverage is 100.00%.

❗ Current head 3cb1219 differs from pull request most recent head d5a9c72. Consider uploading reports for the commit d5a9c72 to get more accurate results

@@            Coverage Diff             @@
##             main     #761      +/-   ##
==========================================
+ Coverage   72.27%   72.30%   +0.03%     
==========================================
  Files          57       57              
  Lines        5154     5157       +3     
  Branches      556      555       -1     
==========================================
+ Hits         3725     3729       +4     
+ Misses       1419     1418       -1     
  Partials       10       10              

Impacted Files	Coverage Δ
src/compress.ts	94.93% <100.00%> (+1.51%)	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[pi0]

Thanks for the PR @nathanchase and review @manniL @danielroe.

I think currently, docs is not consistent with implementation. We shall maintain an explicit list (array) of supported mimes. This also allows making it easier to customize by users whereas regex is harder to extend. Also we might include webp to the list as is text based.

[nathanchase]

@pi0 We could use https://www.npmjs.com/package/compressible, or maybe something similar that checks against a known list of compressible mime types.

[nathanchase]

Here's a list that AWS uses: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html#compressed-content-cloudfront-file-types

[nathanchase]

Also we might include webp to the list as is text based.

I was under the understanding that using Brotli/Gzip on .webp files would just increase the file size. I'm unable to find a clear answer to that question in my research, other than image/webp not appearing on any compressible type lists.

[pi0]

compressible uses mime-db, which nitro already stubs into this.

AWS list, seems a great start 👍🏼 Let's not over complicate this.

I was under the understanding that using Brotli/Gzip on .webp files would just increase the file size. I'm unable to find a clear answer to that question in my research, other than image/webp not appearing on any compressible type lists.

You are right. Totally my bad. I meant SVG 🤦🏼‍♂️

[nathanchase]

Take a look at the latest commits and see what you think. Should be good to go.

[pi0]

💯