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

@luxuryescapes/lib-config

v0.0.6

Published

Config loader

Downloads

6,157

Readme

lib-config

Lets you define your config as ordinary code files The name of the file, maps to the name of the APP_ENV

Philosophy

The philosophy (summarised in confluence) is that ENV vars should be used only for secret config.

For other non-secret settings that vary between environments (eg. the API url, which might be test-api.com or api.com), it's easier to manage them in hard-coded config files. A single environment variable called APP_ENV determines what environment we're running in (development, test, production, etc) and the relevant config file is loaded based on that.

APP_ENV values

APP_ENV can be whatever you want. At Luxury Escapes, we typically use:

development spec (for running automated tests - both in CI and locally test (aka staging - but we've called it test in enough places that changing now is hard) production

For javascript

// config/production.js (e.g. APP_ENV=production)

module.exports = {
  port: parseInt(process.env.PORT || ''),
  apiEndpoint: 'https://myprodapi.com'
}

For typescript

// config/production.ts (e.g. APP_ENV=production)

export const config = {
  port: parseInt(process.env.PORT || ''),
  apiEndpoint: 'https://myprodapi.com'
}

in your start up file you would have something like this

const config = require('@luxuryescapes/lib-config')
config.load({
  env: 'local', // optional, defaults to process.env.APP_ENV,
  schema: {
    // json schema of the config schema
    type: 'object',
    properties: {
      port: { type: 'integer' },
      apiEndpoint: { type: 'string' }
    },
    required: ['port', 'apiEndpoint'],
    additionalProperties: false
  },
  configDir: 'myconfig' // optional, default to `config`
})

then in other files you can do the following

const config = require('@luxuryescapes/lib-config')

express.listen(config.get().port)

get your test runner to load config as the first step

process.env.APP_ENV = 'spec'
const config = require('@luxuryescapes/lib-config')
config.load()

or

const config = require('@luxuryescapes/lib-config')
config.load({ env: 'spec' })

if you want to mock config for unit testing you can do something like this

const sinon = require('sinon')
const config = require('@luxuryescapes/lib-config')

beforeEach(() => {
  sinon.sandbox(config, 'get').returns({
    ...config.get(),
    myFeatureEnabled: false
  })
})

afterEach(() => {
  sinon.sandbox.restore()
})