Skip to content

Commit 78c2017

Browse files
Sindre SorhusEneris
authored andcommitted
Clarify per-user default config location
Fixes sindresorhus#191 (cherry picked from commit fc9166a)
1 parent 3f5684d commit 78c2017

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

readme.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,8 @@ Default: System default [user config directory](https://github.com/sindresorhus/
276276

277277
Overrides `projectName`.
278278

279+
By default the config is stored in the [system user's config directory](https://github.com/sindresorhus/env-paths#pathsconfig); running under another user reads a different store. Set `cwd` to share across users.
280+
279281
The only use-case I can think of is having the config located in the app directory or on some external storage.
280282

281283
#### fileExtension

source/types.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,13 @@ export type Options<T extends Record<string, unknown>> = {
163163
/**
164164
__You most likely don't need this. Please don't use it unless you really have to.__
165165
166-
The only use-case I can think of is having the config located in the app directory or on some external storage. Default: System default user [config directory](https://github.com/sindresorhus/env-paths#pathsconfig).
166+
Default: System default user [config directory](https://github.com/sindresorhus/env-paths#pathsconfig).
167+
168+
Overrides `projectName`.
169+
170+
By default the config is stored in the [system user's config directory](https://github.com/sindresorhus/env-paths#pathsconfig); running under another user reads a different store. Set `cwd` to share across users.
171+
172+
The only use-case I can think of is having the config located in the app directory or on some external storage.
167173
*/
168174
cwd?: string;
169175

0 commit comments

Comments
 (0)