{
"manifest": {
"name": "find-cache-dir",
"version": "3.3.2",
"description": "Finds the common standard cache directory",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/avajs/find-cache-dir.git"
},
"funding": "https://github.com/avajs/find-cache-dir?sponsor=1",
"engines": {
"node": ">=8"
},
"scripts": {
"test": "xo && nyc ava"
},
"files": [
"index.js"
],
"keywords": [
"cache",
"directory",
"dir",
"caching",
"find",
"search"
],
"dependencies": {
"commondir": "^1.0.1",
"make-dir": "^3.0.2",
"pkg-dir": "^4.1.0"
},
"devDependencies": {
"ava": "^2.4.0",
"coveralls": "^3.0.9",
"del": "^4.0.0",
"nyc": "^15.0.0",
"tempy": "^0.4.0",
"xo": "^0.25.3"
},
"nyc": {
"reporter": [
"lcov",
"text"
]
},
"_registry": "npm",
"_loc": "/homez.1033/heliovt/.cache/yarn/v6/npm-find-cache-dir-3.3.2-b30c5b6eff0730731aea9bbd9dbecbd80256d64b-integrity/node_modules/find-cache-dir/package.json",
"readmeFilename": "readme.md",
"readme": "# find-cache-dir [](https://codecov.io/gh/avajs/find-cache-dir/branch/master)\n\n> Finds the common standard cache directory\n\nThe [`nyc`](https://github.com/istanbuljs/nyc) and [`AVA`](https://ava.li) projects decided to standardize on a common directory structure for storing cache information:\n\n```sh\n# nyc\n./node_modules/.cache/nyc\n\n# ava\n./node_modules/.cache/ava\n\n# your-module\n./node_modules/.cache/your-module\n```\n\nThis 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:\n\n```\nrm -rf ./node_modules/.cache\n```\n\nIf you decide to adopt this pattern, please file a PR adding your name to the list of adopters below.\n\n## Install\n\n```\n$ npm install find-cache-dir\n```\n\n## Usage\n\n```js\nconst findCacheDir = require('find-cache-dir');\n\nfindCacheDir({name: 'unicorns'});\n//=> '/user/path/node-modules/.cache/unicorns'\n```\n\n## API\n\n### findCacheDir(options?)\n\nFinds 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.\n\n#### options\n\nType: `object`\n\n##### name\n\n*Required*\\\nType: `string`\n\nShould be the same as your project name in `package.json`.\n\n##### files\n\nType: `string[] | string`\n\nAn 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.\n\n##### cwd\n\nType: `string`\\\nDefault `process.cwd()`\n\nDirectory to start searching for a `package.json` from.\n\n##### create\n\nType: `boolean`\\\nDefault `false`\n\nIf `true`, the directory will be created synchronously before returning.\n\n##### thunk\n\nType: `boolean`\\\nDefault `false`\n\nIf `true`, this modifies the return type to be a function that is a thunk for `path.join(theFoundCacheDirectory)`.\n\n```js\nconst thunk = findCacheDir({name: 'foo', thunk: true});\n\nthunk();\n//=> '/some/path/node_modules/.cache/foo'\n\nthunk('bar.js')\n//=> '/some/path/node_modules/.cache/foo/bar.js'\n\nthunk('baz', 'quz.js')\n//=> '/some/path/node_modules/.cache/foo/baz/quz.js'\n```\n\nThis is helpful for actually putting actual files in the cache!\n\n## Tips\n\n- To test modules using `find-cache-dir`, set the `CACHE_DIR` environment variable to temporarily override the directory that is resolved.\n\n## Adopters\n\n- [`ava`](https://avajs.dev)\n- [`nyc`](https://github.com/istanbuljs/nyc)\n- [`storybook`](https://github.com/storybookjs/storybook)\n- [`babel-loader`](https://github.com/babel/babel-loader)\n- [`eslint-loader`](https://github.com/MoOx/eslint-loader)\n- [More…](https://www.npmjs.com/browse/depended/find-cache-dir)\n\n---\n\n\n",
"licenseText": "MIT License\n\nCopyright (c) Sindre Sorhus (https://sindresorhus.com)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n"
},
"artifacts": [],
"remote": {
"resolved": "https://registry.yarnpkg.com/find-cache-dir/-/find-cache-dir-3.3.2.tgz#b30c5b6eff0730731aea9bbd9dbecbd80256d64b",
"type": "tarball",
"reference": "https://registry.yarnpkg.com/find-cache-dir/-/find-cache-dir-3.3.2.tgz",
"hash": "b30c5b6eff0730731aea9bbd9dbecbd80256d64b",
"integrity": "sha512-wXZV5emFEjrridIgED11OoUKLxiYjAcqot/NJdAkOhlJ+vGzwhOAfcG5OX1jP+S0PcjEn8bdMJv+g2jwQ3Onig==",
"registry": "npm",
"packageName": "find-cache-dir",
"cacheIntegrity": "sha512-wXZV5emFEjrridIgED11OoUKLxiYjAcqot/NJdAkOhlJ+vGzwhOAfcG5OX1jP+S0PcjEn8bdMJv+g2jwQ3Onig== sha1-swxbbv8HMHMa6pu9nb7L2AJW1ks="
},
"registry": "npm",
"hash": "b30c5b6eff0730731aea9bbd9dbecbd80256d64b"
}