a-settings

a-settings

node.js settings provider for different environments

Purpose

• Declare env in process.argv or in NODE_ENV
• DRY settings using root configuration and env customization
• Improve security avoiding settings runtime reassignment or injection
• Freeze values, avoid injection at runtime
• Use plain js over json and env files and be free to use comments and functions without limitations
• Simply use env vars from process env
• Stop doing this, it's not maintanable

if(process.env.NODE_ENV == 'debug') {
  port = 1234
} else {
  port = 80
}

Quick start

In app.js and in any other .js file get settings from settings/$env
settings.env contains the env name

const http = require('http')
const settings = require('a-settings')

http.createServer((request, response) => {
  response.writeHead(200, {'Content-Type': 'text/plain'})
  response.write(`Hey, I am ${settings.env} server`)
  response.end()
}).listen(settings.port)

declare settings in settings/_root.js

const app = {
  url: '',
  name: 'myapp',
  port: 9001,
  log: {
    level: process.env.LOG_LEVEL || 'warn',
    pretty: process.env.LOG_PRETTY === 'true',
  }
}

module.exports = app

and in settings/dev.js

const app = require('./_root')

app.port = 9002
app.log.level = 'trace'
app.log.pretty = true

module.exports = app

in settings/beta.js

const app = require('./_root')

app.port = 9003
app.url = 'https://beta.myapp.com',

module.exports = app

then run app.js with dev settings

node main.js dev

or run app.js using beta settings

node main.js beta

see example/

Options

Default options are

path directory containing env settings files, default is /settings in process current working
processEnv process env name, default is NODE_ENV, so NODE_ENV=beta node app.jsv
argv process argv index, default is 2 (the third) so node app.js dev

NOTES

• If $env is provided in both ways as NODE_ENV=beta node app.js dev, env var wins, so in this case will be beta
• If $env is not provided, default is _root

Custom Options

to use custom otions, use .settings.js in app root directory

const path = require('path')

module.exports = {
  path: path.join(__dirname, 'settings'), 
  processEnv: 'NODE_ENV',
  argv: 2
}

verbosity

To enable verbosity, add --verbose at process

node app.js alpha --verbose

TODO

• load options from package.json
• validate value (async)

License

The MIT License (MIT)

Copyright (c) 2018-20

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.