Returns the current user's home directory.
$ npm install utils-homedirvar homedir = require( 'utils-homedir' );Returns the current user's home directory.
var home = homedir();
// => e.g., /Users/<username>If unable to locate a home directory, the module returns null.
var home = homedir();
// returns null- This module primarily checks various environment variables to locate a
homedirectory. Note that this approach has security vulnerabilities, as attackers can tamper with environment variables.
var homedir = require( 'utils-homedir' );
console.log( homedir() );To run the example code from the top-level application directory,
$ node ./examples/index.jsTo use the module as a general utility, install the module globally
$ npm install -g utils-homedirUsage: homedir [options]
Options:
-h, --help Print this message.
-V, --version Print package version.
$ homedir
# => e.g., /Users/<username>For local installations, modify the command to point to the local installation directory; e.g.,
$ ./node_modules/.bin/homedirOr, if you have cloned this repository and run npm install, modify the command to point to the executable; e.g.,
$ node ./bin/cliUnit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:
$ make testAll new feature development should have corresponding unit tests to validate correct functionality.
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-covIstanbul creates a ./reports/coverage directory. To access an HTML version of the report,
$ make view-covCopyright © 2015. Athan Reines.