Package Exports

find-config

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (find-config) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

`find-config`

Finds the first matching config file, if any, in the current directory or the nearest ancestor directory. Supports finding files within a subdirectroy of an ancestor directory. Configurable with defaults set to support the XDG Base Directory Specification for configuration files.

Because this module is intended to find consistently named configuration files, it is case-sensitive and does not support globs. If you need a more generic solution, see findup-sync or look-up.

Algorithm

Where X is the current directory:

If X/file.ext exists, return it. STOP
If X/.dir/file.ext exists, return it. STOP
If X has a parent directory, change X to parent. GO TO 1
Return NULL.

Install

With Node.js:

$ npm install find-config

Api

`findConfig(filename, [options]) : String|Null`

filename String - Name of the configuration file to find.
options {Object=}
- cwd {String=} - Directory in which to start looking. (Default: process.cwd()).
- dir {String=} - An optional subdirectory to check at each level. (Default: '.config').
- dot {Boolean=} - Whether to keep the leading dot in the filename for matches in a subdirectory. (Default: false)
- home {Boolean=} - Whether to check the user's home directory if no matches are found. (Default: true)
- module {Boolean=} - Whether to use Node.js module resolution. (Default: false)

Synchronously find the first config file matching a given name in the current directory or the nearest ancestor directory.

var findConfig = require('find-config');

// Find the nearest `package.json`
var pkg = findConfig('package.json');

// Find the nearest `.foorc` or `.config/foorc`
var foo = findConfig('.foorc');

// Find the nearest `.foorc` or `.config/.foorc`
var foo = findConfig('.foorc', { dot: true });

// Find the nearest module using Node.js module resolution.
// Will look for `bar.js` or `bar/index.js`, etc.
var foo = findConfig('bar', { module: true });

// Find the nearest `baz.json` or `some/path/baz.json`
var foo = findConfig('baz.json', { dir: 'some/path' });

// Find the nearest `qux.json` or `some/path/qux.json` in
// some other directory or its nearest ancestor directory.
var foo = findConfig('qux.json', { cwd: '/other/dir', dir: 'some/path' });

`findConfig.read(filename, [options]) : String|Null`

filename String - Name of the configuration file to find.
options {Object=} - Same as findConfig() with two additions.
- encoding {String} - File encoding. (Default: 'utf8').
- flag {String} - Flag. (Default: 'r').

Finds and reads the first matching config file, if any.

var yaml = require('js-yaml');
var travis = yaml.safeLoad(findConfig.read('.travis.yml'));

`findConfig.require(filename, [options]) : *`

filename String - Name of the configuration file to find.
options {Object=} - Same as findConfig().

Finds and requires the first matching config file, if any. Implies module is true.

var version = findConfig.require('package.json').version;

Contribute

Standards for this project, including tests, code coverage, and semantics are enforced with a build tool. Pull requests must include passing tests with 100% code coverage and no linting errors.

Test

$ npm test

Licensed under MIT