pkg-conf

What is pkg-conf?

The pkg-conf npm package allows you to load configuration from the `package.json` file of your project. It helps in managing project-specific configurations in a centralized manner.

What are pkg-conf's main functionalities?

Load Configuration

This feature allows you to load configuration settings from the `package.json` file under a specific namespace (in this case, 'myApp'). The configuration is returned as a JavaScript object.

const pkgConf = require('pkg-conf');
(async () => {
  const config = await pkgConf('myApp');
  console.log(config);
})();

Default Values

You can provide default values for configuration settings. If the specified configuration is not found in the `package.json` file, the default values will be used.

const pkgConf = require('pkg-conf');
(async () => {
  const config = await pkgConf('myApp', { default: 'value' });
  console.log(config);
})();

Sync Loading

This feature allows you to load configuration settings synchronously. This can be useful in scenarios where asynchronous operations are not suitable.

const pkgConf = require('pkg-conf');
const config = pkgConf.sync('myApp');
console.log(config);

Other packages similar to pkg-conf

cosmiconfig

Cosmiconfig searches for and loads configuration files in various formats (JSON, YAML, JS, etc.). It is more flexible than pkg-conf as it supports multiple file formats and allows configuration files to be placed in different locations.

rc

The rc package is used for loading configuration files in a variety of formats (JSON, INI, etc.) and from multiple sources (environment variables, command-line arguments, etc.). It provides more flexibility in terms of configuration sources compared to pkg-conf.

config

The config package provides a way to manage configuration files for different deployment environments. It supports hierarchical configurations and allows for environment-specific settings, which is more advanced compared to the simpler namespace-based approach of pkg-conf.

README

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 .eslintrc, which can end up causing confusion. XO, for example, uses the xo namespace in package.json, and ESLint uses eslintConfig. Many more tools supports this, like AVA, Babel, nyc, etc.

Install

npm install pkg-conf

Usage

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

import {packageConfig} from 'pkg-conf';

const config = await packageConfig('unicorn');

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.

packageConfig(namespace, options?)

Returns a Promise for the config.

packageConfigSync(namespace, options?)

Returns the config.

namespace

Type: string

The package.json namespace you want.

options

Type: object

cwd

Type: string
Default: process.cwd()

The directory to start looking up for a package.json file.

defaults

Type: object

The default config.

skipOnFalse

Type: boolean
Default: false

Skip package.json files that have the namespaced config explicitly set to false.

Continues searching upwards until the next package.json file is reached. This can be useful when you need to support the ability for users to have nested package.json files, but only read from the root one, like in the case of electron-builder where you have one package.json file for the app and one top-level for development.

Example usage for the user:

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

packageJsonPath(config)

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

Returns the file path to the package.json file or undefined if not found.

Related

• 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