Node Package Config Loader

This is a utility for loading configuration for your node package that can be defined at the entry point of the application, i.e. the application requiring your package.

The application entry point is scanned for a configuration file that you specify in your package. The scan starts at the application entry point and scans up to 5 parent directories (to support scenarios where the entry point is not the root of the entry point).

If the configuration file is not found during the scan of the application entry point, it will fallback to a configuration file of the same name that is provided with your package (the default).

If you don't provide a default configuration file, and the configuration is not found while scanning the application entry point, then you'll have a null configuration that you should check for.

This is package useful if you would like consumers of your package to be able to override any configuration your package requires with configuration defined in files they control.

Installation

To install the package using npm:

npm install node-package-config-loader

Integration

To integrate the package with your package/application:

const PackageConfigLoader = require('node-package-config-loader')
const PackageConfig = PackageConfigLoader.load(__dirname, 'my-config.json')

if (PackageConfig) {
  // Read keys/values from PackageConfig...
}