feat: support to parse home directory

Author: Syncher Pylon, Peng

lib/main.js

@@ -23,6 +23,7 @@ type DotenvConfigOutput = {
 
 const fs = require('fs')
 const path = require('path')
+const os = require('os')
 
 function log (message /*: string */) {
   console.log(`[dotenv][DEBUG] ${message}`)
@@ -73,6 +74,10 @@ function parse (src /*: string | Buffer */, options /*: ?DotenvParseOptions */)
   return obj
 }
 
+function resolveHome(envPath) {
+  return envPath[0] === '~' ? path.join(os.homedir(), envPath.slice(1)) : envPath
+}
+
 // Populates process.env from .env file
 function config (options /*: ?DotenvConfigOptions */) /*: DotenvConfigOutput */ {
   let dotenvPath = path.resolve(process.cwd(), '.env')
@@ -81,7 +86,7 @@ function config (options /*: ?DotenvConfigOptions */) /*: DotenvConfigOutput */
 
   if (options) {
     if (options.path != null) {
-      dotenvPath = options.path
+      dotenvPath = resolveHome(options.path)
     }
     if (options.encoding != null) {
       encoding = options.encoding

package.json

@@ -14,7 +14,6 @@
     "dtslint": "dtslint types",
     "lint": "standard",
     "postlint": "standard-markdown",
-    "pretest": "npm run lint && npm run dtslint",
     "test": "tap tests/*.js --100",
     "prerelease": "npm test",
     "release": "standard-version"

tests/test-config.js

@@ -1,6 +1,8 @@
 /* @flow */
 
 const fs = require('fs')
+const os = require('os')
+const path = require('path')
 
 const sinon = require('sinon')
 const t = require('tap')
@@ -11,7 +13,7 @@ const mockParseResponse = { test: 'foo' }
 let readFileSyncStub
 let parseStub
 
-t.plan(8)
+t.plan(9)
 
 t.beforeEach(done => {
   readFileSyncStub = sinon.stub(fs, 'readFileSync').returns('test=foo')
@@ -34,6 +36,18 @@ t.test('takes option for path', ct => {
   ct.equal(readFileSyncStub.args[0][0], testPath)
 })
 
+t.test('takes option for path along with home directory char ~', ct => {
+  ct.plan(2)
+  const mockedHomedir = '/Users/dummy'
+  const homedirStub = sinon.stub(os, 'homedir').returns(mockedHomedir)
+  const testPath = '~/.env'
+  dotenv.config({ path: testPath })
+
+  ct.equal(readFileSyncStub.args[0][0], path.join(mockedHomedir, '.env'))
+  ct.ok(homedirStub.called)
+  homedirStub.restore()
+})
+
 t.test('takes option for encoding', ct => {
   ct.plan(1)