Skip to content

gulpjs/rechoir

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

rechoir

NPM version Downloads Build Status Coveralls Status

Prepare a node environment to require files with different extensions.

What is it?

This module, in conjunction with interpret-like objects, can register any filetype the npm ecosystem has a module loader for. This library is a dependency of liftoff.

Note: While rechoir will automatically load and register transpilers like coffee-script, you must provide a local installation. The transpilers are not bundled with this module.

Usage

const config = require('interpret').extensions;
const rechoir = require('rechoir');
rechoir.prepare(config, './test/fixtures/test.coffee');
rechoir.prepare(config, './test/fixtures/test.csv');
rechoir.prepare(config, './test/fixtures/test.toml');

console.log(require('./test/fixtures/test.coffee'));
console.log(require('./test/fixtures/test.csv'));
console.log(require('./test/fixtures/test.toml'));

API

prepare(config, filepath, [cwd], [noThrow])

Look for a module loader associated with the provided file and attempt require it. If necessary, run any setup required to inject it into require.extensions.

config An interpret-like configuration object.

filepath A file whose type you'd like to register a module loader for.

cwd An optional path to start searching for the module required to load the requested file. Defaults to the directory of filepath.

noThrow An optional boolean indicating if the method should avoid throwing.

If calling this method is successful (e.g. it doesn't throw), you can now require files of the type you requested natively.

An error with a failures property will be thrown if the module loader(s) configured for a given extension cannot be registered.

If a loader is already registered, this will simply return true.

License

MIT