Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

find-cache-dir

Package Overview
Dependencies
3
Maintainers
2
Versions
11
Issues
File Explorer

Advanced tools

find-cache-dir

Finds the common standard cache directory

    3.3.2latest

Version published
Maintainers
2
Weekly downloads
32,497,441
decreased by-4.44%

Weekly downloads

Changelog

Source

  • Respect name option when CACHE_DIR environment variable is set (#34) 6a378f5

https://github.com/avajs/find-cache-dir/compare/v3.3.1...v3.3.2

Readme

Source

find-cache-dir Coverage Status

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

If you decide to adopt this pattern, please file a PR adding your name to the list of adopters below.

Install

$ npm install find-cache-dir

Usage

const findCacheDir = require('find-cache-dir'); findCacheDir({name: 'unicorns'}); //=> '/user/path/node-modules/.cache/unicorns'

API

findCacheDir(options?)

Finds the cache directory using the supplied 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[] | 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()

Directory to start searching for a package.json from.

create

Type: boolean
Default false

If true, the directory will be created synchronously before returning.

thunk

Type: boolean
Default false

If true, this modifies the return type to be a function that is a thunk for path.join(theFoundCacheDirectory).

const thunk = findCacheDir({name: 'foo', thunk: true}); thunk(); //=> '/some/path/node_modules/.cache/foo' thunk('bar.js') //=> '/some/path/node_modules/.cache/foo/bar.js' thunk('baz', 'quz.js') //=> '/some/path/node_modules/.cache/foo/baz/quz.js'

This is helpful for actually putting actual files in the cache!

Tips

  • To test modules using find-cache-dir, set the CACHE_DIR environment variable to temporarily override the directory that is resolved.

Adopters


Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

Keywords

FAQs

What is find-cache-dir?

Finds the common standard cache directory

Is find-cache-dir popular?

The npm package find-cache-dir receives a total of 25,985,241 weekly downloads. As such, find-cache-dir popularity was classified as popular.

Is find-cache-dir well maintained?

We found that find-cache-dir demonstrated a healthy version release cadence and project activity. It has 2 open source maintainers collaborating on the project.

Last updated on 29 Aug 2021
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc