utils-configdir

Config

Returns a directory for user-specific configuration files.

Installation

$ npm install utils-configdir

Usage

var configdir = require( 'utils-configdir' );

configdir( [path] )

Returns a base directory for user-specific configuration files.

var dir = configdir();
// => e.g., /Users/<username>/Library/Preferences

To append a path to the base directory, provide a path argument.

var dir = configdir( 'appname/config' );
// => e.g., /Users/<username>/Library/Preferences/appname/config

On non-windows platforms, if the module is unable to locate the current user's home directory, the module returns null.

// When unable to resolve a home directory...
var dir = configdir();
// returns null

Notes

• On Windows platforms, the module first checks for a LOCALAPPDATA environment variable before checking for an APPDATA environment variable. This means that machine specific user configuration files have precedence over roaming user configuration files.

Examples

var configdir = require( 'utils-configdir' );

console.log( configdir( 'appy/config' ) );

To run the example code from the top-level application directory,

$ node ./examples/index.js

---

CLI

Installation

To use the module as a general utility, install the module globally

$ npm install -g utils-configdir

Usage

Usage: configdir [options]

Options:
  -h,  --help     Print this message.
  -V,  --version  Print package version.

Examples

$ configdir
# => e.g., /Users/<username>/Library/Preferences

For local installations, modify the command to point to the local installation directory; e.g.,

$ ./node_modules/.bin/configdir

Or, if you have cloned this repository and run npm install, modify the command to point to the executable; e.g.,

$ node ./bin/cli

---

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

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-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

---

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.