npmpackage.info

Gathering detailed insights and metrics for find-cache-dir

Other packages similar to find-cache-dir

cache-path

4.0.2

return a cache directory, like `find-cache-dir` do

@visulima/find-cache-dir

1.0.15

Finds the common standard cache directory

pkg-dir

8.0.0

Find the root directory of a Node.js project or npm package

find-parent-dir

0.3.1

Finds the first parent directory that contains a given file or directory.

Gathering detailed insights and metrics for find-cache-dir

find-cache-dir

Finds the common standard cache directory

5.0.0

151

MIT

JavaScript

1.47 kB

8,457,345,418 4.4

Installations

npm install find-cache-dir

Pull Requests

Open

1

Total

28

Closed

8

Merged

19

Issues

Open

2

Total

13

Closed

11

Releases

v5.0.0

Published on 18 Aug 2023

v4.0.0

Published on 04 Nov 2022

v3.3.2

Published on 29 Aug 2021

v3.3.1

Published on 09 Mar 2020

v3.3.0

Published on 22 Feb 2020

v3.2.0

Published on 12 Dec 2019

View all 9 releases

Developer

sindresorhus

Developer Guide

BETA

Module System

ESM

Min. Node Version

>=16

Typescript Support

Yes

Node Version

16.20.0

NPM Version

9.2.0 Statistics

151 Stars

51 Commits

24 Forks

3 Watching

1 Branches

14 Contributors

Updated on 12 Oct 2024

Bundle Size

2.99 kB

Minified

1.47 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (89%)

TypeScript (11%)

Total Downloads

Cumulative downloads

Total Downloads

8,457,345,418

Last day

-8%

7,086,246

Compared to previous day

Last week

1.2%

41,036,528

Compared to previous week

Last month

11.9%

169,272,345

Compared to previous month

Last year

1.2%

1,819,250,555

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

common-path-prefix pkg-dir

Dev Dependencies

ava del tempy tsd xo

Versions

find-cache-dir

Finds the common standard cache directory

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

1# nyc
2./node_modules/.cache/nyc
3
4# ava
5./node_modules/.cache/ava
6
7# your-module
8./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

1npm install find-cache-dir

Usage

1import findCacheDirectory from 'find-cache-dir';
2
3findCacheDirectory({name: 'unicorns'});
4//=> '/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 find-cache-dir, set the CACHE_DIR environment variable to temporarily override the directory that is resolved.

Adopters

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Security-Policy

Determines if the project has published a security policy.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.4

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More