Skip to content

Commit 81a1286

Browse files
committed
Rename package from find-cache-dir to find-cache-directory
1 parent c90e669 commit 81a1286

File tree

5 files changed

+18
-12
lines changed

5 files changed

+18
-12
lines changed

index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The algorithm checks for the `CACHE_DIR` environmental variable and uses it if i
3131
3232
@example
3333
```
34-
import findCacheDirectory from 'find-cache-dir';
34+
import findCacheDirectory from 'find-cache-directory';
3535
3636
findCacheDirectory({name: 'unicorns'});
3737
//=> '/user/path/node-modules/.cache/unicorns'

index.test-d.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
import {expectType} from 'tsd';
22
import findCacheDirectory from './index.js';
33

4-
expectType<string | undefined>(findCacheDirectory({name: 'find-cache-dir'}));
5-
expectType<string | undefined>(findCacheDirectory({name: 'find-cache-dir', files: ['/bar']}));
6-
expectType<string | undefined>(findCacheDirectory({name: 'find-cache-dir', cwd: '/fooz'}));
7-
expectType<string | undefined>(findCacheDirectory({name: 'find-cache-dir', create: true}));
4+
const name = 'find-cache-directory';
5+
6+
expectType<string | undefined>(findCacheDirectory({name}));
7+
expectType<string | undefined>(findCacheDirectory({name, files: ['/bar']}));
8+
expectType<string | undefined>(findCacheDirectory({name, cwd: '/fooz'}));
9+
expectType<string | undefined>(findCacheDirectory({name, create: true}));

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"name": "find-cache-dir",
2+
"name": "find-cache-directory",
33
"version": "5.0.0",
44
"description": "Finds the common standard cache directory",
55
"license": "MIT",
6-
"repository": "sindresorhus/find-cache-dir",
6+
"repository": "sindresorhus/find-cache-directory",
77
"funding": "https://github.com/sponsors/sindresorhus",
88
"author": {
99
"name": "Sindre Sorhus",

readme.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# find-cache-dir
1+
# find-cache-directory
22

33
> Finds the common standard cache directory
44
@@ -24,13 +24,13 @@ rm -rf ./node_modules/.cache
2424
## Install
2525

2626
```sh
27-
npm install find-cache-dir
27+
npm install find-cache-directory
2828
```
2929

3030
## Usage
3131

3232
```js
33-
import findCacheDirectory from 'find-cache-dir';
33+
import findCacheDirectory from 'find-cache-directory';
3434

3535
findCacheDirectory({name: 'unicorns'});
3636
//=> '/user/path/node-modules/.cache/unicorns'
@@ -77,7 +77,7 @@ Create the directory synchronously before returning.
7777

7878
## Tips
7979

80-
- To test modules using `find-cache-dir`, set the `CACHE_DIR` environment variable to temporarily override the directory that is resolved.
80+
- To test modules using this package, set the `CACHE_DIR` environment variable to temporarily override the directory that is resolved.
8181

8282
## Adopters
8383

@@ -87,3 +87,7 @@ Create the directory synchronously before returning.
8787
- [`babel-loader`](https://github.com/babel/babel-loader)
8888
- [`eslint-loader`](https://github.com/MoOx/eslint-loader)
8989
- [More…](https://www.npmjs.com/browse/depended/find-cache-dir)
90+
91+
## Related
92+
93+
- [env-paths](https://github.com/sindresorhus/env-paths) - Get paths for storing things like data, config, cache, etc

test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,5 @@ test('supports CACHE_DIR environment variable', t => {
5353
test('ignores `false` for CACHE_DIR environment variable', t => {
5454
process.env.CACHE_DIR = 'false';
5555

56-
t.not(findCacheDirectory(), path.resolve(__dirname, 'false', 'find-cache-dir'));
56+
t.not(findCacheDirectory(), path.resolve(__dirname, 'false', 'find-cache-directory'));
5757
});

0 commit comments

Comments
 (0)