bin: follow XDG OS conventions for storing data

PR-URL: #1570 Fixes: #175 Fixes: #1124 Reviewed-By: Refael Ackermann <[email protected]>
nodejs · Apr 24, 2019 · 8a83972 · 8a83972
1 parent 8098ebd
commit 8a83972
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -170,7 +170,7 @@ Some additional resources for addons and writing `gyp` files:
 | `--thin=yes`                      | Enable thin static libraries
 | `--arch=$arch`                    | Set target architecture (e.g. ia32)
 | `--tarball=$path`                 | Get headers from a local tarball
-| `--devdir=$path`                  | SDK download directory (default is `~/.node-gyp`)
+| `--devdir=$path`                  | SDK download directory (default is OS cache directory)
 | `--ensure`                        | Don't reinstall headers if already present
 | `--dist-url=$url`                 | Download header tarball from custom URL
 | `--proxy=$url`                    | Set HTTP proxy for downloading header tarball

diff --git a/bin/node-gyp.js b/bin/node-gyp.js
@@ -2,10 +2,10 @@
 
 process.title = 'node-gyp'
 
+var envPaths = require('env-paths')
 var gyp = require('../')
 var log = require('npmlog')
 var os = require('os')
-var path = require('path')
 
 /**
  * Process and execute the selected commands.
@@ -20,7 +20,7 @@ var homeDir = os.homedir()
 if (prog.devDir) {
   prog.devDir = prog.devDir.replace(/^~/, homeDir)
 } else if (homeDir) {
-  prog.devDir = path.resolve(homeDir, '.node-gyp')
+  prog.devDir = envPaths('node-gyp', { suffix: '' }).cache
 } else {
   throw new Error(
     "node-gyp requires that the user's home directory is specified " +

diff --git a/package.json b/package.json
@@ -22,6 +22,7 @@
   "bin": "./bin/node-gyp.js",
   "main": "./lib/node-gyp.js",
   "dependencies": {
+    "env-paths": "^1.0.0",
     "glob": "^7.0.3",
     "graceful-fs": "^4.1.2",
     "mkdirp": "^0.5.0",