Skip to content
This repository has been archived by the owner on Oct 27, 2020. It is now read-only.

Change default cache directory #64

Merged
merged 5 commits into from Apr 16, 2019
Merged

Change default cache directory #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8034e17
chore(na): change default cache directory
mistic Mar 19, 2019
03c22f9
refactor(na): use find-cache-dir to found the cache directory
mistic Mar 19, 2019
99ce2e6
chore(na): remove error changes
mistic Mar 22, 2019
7eb2f3d
Merge remote-tracking branch 'upstream/master'
mistic Mar 27, 2019
bec8bbc
chore(na): merge and solve conflicts with master
mistic Mar 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Expand Up @@ -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

Expand Down
97 changes: 84 additions & 13 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Expand Up @@ -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",
Expand Down
4 changes: 3 additions & 1 deletion src/index.js
View file
Open in desktop
Expand Up @@ -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');
Expand All @@ -19,7 +21,7 @@ const schema = require('./options.json');

const defaults = {
cacheContext: '',
cacheDirectory: path.resolve('.cache-loader'),
cacheDirectory: findCacheDir({ name: 'cache-loader' }) || os.tmpdir(),
mistic marked this conversation as resolved.
Show resolved Hide resolved
cacheIdentifier: `cache-loader:${pkg.version} ${env}`,
cacheKey,
read,
Expand Down