makeconf

makeconf

REQUIRES Node v4.0.0!

An interactive local config generator that makes it easy to collaboratively maintain configuration files.

makeconf can be conveniently invoked from within the postinstall script in your project's package.json file, prompting your buddies to review and update their local config upon running npm install.

Setup

$ npm install -g makeconf

or

$ npm install makeconf --save-dev

and run node_modules/makeconf/bin/makeconf locally.

Usage

Create a makeconf.json file in your project directory:

Available types: .env, module.exports

{
  "type": ".env",
  "file": ".env",
  "config": {
    "S3_ACCESS_KEY": {
      "description": "Your Amazon S3 access key"
    },
    "DEBUG": {
      "description": "Enable debug mode",
      "default": false,
      "required": true
    },
    "DATABASE": {
      "description": "Database driver",
      "required": true
    }
  }
}

In your project directory, run:

$ makeconf

License

MIT © Eric Nishio