-
-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add example locations #16
Merged
sindresorhus
merged 9 commits into
sindresorhus:main
from
borekb:15-document-pathsconfig
Mar 8, 2021
Merged
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
3ac82c3
Add example locations of paths.config
borekb 5c41b38
Update paths.config Windows example
borekb f4f8c05
Add examples to path.data, .cache, .log and .temp
borekb 4546c80
Change "e.g." to "for example"
borekb a3ea6d8
Fix typo
borekb ff5b24a
Fix .temp Linux example
borekb 2fff90a
Add examples to index.d.ts
borekb 0b20ba6
Fix example in index.d.ts
borekb cbefe18
Slightly update docs in index.d.ts
borekb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -56,22 +56,51 @@ apps. Pass an empty string to disable it. | |
|
||
Directory for data files. | ||
|
||
Example locations (with the default `nodejs` [suffix](#suffix)): | ||
|
||
- macOS: `~/Library/Application Support/MyApp-nodejs` | ||
- Windows: `%LOCALAPPDATA%\MyApp-nodejs\Data` (e.g., `C:\Users\USERNAME\AppData\Local\MyApp-nodejs\Data`) | ||
- Linux: `~/.local/share/MyApp-nodejs` (or `$XDG_DATA_HOME/MyApp-nodejs`) | ||
|
||
### paths.config | ||
|
||
Directory for config files. | ||
|
||
Example locations (with the default `nodejs` [suffix](#suffix)): | ||
|
||
- macOS: `~/Library/Preferences/MyApp-nodejs` | ||
- Windows: `%APPDATA%\MyApp-nodejs\Config` (e.g., `C:\Users\USERNAME\AppData\Roaming\MyApp-nodejs\Config`) | ||
- Linux: `~/.config/MyApp-nodejs` (or `$XDG_CONFIG_HOME/MyApp-nodejs`) | ||
|
||
### paths.cache | ||
|
||
Directory for non-essential data files. | ||
|
||
Example locations (with the default `nodejs` [suffix](#suffix)): | ||
|
||
- macOS: `~/Library/Caches/MyApp-nodejs` | ||
- Windows: `%LOCALAPPDATA%\MyApp-nodejs\Cache` (e.g., `C:\Users\USERNAME\AppData\Local\MyApp-nodejs\Cache`) | ||
- Linux: `~/.cache/MyApp-nodejs` (or `$XDG_CACHE_HOME/MyApp-nodejs`) | ||
|
||
### paths.log | ||
|
||
Directory for log files. | ||
|
||
Example locations (with the default `nodejs` [suffix](#suffix)): | ||
|
||
- macOS: `~/Library/Logs/MyApp-nodejs` | ||
- Windows: `%LOCALAPPDATA%\MyApp-nodejs\Log` (e.g., `C:\Users\USERNAME\AppData\Local\MyApp-nodejs\Log`) | ||
- Linux: `~/.local/state/MyApp-nodejs` (or `$XDG_STATE_HOME/MyApp-nodejs`) | ||
|
||
### paths.temp | ||
|
||
Directory for temporary files. | ||
|
||
Example locations (with the default `nodejs` [suffix](#suffix)): | ||
|
||
- macOS: `/var/folders/jf/f2twvvvs5jl_m49tf034ffpw0000gn/T/MyApp-nodejs` | ||
- Windows: `%LOCALAPPDATA%\Temp\MyApp-nodejs` (e.g., `C:\Users\USERNAME\AppData\Local\Temp\MyApp-nodejs`; ) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Typo There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in a3ea6d8. |
||
- Linux: `/tmp/MyApp-nodejs` | ||
|
||
--- | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not everyone knows
e.g.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree, improved in 4546c80.