env-paths - npm Package Compare versions

Comparing version 2.2.0 to 2.2.1

index.d.ts

@@ -16,2 +16,8 @@ declare namespace envPaths {
 		Directory for data files.
+
+		Example locations (with the default `nodejs` suffix):
+
+		- macOS: `~/Library/Application Support/MyApp-nodejs`
+		- Windows: `%LOCALAPPDATA%\MyApp-nodejs\Data` (for example, `C:\Users\USERNAME\AppData\Local\MyApp-nodejs\Data`)
+		- Linux: `~/.local/share/MyApp-nodejs` (or `$XDG_DATA_HOME/MyApp-nodejs`)
 		*/
@@ -22,2 +28,8 @@ readonly data: string;
 		Directory for data files.
+
+		Example locations (with the default `nodejs` suffix):
+
+		- macOS: `~/Library/Preferences/MyApp-nodejs`
+		- Windows: `%APPDATA%\MyApp-nodejs\Config` (for example, `C:\Users\USERNAME\AppData\Roaming\MyApp-nodejs\Config`)
+		- Linux: `~/.config/MyApp-nodejs` (or `$XDG_CONFIG_HOME/MyApp-nodejs`)
 		*/
@@ -28,2 +40,8 @@ readonly config: string;
 		Directory for non-essential data files.
+
+		Example locations (with the default `nodejs` suffix):
+
+		- macOS: `~/Library/Caches/MyApp-nodejs`
+		- Windows: `%LOCALAPPDATA%\MyApp-nodejs\Cache` (for example, `C:\Users\USERNAME\AppData\Local\MyApp-nodejs\Cache`)
+		- Linux: `~/.cache/MyApp-nodejs` (or `$XDG_CACHE_HOME/MyApp-nodejs`)
 		*/
@@ -34,2 +52,8 @@ readonly cache: string;
 		Directory for log files.
+
+		Example locations (with the default `nodejs` suffix):
+
+		- macOS: `~/Library/Logs/MyApp-nodejs`
+		- Windows: `%LOCALAPPDATA%\MyApp-nodejs\Log` (for example, `C:\Users\USERNAME\AppData\Local\MyApp-nodejs\Log`)
+		- Linux: `~/.local/state/MyApp-nodejs` (or `$XDG_STATE_HOME/MyApp-nodejs`)
 		*/
@@ -40,2 +64,8 @@ readonly log: string;
 		Directory for temporary files.
+
+		Example locations (with the default `nodejs` suffix):
+
+		- macOS: `/var/folders/jf/f2twvvvs5jl_m49tf034ffpw0000gn/T/MyApp-nodejs`
+		- Windows: `%LOCALAPPDATA%\Temp\MyApp-nodejs` (for example, `C:\Users\USERNAME\AppData\Local\Temp\MyApp-nodejs`)
+		- Linux: `/tmp/USERNAME/MyApp-nodejs`
 		*/
@@ -50,2 +80,4 @@ readonly temp: string;
 
+	Note: It only generates the path strings. It doesn't create the directories for you. You could use [`make-dir`](https://github.com/sindresorhus/make-dir) to create the directories.
+
 	@param name - Name of your project. Used to generate the paths.
@@ -52,0 +84,0 @@ @returns The paths to use for your project on current OS.

package.json

 {
 	"name": "env-paths",
-	"version": "2.2.0",
+	"version": "2.2.1",
 	"description": "Get paths for storing things like data, config, cache, etc",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

@@ -1,2 +0,2 @@
-# env-paths [![Build Status](https://travis-ci.org/sindresorhus/env-paths.svg?branch=master)](https://travis-ci.org/sindresorhus/env-paths)
+# env-paths
 
@@ -32,4 +32,6 @@ > Get paths for storing things like data, config, cache, etc
 
-### paths = envPaths(name, [options])
+### paths = envPaths(name, options?)
 
+Note: It only generates the path strings. It doesn't create the directories for you. You could use [`make-dir`](https://github.com/sindresorhus/make-dir) to create the directories.
+
 #### name
@@ -43,3 +45,3 @@
 
-Type: `Object`
+Type: `object`
 
@@ -59,2 +61,8 @@ ##### suffix
 
+Example locations (with the default `nodejs` [suffix](#suffix)):
+
+- macOS: `~/Library/Application Support/MyApp-nodejs`
+- Windows: `%LOCALAPPDATA%\MyApp-nodejs\Data` (for example, `C:\Users\USERNAME\AppData\Local\MyApp-nodejs\Data`)
+- Linux: `~/.local/share/MyApp-nodejs` (or `$XDG_DATA_HOME/MyApp-nodejs`)
+
 ### paths.config
@@ -64,2 +72,8 @@
 
+Example locations (with the default `nodejs` [suffix](#suffix)):
+
+- macOS: `~/Library/Preferences/MyApp-nodejs`
+- Windows: `%APPDATA%\MyApp-nodejs\Config` (for example, `C:\Users\USERNAME\AppData\Roaming\MyApp-nodejs\Config`)
+- Linux: `~/.config/MyApp-nodejs` (or `$XDG_CONFIG_HOME/MyApp-nodejs`)
+
 ### paths.cache
@@ -69,2 +83,8 @@
 
+Example locations (with the default `nodejs` [suffix](#suffix)):
+
+- macOS: `~/Library/Caches/MyApp-nodejs`
+- Windows: `%LOCALAPPDATA%\MyApp-nodejs\Cache` (for example, `C:\Users\USERNAME\AppData\Local\MyApp-nodejs\Cache`)
+- Linux: `~/.cache/MyApp-nodejs` (or `$XDG_CACHE_HOME/MyApp-nodejs`)
+
 ### paths.log
@@ -74,2 +94,8 @@
 
+Example locations (with the default `nodejs` [suffix](#suffix)):
+
+- macOS: `~/Library/Logs/MyApp-nodejs`
+- Windows: `%LOCALAPPDATA%\MyApp-nodejs\Log` (for example, `C:\Users\USERNAME\AppData\Local\MyApp-nodejs\Log`)
+- Linux: `~/.local/state/MyApp-nodejs` (or `$XDG_STATE_HOME/MyApp-nodejs`)
+
 ### paths.temp
@@ -79,5 +105,18 @@
 
+Example locations (with the default `nodejs` [suffix](#suffix)):
 
-## License
+- macOS: `/var/folders/jf/f2twvvvs5jl_m49tf034ffpw0000gn/T/MyApp-nodejs`
+- Windows: `%LOCALAPPDATA%\Temp\MyApp-nodejs` (for example, `C:\Users\USERNAME\AppData\Local\Temp\MyApp-nodejs`)
+- Linux: `/tmp/USERNAME/MyApp-nodejs`
 
-MIT © [Sindre Sorhus](https://sindresorhus.com)
+---
+
+<div align="center">
+	<b>
+		<a href="https://tidelift.com/subscription/pkg/npm-env-paths?utm_source=npm-env-paths&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
+	</b>
+	<br>
+	<sub>
+		Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
+	</sub>
+</div>

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10163

increased by53.82%

Lines of code

135

increased by18.42%

Number of lines in readme file

116

increased by50.65%

No dependency changes