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

hc

v0.1.7

Published

Human-friendly configuration tools

Downloads

23

Readme

HC

Human-friendly configuration tools

Build Status

Usage

Loading conf from following possible paths:

  • $CC_ROOT/config.json
  • $CC_RROT/config/config.json
  • $CC_ROOT/config/{env}.json

where $CC_ROOT is default to the directory containing current running file (aka require.main.filename), or specified by env varialbe.

require("hc")(function(e, conf) {
  if(e) {
    console.log("failed to load conf");
    console.error(e);
    return;
  }
  console.log(conf);
});

DataSources

Local files and conventions

local-fs is the default source which loads config data from local filesystem. It attemps to load file at some conventinonal places:

  • config.json
  • ./config/config.json
  • ./config/{test|development|production}.json

Configs for multiple environment can be supplied in a single JSON file in the structure like this

{
	"test": {"foo":"bar"},
	"development": {"foo":"bar"},
	"production": {"foo":"bar"}
}

CouchDB source

var hc = require("hc");
hc({
    source: new hc.sources.Couch({
      db:"http://127.0.0.1:5984/hc"
    })
  }, function(e, conf) {
      //TODO
  });
});

Options for CouchDB source

  • db, db connection options, see options format in nano
  • id, doc id for config data

HTTP Source

Fetch remote json configs

var source = new hc.sources.HTTP("http://config.example.com/app/config.json", function(e, conf) {
  //TODO
});

TODO

  • More configuration source support:

    • ~~CouchDB~~
    • ~~MongoDB~~
    • ~~HTTP Source~~
  • Browser Support

    • LocalStorage
    • HTTP