Deprecate common.getUserHome, advise using os.homedir instead (shelljs#725)

freitagbr · nfischer · commit 522a46dcf4c2 · 2017-06-06T21:10:27.000-07:00
* Deprecate common.getUserHome, advise using os.homedir instead

* Remove common.getUserHome
diff --git a/src/cd.js b/src/cd.js
@@ -1,4 +1,5 @@
 var fs = require('fs');
+var os = require('os');
 var common = require('./common');
 
 common.register('cd', _cd, {});
@@ -8,7 +9,7 @@ common.register('cd', _cd, {});
 //@ Changes to directory `dir` for the duration of the script. Changes to home
 //@ directory if no argument is supplied.
 function _cd(options, dir) {
-  if (!dir) dir = common.getUserHome();
+  if (!dir) dir = os.homedir();
 
   if (dir === '-') {
     if (!process.env.OLDPWD) {
diff --git a/src/common.js b/src/common.js
@@ -155,19 +155,6 @@ function ShellString(stdout, stderr, code) {
 
 exports.ShellString = ShellString;
 
-// Return the home directory in a platform-agnostic way, with consideration for
-// older versions of node
-function getUserHome() {
-  var result;
-  if (os.homedir) {
-    result = os.homedir(); // node 3+
-  } else {
-    result = process.env[(process.platform === 'win32') ? 'USERPROFILE' : 'HOME'];
-  }
-  return result;
-}
-exports.getUserHome = getUserHome;
-
 // Returns {'alice': true, 'bob': false} when passed a string and dictionary as follows:
 //   parseOptions('-a', {'a':'alice', 'b':'bob'});
 // Returns {'reference': 'string-value', 'bob': false} when passed two dictionaries of the form:
@@ -363,7 +350,7 @@ function wrap(cmd, fn, options) {
         });
 
         // Expand the '~' if appropriate
-        var homeDir = getUserHome();
+        var homeDir = os.homedir();
         args = args.map(function (arg) {
           if (typeof arg === 'string' && arg.slice(0, 2) === '~/' || arg === '~') {
             return arg.replace(/^~/, homeDir);
diff --git a/test/cd.js b/test/cd.js
@@ -1,10 +1,10 @@
 import fs from 'fs';
+import os from 'os';
 import path from 'path';
 
 import test from 'ava';
 
 import shell from '..';
-import common from '../src/common';
 import utils from './utils/utils';
 
 const cur = shell.pwd().toString();
@@ -90,16 +90,16 @@ test('cd + other commands', t => {
 
 test('Tilde expansion', t => {
   shell.cd('~');
-  t.is(process.cwd(), common.getUserHome());
+  t.is(process.cwd(), os.homedir());
   shell.cd('..');
-  t.not(process.cwd(), common.getUserHome());
+  t.not(process.cwd(), os.homedir());
   shell.cd('~'); // Change back to home
-  t.is(process.cwd(), common.getUserHome());
+  t.is(process.cwd(), os.homedir());
 });
 
 test('Goes to home directory if no arguments are passed', t => {
   const result = shell.cd();
   t.falsy(shell.error());
   t.is(result.code, 0);
-  t.is(process.cwd(), common.getUserHome());
+  t.is(process.cwd(), os.homedir());
 });
