T&F Config

The T&F config was designed to be easy to use and with security in mind.

Benefits:

1. Schema provides default values, value types, descriptions, customisation and validation.
2. Easy access. Simply import config from '@tandf/config' to get your config from anywhere in your app. Well formatted and structured.
3. Customisation of variables by overwriting or combining different sources of config, including json5 file, command line arguments or environment variables

Configuring the config using config.config

So as not to conflict with other libraries this config uses a file named config.config at the root of the project. To specify a different location for the config.config file the environment variable CONFIG_CONFIG can be used.

Environments are available so that different config can be specified for differering environments. To specify the config environment use CONFIG_ENV, or it will fall back to using NODE_ENV, or further it will fallback to just the default.

Overwriting variables

By default command line arguments and environment variables are inferred from the structure of the schema. The pattern used is as follows: Schema structure: config.analytics.googleAnalytics Command line argument: --config-analytics-googleanalytics Environment variable: _CONFIG_ANALYTICS_GOOGLEANALYTICS

This can be changed in the schema using arg or env as specified in node-convict. Alternatively, if you don't like the format for all of them you can change it using the argsFormat and envFormat option.

The benefit of having this ability to overwrite variables from different sources is that it means you can provide specific config depending on the environment and prevents the need to check in secret information.

To Document:

• validateOnRun option
• inherit from multiple config files allows user specific variables to override
• manual validation test
• Example config.config file.

node-convict

Thank you greatly to the underlying config library: https://github.com/mozilla/node-convict which this library wraps.

Thought&Function

If you need help with your Javascript (or: React, React Native, .NET, and more) project please check us out at https://www.thoughtandfunction.com/