feat(cache): adds option to compress the cache file

[sverweij]

Description

• adds an option to compress the cache file
• 🏕️ some updates in the cache typing

Motivation and Context

The cache file can become quite large. The cache file is also very compressible (both gzip and brotli reduce the file size to 10% of the original or less). My original hunch was that as less i/o is needed this might constitute a net performance gain for large enough code bases. I haven't been able to substantiate that with evidence, though.

However, I decided to still let this in because:

• when you switch compression on, it (only) adds a few milliseconds to the total execution time
• the resulting file is so much smaller, that the trade-off of the few extra milliseconds might be worth it for other reasons

How Has This Been Tested?

• green ci
• additional automated tests

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• Documentation only change
• Refactor (non-breaking change which fixes an issue without changing functionality)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• 📖

  • My change doesn't require a documentation update, or ...
  • it does and I have updated it

• ⚖️

  • The contribution will be subject to The MIT license, and I'm OK with that.
  • The contribution is my own original work.
  • I am ok with the stuff in CONTRIBUTING.md.

[codeclimate]

Code Climate has analyzed commit 40e071b and detected 0 issues on this pull request.

View more on Code Climate.