butter-require

A fork of better-require with less supported formats, mainly for usage in uRequire due to some issues and being too heavy.

Formats (& dependencies) removed:

• xml: who needs that anymore ? It crashes on Windows anyway...
• six

You can still manually install them of course...

---

Augments require() with support for multiple file formats.

Supported file formats

... which return a JSON represenation:

• json
• yaml (.yaml, .yml)
• csv
• xml
• ini

... which return a Javascript module:

• coffeescript (.coffeescript, .coffee)
• six
• clojurescript (.cljs) - not bundled
• dart - not bundled
• typescript (.ts) - not bundled

... 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

• require-json
• require-yaml
• require-csv
• require-xml
• require-ini
• see package.json

Reference

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