npm-conf

What is npm-conf?

The npm-conf package is a Node.js library for managing configuration options. It allows you to define, retrieve, and manipulate configuration settings in a structured and consistent manner. This package is particularly useful for applications that require a robust configuration management system.

What are npm-conf's main functionalities?

Define Configuration Defaults

This feature allows you to define default configuration settings. The defaults can be overridden by user-defined settings.

const Conf = require('npm-conf');
const conf = new Conf();
conf.defaults = { foo: 'bar', baz: 42 };
console.log(conf.get('foo')); // Output: 'bar'

Get and Set Configuration Values

You can easily set and retrieve configuration values using the set and get methods.

const Conf = require('npm-conf');
const conf = new Conf();
conf.set('foo', 'bar');
console.log(conf.get('foo')); // Output: 'bar'

Load Configuration from File

This feature allows you to load configuration settings from a JSON file, making it easy to manage configurations in a file-based format.

const Conf = require('npm-conf');
const conf = new Conf();
conf.loadFile('path/to/config.json');
console.log(conf.get('foo')); // Output depends on the content of config.json

Environment Variable Overrides

Configuration values can be overridden by environment variables, providing flexibility for different deployment environments.

const Conf = require('npm-conf');
const conf = new Conf();
process.env.npm_config_foo = 'baz';
console.log(conf.get('foo')); // Output: 'baz'

Other packages similar to npm-conf

config

The 'config' package provides a more extensive configuration management system, supporting multiple configuration files for different environments, and allowing for hierarchical configurations. It is more feature-rich compared to npm-conf.

rc

The 'rc' package is a simple configuration loader that supports configuration through command-line arguments, environment variables, and configuration files. It is more lightweight but less structured compared to npm-conf.

dotenv

The 'dotenv' package loads environment variables from a .env file into process.env. It is focused on managing environment variables rather than a full configuration management system like npm-conf.

README

npm-conf

Get the npm config

Install

$ npm install npm-conf

Usage

const npmConf = require('npm-conf');

const conf = npmConf();

conf.get('prefix')
//=> //=> /Users/unicorn/.npm-packages

conf.get('registry')
//=> https://registry.npmjs.org/

To get a list of all available npm config options:

$ npm config list --long

API

npmConf()

Returns the npm config.

npmConf.defaults

Returns the default npm config.

License

MIT © Kevin Mårtensson