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-guardian

v1.2.3

Published

Configuration Guardian is a tool that allows you to specify configuration details throughout your application and have it all loaded at a go.

Downloads

21

Readme

Config Guardian

Recursively goes through all folders starting from the folder you called ConfigGuardian from and includes all keys inside *.config.js files into ConfigGuardian.

Example usage

main.js

// ...
ConfigGuardian({ /* :options */ });
// ...

some-module.config.js

module.exports = {
	key1: 1,
	key2: 1.123
};

other-module.js

const config = require('config-guardian');
config.key1; // 1

Initialisation Options

Below is a complete list of all options.

projectRoot : String
 - defaults to the directory of the calling file.

environments : Array

refresh : Boolean
 - if this is set to true, ConfigGuardian will reconfigure itself regardless of current state

ignore : Array
 - a list of directory names that should not be processed during the recursive descent

API

ConfigGuardian()

The first time ConfigGuardian() is called, it initialises itself and does a recursive descent through the folders starting from projectRoot, collating the exported properties from files ending with .config.js, placing the keys into itself.

On second and subsequent calls, ConfigGuardian() returns an object with all the keys of all files ending with .config.js for your use.

ConfigGuardian.EnvConfig

EnvConfig is a structure you can use to define different values for different environments depending on the environments options you passed into the intiial constructor. If the environments options contains 'test', 'dev', 'stage', 'prod', calling new EnvConfig('testValue', 'devValue', 'stageValue', 'prodValue') will result in a hash:

{
	test:  'testValue',
	dev:   'devValue',
	stage: 'stageValue',
	prod:  'prodValue'
}

Changelog

1.2.0

Added envs option to specify events and create environment configs with ConfigGuardian.EnvConfig();

1.1.0

Added ignore option to ignore certain file names so that node_modules does not get included.

1.0.0

Initial release