find-cache-directory

find-cache-directory

Finds the common standard cache directory

The nyc and AVA projects decided to standardize on a common directory structure for storing cache information:

# nyc
./node_modules/.cache/nyc

# ava
./node_modules/.cache/ava

# your-module
./node_modules/.cache/your-module

This module makes it easy to correctly locate the cache directory according to this shared spec. If this pattern becomes ubiquitous, clearing the cache for multiple dependencies becomes easy and consistent:

rm -rf ./node_modules/.cache

Install

npm install find-cache-directory

Usage

import findCacheDirectory from 'find-cache-directory';

findCacheDirectory({name: 'unicorns'});
//=> '/user/path/node-modules/.cache/unicorns'

API

findCacheDirectory(options?)

Finds the cache directory using the given options.

The algorithm checks for the CACHE_DIR environmental variable and uses it if it is not set to true, false, 1 or 0. If one is not found, it tries to find a package.json file, searching every parent directory of the cwd specified (or implied from other options). It returns a string containing the absolute path to the cache directory, or undefined if package.json was never found or if the node_modules directory is unwritable.

options

Type: object

name

Required
Type: string

Should be the same as your project name in package.json.

files

Type: string[]

An array of files that will be searched for a common parent directory. This common parent directory will be used in lieu of the cwd option below.

cwd

Type: string
Default process.cwd()

The directory to start searching for a package.json from.

create

Type: boolean
Default false

Create the directory synchronously before returning.

Tips

• To test modules using this package, set the CACHE_DIR environment variable to temporarily override the directory that is resolved.

Adopters

• ava
• nyc
• storybook
• babel-loader
• eslint-loader
• More…

Related

• env-paths - Get paths for storing things like data, config, cache, etc

Similar packages

Other packages similar to find-cache-directory

cache-manager

cache-manager is a more comprehensive caching solution that provides a consistent API for various storage backends. Unlike find-cache-directory, which only helps in locating a cache directory, cache-manager allows you to manage cache data with features like setting, getting, and deleting cache entries, and supports multiple storage engines.

node-cache

node-cache is a simple in-memory caching module for Node.js. It provides a straightforward API for storing and retrieving data in memory. While find-cache-directory focuses on finding a directory for cache storage, node-cache is about managing cache data directly in memory, which can be faster but is volatile.

app-root-path

app-root-path is a package that helps in finding the root directory of a Node.js project. While it doesn't specifically deal with cache directories, it can be used in conjunction with find-cache-directory to determine paths relative to the project root, which can be useful for organizing cache directories.