Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Augments require() with support for multiple file formats. Node.js / NPM package
JavaScript Clojure LiveScript TypeScript Other
Branch: master

README.md

NPM version

LOOKING FOR MAINTAINER: I don't have time to maintain this module at the moment and would like to let someone to takeover. Let me know in the issues if you're interested!

Augments require() with support for multiple file formats.

Supported file formats

... which return a JSON object:

... which return a Javascript module:

... work in progress:

  • dynamic libraries
  • ruby
  • python

Behind the scenes, this module adds handlers to require.extensions.

Install

npm install better-require

Usage

/**
 * @param {String} optional - formats is a white space separated list of formats you would like require() to support.
 */
// support all available extensions
require('better-require')();
// support a subset of extensions
require('better-require')(formats);

Example

Enable support for all file types:

require('better-require')();

var config = require('./config.json');
console.log(config);

Enable support for only a subset of file types:

require('better-require')('json yaml xml');

// we can now require .xml, .yaml and .xml files!
var config = require('./config.yaml');
console.log(config);

Dependencies

Reference

http://nodejs.org/api/all.html#all_require_extensions

Something went wrong with that request. Please try again.