gc

good-config

A common config solution with aim to simplify config

Showing:

Popularity

Downloads/wk

14

GitHub Stars

8

Maintenance

Last Commit

2yrs ago

Contributors

4

Package

Dependencies

6

Size (min+gzip)

418.0KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

good-config

Easy to use centralized config with the goal of having config simple and extendable.

Version 1.1.2

Update dependencies (#5)

Version 1.1.1

Fixed the bug (#2) which ignores empty values to be set bia environmental variables.

Version 1.1.0

Added envify functionality. It means you can now just define your config the way you want (json/yml). In run time, if you needed to overwrite a key, just follow Uppercase+Underscore and you would be able to overwrite it. For example you have a config like this:

{
  key1: "value1",
  key2: {
    subKey: 1,
    anotherKey: "changeme"
  }
}

Say you want to change anotherKey value via environmental variables. You can just set KEY2_ANOTHERKEY to the value you want and good-config will replace it with the correct value.

Main features

  • Supports for both yaml and json
  • Possibility to add your own provider
  • Hierarchical support thanks to merge-config
  • Envify support: You can overwrite any config key via env variables and envify convert parent.key to PARENT_KEY

Currently it has these providers:

  • FileSystem
  • S3
  • Feel free to make PR for other providers

Installation

npm install good-config

File structure

/myproduct
    default.json
    production/
        default.json
        euw.json
    staging/
        default.json
        euw.json
        use.json

How to use

To get the config before starting the app, just wrap the server startup call in app.js.

const Config = require("good-config");

const config = new Config({
  path: "media-service",
  awsBucket: "-config",
  format: "json", // Optional
  awsAccessKeyId: process.env.AwsAccessKeyId,
  awsSecretAccessKey: process.env.AwsSecretAccessKey,
  awsRegion: process.env.AwsRegion, // Optional
  provider: "S3"
});

config
  .load()
  .then(() => {
    app.listen(config.get("port"), function() {
      console.log("Express app listening on port " + config.get("port"));
    });
  })
  .catch(err => {
    console.log("Failed to load the config");
  });

Synchronous loading

There is also the option of loading config from filesystem synchronously, by calling config.loadSync(). See examples folder.

Available options

  • path : Path to the config file. For S3 it is name of the project directory and for FileSystem , the path to where you store config files.
  • format: Format of config files - Default json
  • provider: Name of the provider class, [FileSystem, S3]
  • env: Content of NODE_ENV, [production, development, ...]
  • region: Content of REGION Env variable, [EUW, USE, ...]
  • awsBucket: Name of the S3 bucket
  • awsAccessKeyId: Name of the S3 AWS accessKeyId
  • awsSecretAccessKey: Name of the S3 AWS secretAccessKey
  • awsRegion: Name of the S3 AWS region - Default eu-west-1

License

Copyright 2017- Majid Garmaroudi

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial