js.conf.d v1.3.0

js.conf.d

A simple configuration manager, with directory hierarchy / overrides support.

Linux distributions' packages have had folder-based config for years. We're all used to easily adding files to a nginx.conf.d folder, and it being picked up automatically, in a predictable order. We're also used to having multiple paths where config will be searched, ordered by priority. But until now, on Node.js we had to do this manually.

This package allows you to set a list of search folders, and any js files on them will be loaded and merged as a plain object, following configurable rules.

Usage

Using js.conf.d is very simple:

const jsconfd = require('js.conf.d')

// Load config from any of these 3 folders, with the latter overriding the former
const config = jsconfd.load(['/etc/my-config', '~/.my-config', './config'])

By default, the files will be loaded on filename order (as defined by sort()), and the contents will be merged using Object.assign. You can customize this behaviour by passing a options object as a second parameter, with the following keys:

const config = jsconfd.load(['/etc/my-config', '~/.my-config', './config'], {
  sort: (a, b) => { /*...*/ }, // Argument to sort() the filenames. Defaults to null.
  merge: (a, b) => { /*...*/ } // Value merger function. Defaults to Object.assign.
})

Using with Webpack

This package is designed for Node.js, and doesn't work directly on Webpack. Fortunately, we have created a small Webpack plugin which implements the same logic. Check js.conf.d-webpack.