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

configurizer

v0.0.8

Published

Simply load a config file from your projects root directory

Downloads

14

Readme

#Simple-node-config ####only does one thing, ####...loads a .yaml or .json file in the same directory as /node_modules. ######not_simple = require("../../../../../some.json")

##Install.

$ npm install simple-node-config --save

#testing
$ cd ./node_modules/simple-node-config && make test

##Require it anywhere, in your application you need access to your configs. Without worrying about the path. It accepts some parameters on creation. By default it looks for config.yaml/json.

  //default - loads config.yaml/json and returns an object based on your NODE_ENV variable
  var conf = require("simple-node-config").getVariables() 
  
  //If you want to use a custom filename just pass it in as a string.
  //loads myCustomFile.yaml/json and returns an object based on your NODE_ENV variable
  var conf = require("simple-node-config").getVariables("myCustomFile") 
  
  //If you need a custom filename AND want all of the variables in the file.
  //loads myCustomFile.yaml/json and returns all the variables in the file
  var conf = require("simple-node-config").getVariables("myCustomFile" , false) 
  
  //If you want all of the variables in the file just pass in false.
  //loads config.yaml/json and returns an object with ALL of your variables.
  var conf = require("simple-node-config").getVariables(false)

##Require it as many times as you want. Have some other config file you want access too? Just require it again with a distinct variable.

  config = require("simple-node-config").getVariables() //gives you ENV dependant object
  otherConfig = require("simple-node-config").getVariables("otherConfig",false) //gives entire object
  //you can setup a separate path if needed
  otherConfig = require("simple-node-config").setPath("../../").getVariables("otherConfig")

##If you need to change the path to your config file. Remember to start from this modules directory and work up the the root, then down to wherever your config is located.

  config = require("simple-node-config").setPath("../../").getVariables()

##Variables to match your NODE_ENV you will need a config.yaml/json with whatever NODE_ENV variables you plan on using.

#start your server in production mode and simple-node-config will return the production object.
$ NODE_ENV=production node server.js
var conf = require("simple-node-config").getVariables()
console.log(conf.someAPIkey)
->"skjhas08n3e0-"
#config.yaml
  ---
  production:
    siteName: "MySite"
    someAPIkey: "skjhas08n3e0-"
    mongodb:
      username: "derp"
      password: "8YaMxyzUez"
      port: 12345
  development:
    siteName: "MySite-dev"
    mongodb:
      username: "derp"
      password: "hunter2"
      port: 12345
  whateverYouWant:
    siteName: "I think I broke something"
    mongodb:
      username: "derp"
      password: ""
      port: 12345
//I much prefer yaml, but you can use JSON if you want...
{
  "production":
    {
      "siteName": "Communicator",
      "someAPIkey": "skjhas08n3e0-",
      "mongodb":
        {
          "username": "derp",
          "password": "8YaMxyzUez",
          "port": 12345
        }
    },
  "development":
  {
    "siteName": "Communicator-test",
    "mongodb":
      {
        "username": "derp",
        "password": "hunter2",
        "port": 12345
      }
  },
  "whatEverYouWant":
  {
    "siteName": "I think I broke something",
    "mongodb":
    {
      "username": "derp",
      "password": "",
      "port": 12345
    }
  }
}