NodeConfigWebpack

This plugin hooks into webpacks compilation to replace the config module with its environment equivalent. This eliminates the need to pull config in dynamically at runtime.

Installation

yarn add -D node-config-webpack

Usage

Your typical usage will replace the config module with an environment specific override. For this usage, just import the plugin and add it to webpack.

webpack.config.js

const NodeConfigWebpack = require('node-config-webpack');

module.exports = {
  entry: [
    './src/index.js'
  ],
  plugins: [
    new NodeConfigWebpack()
  ]
}

Options

Env

This option will inject your configuration into process.env automatically. However, it expects a root-level list of key-pair items, similar to an .env file. Additionally all keys will be coerced into uppercase to match process.env convention.

webpack.config.js

const NodeConfigWebpack = require('node-config-webpack');

module.exports = {
  entry: [
    './src/index.js'
  ],
  plugins: [
    new NodeConfigWebpack({
      env: true,
    })
  ]
}

Example:

console.log('Configuration version is', process.env.VERSION);

If you want the config added to process.env without any coercion you can use a string for the env option:

webpack.config.js

const NodeConfigWebpack = require('node-config-webpack');

module.exports = {
  entry: [
    './src/index.js'
  ],
  plugins: [
    new NodeConfigWebpack({
      env: 'CONFIG',
    })
  ]
}

You can then reference your config from process.env.<your_key>.

Example:

console.log('Configuration is', process.env.CONFIG);

Constant

This option will replace any reference to the variable CONFIG with the generated equivalent.

webpack.config.js

const NodeConfigWebpack = require('node-config-webpack');

module.exports = {
  entry: [
    './src/index.js'
  ],
  plugins: [
    new NodeConfigWebpack({
      constant: true,
    })
  ]
}

Example:

console.log('Configuration version is', CONFIG.version);

You can use a custom constant variable by passing a string as the constant value.

webpack.config.js

const NodeConfigWebpack = require('node-config-webpack');

module.exports = {
  entry: [
    './src/index.js'
  ],
  plugins: [
    new NodeConfigWebpack({
      constant: 'customValue',
    })
  ]
}

Example:

console.log('Configuration version is', customValue.version);

Known Conflicts

If you are using webpack-node-externals in your webpack configuration, add config to the allowlist. This will allow node-config-webpack to work as expected.

Example:

const slsw = require('serverless-webpack');
const nodeExternals = require('webpack-node-externals');
const NodeConfigWebpack = require('node-config-webpack');

process.env.NODE_ENV = slsw.lib.serverless.service.provider.environment.NODE_ENV;

module.exports = {
  entry: slsw.lib.entries,
  target: 'node',
  mode: slsw.lib.webpack.isLocal ? 'development' : 'production',
  externals: [nodeExternals({
    allowlist: ['config']
  })],
  plugins: [
    new NodeConfigWebpack(),
  ]
};