Giter VIP home page Giter VIP logo

rc2's Introduction

rc2

A follow-up to rc that is more configurable.

More configure! Such less bloat!

Features

  • Fully asynchronous: no synchronous I/O in the module
  • Looks only in locations/ranges of directories which you tell it to
  • Loaders are fully configurable
  • Zero-dependencies (all bundled)

Example

import rc2 from 'rc2'
async function main() {
	const loaders = rc2.loaders()
		.default(['ini', 'json', 'js', 'yaml'])
		.ini()  // must have the `ini` module installed
		.json() // uses `json5` module, if installed, otherwise uses `JSON.parse(...)`
		.js()   // uses `require(...)`
		.yaml() // must have the `js-yaml` module installed
	const config = await rc2({
		name: 'myapp', // will look for '.myapprc' files
		locations: [{bottom: __dirname}],
		loaders,
	})
}
main().catch(e => {
	process.exitCode = 1
	console.error(e)
})

API

  • rc2(options) => Promise<any>
  • rc2.loaders() => Loaders

rc2(...) will only look in the locations you specify (see options below) for rc files. In each directory, it searches the following globs:

  • .${name}rc
  • .${name}rc.*
  • .${name}/config
  • .${name}/config.*
  • .config/${name}
  • .config/${name}.*
  • .config/${name}/config
  • .config/${name}/config.*
  • Environment variables (${name}_some__property)
  • CLI args (parsed by minimist)

Options

export interface Options {
	name: string            // the name of the app
	locations?: {           // locations to search for rc files
		top?: string          // if specified, denotes the "top" directory at which to stop looking
		bottom: string        // the start directory at which to start looking for rc files
	}[]
	loaders?: Loaders       // an instance created with `rc2.loaders()`
	default?: any           // default configuration if none are found
	argv?: string[]
	env?: any
}

Loaders

A loader instance can be created with rc2.loaders(). This instance has the following methods:

declare class Loaders {
	add(ext: string, loader: (f: string) => any): this
	default(exts: string[]): this
	ini(): this
	js(): this
	json(): this
	yaml(): this
}

Example loaders.add(...):

rc2.loaders()
    .add('xml', f => {
        // Async is handled with `co`, so return
        // any yieldable for this function to be async
        return new Promise(...) // for example
    })

For reference, here is a list of valid co yieldables.

rc2's People

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

rc2's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organiszation’s settings page, under Installed GitHub Apps.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.