npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

xenv

v4.4.1

Published

Parse and validate configuration variables.

Downloads

39

Readme

This module allows you to parse and validate configuration variables.

Define an schema

const url = require('url');
const xenv = require('xenv');

const schema = {
  MONGODB: {
    required: true
  },
  RABBITMQ: {
    required: true,
    parse: url.parse
  },
  PORT: {
    default: 9000,
    parse: parseInt,
    validate: port => port > 1000
  },
  BLACKLIST: {
    default: [],
    parse: blacklist => blacklist.split(',')
  }
};

const env = xenv({ schema }, process.env);

console.dir(env);

Then running:

MONGODB=mongodb://localhost/test \
  RABBITMQ=amqp://user:pass@localhost/test \
  PORT=9000 \
  BLACKLIST=foo,bar \
  node test.js

Will print:

{
  MONGODB: 'mongodb://localhost/test',
  RABBITMQ: {
    protocol: 'amqp:',
    auth: 'user:pass',
    host: 'localhost',
    hostname: 'localhost',
    path: '/test'
  },
  PORT: 9000,
  BLACKLIST: ['foo', 'bar']
}

Running throws an exception:

node test.js

The required environment variable MONGODB has not been defined.

Common techniques

xenv is an attempt to create an human readable DSL for configuration. Given than some patterns often repeat I have included some templates.

Example:

PORT: {
  parse: parseInt,
  default: 9000
},
BLACKLIST: {
  default: [],
  parse: blacklist => blacklist.split(','),
  validate: v => Array.isArray(v)
},
LOG_LEVEL: {
  default: 'debug',
  validate: level => ['error', 'info', 'debug'].indexOf(level) > -1
}

Can be written as follows:

PORT: {
  type: 'int'
  default: 9000
},
BLACKLIST: {
  type: 'arrayOfStrings'
},
LOG_LEVEL: {
  type: 'string',
  default: 'debug',
  oneOf: ['error', 'info', 'debug']
}

To parse or not to parse

xenv will attempt to parse the value of a variable only if the value is an string. The idea is that you can combine environment variables with other source of configurations.

Example:

const fs = require('fs');
const configFromFile = JSON.parse(fs.readFileSync(process.env.CONFIG_FILE, 'utf8'));
const rawConfig = _.extend({}, configFromFile, process.env);
const config = xenv(schema, rawConfig);

In this case is possible that the configuration sourced from the JSON file is already parsed while settings coming from environment variables have some type of encoding.

Imagine you have a BLACKLIST variable like the one shown before (type: 'arrayOfStrings'). If xenv receives an string it will do value.split(',') but if the variable is an array then it will not try to parse it.

License

MIT 2017 - José F. Romaniello