Skip to content
Branch: master
Go to file
Code

README.md

rechoir

NPM version Downloads Travis Build Status AppVeyor Build Status Coveralls Status Gitter chat

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.

rechoir for enterprise

Available as part of the Tidelift Subscription

The maintainers of rechoir and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

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

About

Prepare a node environment to require files with different extensions.

Resources

License

You can’t perform that action at this time.