feat: add cache option (options.cache)
#86
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michael-ciniawsky
approved these changes
Dec 13, 2017
src/index.js
Outdated
| @@ -58,6 +62,9 @@ class CompressionPlugin { | |||
|
|
|||
| apply(compiler) { | |||
| compiler.plugin('emit', (compilation, callback) => { | |||
| const cacheDir = | |||
There was a problem hiding this comment.
const { cache, algorithm, ... } = this.options
// or const { options } = this
const cacheDir = this.options.cache === true
? findCacheDir({ name: 'compression-webpack-plugin' })
: this.options.cache;
src/index.js
Outdated
| if (this.options.cache) { | ||
| const cacheKey = serialize({ | ||
| // Invalidate cache after upgrade `zlib` module (build-in in `nodejs`) | ||
| node: process.version, |
src/index.js
Outdated
| query: parse.query || '', | ||
| }; | ||
|
|
||
| let newFile = this.options.asset.replace(/\[(file|path|query)\]/g, (p0, p1) => sub[p1]); |
README.md
Outdated
| @@ -40,6 +40,7 @@ module.exports = { | |||
| |**`test`**|`{RegExp\|Array<RegExp>}`|`.`|All assets matching this `{RegExp\|Array<RegExp>}` are processed| | |||
| |**`include`**|`{RegExp\|Array<RegExp>}`|`undefined`|Files to `include`| | |||
| |**`exclude`**|`{RegExp\|Array<RegExp>}`|`undefined`|Files to `exclude`| | |||
| |**`cache`**|`{Boolean\|String}`|`false`|Enable file caching| | |||
There was a problem hiding this comment.
Could you do me favor and update the options table with the snippet below (add links to option in README)
|**[`name`](#anchor)**|`{Type}`|`<default>`|<description>|
|Name|Type|Default|Description|
|:--:|:--:|:-----:|:----------|
|**[`test`](#test)**|`{RegExp\|Array<RegExp>}`|`.`|All assets matching this `{RegExp\|Array<RegExp>}` are processed|
|**[`include`](#include)**|`{RegExp\|Array<RegExp>}`|`undefined`|Files to `include`|
|**[`exclude`](#exclude)**|`{RegExp\|Array<RegExp>}`|`undefined`|Files to `exclude`|
|**[`cache`](#cache)**|`{Boolean\|String}`|`false`|Enable file caching|
|**[`asset`](#asset)**|`{String}`|`[path].gz[query]`|The target asset name. `[file]` is replaced with the original asset. `[path]` is replaced with the path of the original asset and `[query]` with the query|
|**[`filename`](#filename)**|`{Function}`|`false`|A `{Function}` `(asset) => asset` which receives the asset name (after processing `asset` option) and returns the new asset name|
|**[`algorithm`](#algorithm)**|`{String\|Function}`|`gzip`|Can be `(buffer, cb) => cb(buffer)` or if a `{String}` is used the algorithm is taken from `zlib`|
|**[`threshold`](#threshold)**|`{Number}`|`0`|Only assets bigger than this size are processed. In bytes.|
|**[`minRatio`](#minratio)**|`{Number}`|`0.8`|Only assets that compress better than this ratio are processed|
|**[`deleteOriginalAssets`](#deleteoriginalassets)**|`{Boolean}`|`false`|Whether to delete the original assets or not|
alexander-akait
force-pushed
the
cache-option
branch
from
6cb7b30
to
0edca02
Compare
|
@michael-ciniawsky done. |
michael-ciniawsky
approved these changes
Dec 13, 2017
|
@evilebottnawi Yep, |
michael-ciniawsky
added
status: Approved
and removed
priority: 5 (nice to have)
pr_action: Review
labels
michael-ciniawsky
changed the title
cacheoption (options.cache)cache option (options.cache)
|
@michael-ciniawsky @d3viant0ne we need release 馃槃 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No test here, but tested locally, all works fine 馃槃