@ovotech/config-file

Config File

Read a config file, and insert ENV vars where needed.

Using

yarn add @ovotech/config-file

test.config.json

{
  "db": "db://user:${DB_PASSWORD}/db-name"
}

import { loadConfigFile } from '@ovotech/config-file';

interface Config {
  db?: string;
}

const config = loadConfigFile<Config>({ env: process.env, file: 'test.config.json', required: ['db'] });

Running the tests

You can run the tests with:

yarn test

Coding style (linting, etc) tests

Style is maintained with prettier and tslint

yarn lint

Deployment

Deployment is preferment by lerna automatically on merge / push to master, but you'll need to bump the package version numbers yourself. Only updated packages with newer versions will be pushed to the npm registry.

Contributing

Have a bug? File an issue with a simple example that reproduces this so we can take a look & confirm.

Want to make a change? Submit a PR, explain why it's useful, and make sure you've updated the docs (this file) and the tests (see test folder).

License

This project is licensed under Apache 2 - see the LICENSE file for details