You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2.0 KiB

Raw Permalink Blame History

pkg-conf

Get namespaced config from the closest package.json

Having tool specific config in package.json reduces the amount of metafiles in your repo (there are usually a lot!) and makes the config obvious compared to hidden dotfiles like .jshintrc, which can end up causing confusion. XO, for example, use the xo namespace in package.json, and ESLint uses eslintConfig. Many more tools supports this, like AVA, Babel, nyc, etc.

Install

$ npm install --save pkg-conf

Usage

{
	"name": "some-package",
	"version": "1.0.0",
	"unicorn": {
		"rainbow": true
	}
}

const pkgConf = require('pkg-conf');

pkgConf('unicorn').then(config => {
	console.log(config.rainbow);
	//=> true
});

API

It walks up parent directories until a package.json can be found, reads it, and returns the user specified namespace or an empty object if not found.

pkgConf(namespace, [options])

Returns a promise that resolves to the config.

pkgConf.sync(namespace, [options])

Returns the config.

namespace

Type: string

The package.json namespace you want.

options

cwd

Type: string
Default: process.cwd()

Directory to start looking up for a package.json file.

defaults

Type: Object

Default config.

pkgConf.filepath(config)

Pass in the config returned from any of the above methods.

Returns the filepath to the package.json file or null.

read-pkg-up - Read the closest package.json file
read-pkg - Read a package.json file
find-up - Find a file by walking up parent directories

2.0 KiB Raw Permalink Blame History