feat: change default cache directory (#64)

Breaking change: default cache directory is `node_modules/.cache/cache-loader`
webpack-contrib · Apr 16, 2019 · fd1c6d7 · fd1c6d7
1 parent 0eae4e6
commit fd1c6d7
Show file tree

Hide file tree

Showing 4 changed files with 97 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -46,15 +46,15 @@ module.exports = {
 
 ## Options
 
-|         Name          |                       Type                       |                     Default                     | Description                                                                                                                                                            |
-| :-------------------: | :----------------------------------------------: | :---------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-|  **`cacheContext`**   |                    `{String}`                    |                   `undefined`                   | Allows you to override the default cache context in order to generate the cache relatively to a path. By default it will use absolute paths                            |
-|    **`cacheKey`**     |    `{Function(options, request) -> {String}}`    |                   `undefined`                   | Allows you to override default cache key generator                                                                                                                     |
-| **`cacheDirectory`**  |                    `{String}`                    |         `path.resolve('.cache-loader')`         | Provide a cache directory where cache items should be stored (used for default read/write implementation)                                                              |
-| **`cacheIdentifier`** |                    `{String}`                    | `cache-loader:{version} {process.env.NODE_ENV}` | Provide an invalidation identifier which is used to generate the hashes. You can use it for extra dependencies of loaders (used for default read/write implementation) |
-|      **`write`**      | `{Function(cacheKey, data, callback) -> {void}}` |                   `undefined`                   | Allows you to override default write cache data to file (e.g. Redis, memcached)                                                                                        |
-|      **`read`**       |    `{Function(cacheKey, callback) -> {void}}`    |                   `undefined`                   | Allows you to override default read cache data from file                                                                                                               |
-|    **`readOnly`**     |                    `{Boolean}`                   |                   `false`                       | Allows you to override default value and make the cache read only (useful for some environments where you don't want the cache to be updated, only read from it)       |
+|         Name          |                       Type                       |                                   n Default                                             | Description                                                                                                                                                            |
+| :-------------------: | :----------------------------------------------: | :---------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|  **`cacheContext`**   |                    `{String}`                    |                   `undefined`                                           | Allows you to override the default cache context in order to generate the cache relatively to a path. By default it will use absolute paths                            |
+|    **`cacheKey`**     |    `{Function(options, request) -> {String}}`    |                   `undefined`                                           | Allows you to override default cache key generator                                                                                                                     |
+| **`cacheDirectory`**  |                    `{String}`                    |         `findCacheDir({ name: 'cache-loader' }) or os.tmpdir()`         | Provide a cache directory where cache items should be stored (used for default read/write implementation)                                      |
+| **`cacheIdentifier`** |                    `{String}`                    | `cache-loader:{version} {process.env.NODE_ENV}`                         | Provide an invalidation identifier which is used to generate the hashes. You can use it for extra dependencies of loaders (used for default read/write implementation) |
+|      **`write`**      | `{Function(cacheKey, data, callback) -> {void}}` |                   `undefined`                                           | Allows you to override default write cache data to file (e.g. Redis, memcached)                                                                                        |
+|      **`read`**       |    `{Function(cacheKey, callback) -> {void}}`    |                   `undefined`                                           | Allows you to override default read cache data from file                                                                                                               |
+|    **`readOnly`**     |                    `{Boolean}`                   |                   `false`                                               | Allows you to override default value and make the cache read only (useful for some environments where you don't want the cache to be updated, only read from it)       |
 
 ## Examples
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -38,6 +38,7 @@
     "webpack": "^4.0.0"
   },
   "dependencies": {
+    "find-cache-dir": "^2.1.0",
     "loader-utils": "^1.1.0",
     "mkdirp": "^0.5.1",
     "neo-async": "^2.6.0",

diff --git a/src/index.js b/src/index.js
@@ -2,11 +2,13 @@
   import/order
 */
 const fs = require('fs');
+const os = require('os');
 const path = require('path');
 const normalizePath = require('normalize-path');
 const async = require('neo-async');
 const crypto = require('crypto');
 const mkdirp = require('mkdirp');
+const findCacheDir = require('find-cache-dir');
 
 const { getOptions } = require('loader-utils');
 const validateOptions = require('schema-utils');
@@ -19,7 +21,7 @@ const schema = require('./options.json');
 
 const defaults = {
   cacheContext: '',
-  cacheDirectory: path.resolve('.cache-loader'),
+  cacheDirectory: findCacheDir({ name: 'cache-loader' }) || os.tmpdir(),
   cacheIdentifier: `cache-loader:${pkg.version} ${env}`,
   cacheKey,
   read,