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

config-handler

v2.0.3

Published

Handles configuration files based on environment.

Downloads

17

Readme

Config Handler

Load your configuration in hierarchy. If exists the following occurs:

package.json is read (mainly useful for name and version). global config file is read, and deeply merged with the existing object. environment config file is finally read, deeply merging with the existing object.

Config-Handler doesn't modify any existing files, simply reads the configuration, deep merge occurs so entire blocks aren't erased.

Usage

const config = require('config-handler')();
console.log(config) // { name: 'hi', verion: '1.0.0' } ...

Here is an example of how the config object is handled:

// package.json
{
  name: 'my-project',
  version: '1.0.0'
}
// config/all.js
module.exports = {
  server: {
    port: 3000,
    db: {
      user: 'name',
      pass: 'secr3t'
    }
  }
}
// assume either NODE_ENV=development or not set
// config/development.js
module.exports = {
  server: {
    port: 3333,
    db: {
      pass: 'supersecr3t'
    }
  }
}

Resulting config object:

{
  name: 'my-project',
  version: '1.0.0',
  server: {
    port: 3333,
    db: {
      user: 'name',
      pass: 'supersecr3t'
    }
  }
}

Check out the test folder and example folder for more!

Installation

$ npm install config-handler

Features

  • Deeply merge multiple configuration files in hierarchy.
  • Includes package.json if exists.
  • Loads global configuration file.
  • Loads local environment configuration file.
  • Catches errors in config files.
  • Configurable.
  • Supports .js, .json, .node extensions.
  • Simple, fast and light-weight.
  • Written in ES6+ for node.js 6+

Options

The options are passed in as an object to the config:

const config = require('config')({ /* options */ });
  • dir - {string} - Name of the config dir, defaults to config.
  • log - {boolean} - Whether or not to output logging, defaults to false.
  • cwd - {string} - Current working directory location, defaults to process.cwd()
  • env - {string} - environment name for local config file, defaults to NODE_ENV or development.
  • global - {string} - name of the global config file to load, defaults to all.
  • logger - {function | object} - logger to use, defaults to console.

Tests

From the package

$ npm test

License

MIT