diff options
Diffstat (limited to 'node_modules/interpret/README.md')
| -rw-r--r-- | node_modules/interpret/README.md | 187 |
1 files changed, 0 insertions, 187 deletions
diff --git a/node_modules/interpret/README.md b/node_modules/interpret/README.md deleted file mode 100644 index 4dffc99..0000000 --- a/node_modules/interpret/README.md +++ /dev/null @@ -1,187 +0,0 @@ -<p align="center"> - <a href="http://gulpjs.com"> - <img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png"> - </a> -</p> - -# interpret - -[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Travis Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url] - -A dictionary of file extensions and associated module loaders. - -## What is it -This is used by [Liftoff](http://github.com/tkellen/node-liftoff) to automatically require dependencies for configuration files, and by [rechoir](http://github.com/tkellen/node-rechoir) for registering module loaders. - -## API - -### extensions -Map file types to modules which provide a [require.extensions] loader. - -```js -{ - '.babel.js': [ - { - module: '@babel/register', - register: function(hook) { - // register on .js extension due to https://github.com/joyent/node/blob/v0.12.0/lib/module.js#L353 - // which only captures the final extension (.babel.js -> .js) - hook({ extensions: '.js' }); - }, - }, - { - module: 'babel-register', - register: function(hook) { - hook({ extensions: '.js' }); - }, - }, - { - module: 'babel-core/register', - register: function(hook) { - hook({ extensions: '.js' }); - }, - }, - { - module: 'babel/register', - register: function(hook) { - hook({ extensions: '.js' }); - }, - }, - ], - '.babel.ts': [ - { - module: '@babel/register', - register: function(hook) { - hook({ extensions: '.ts' }); - }, - }, - ], - '.buble.js': 'buble/register', - '.cirru': 'cirru-script/lib/register', - '.cjsx': 'node-cjsx/register', - '.co': 'coco', - '.coffee': ['coffeescript/register', 'coffee-script/register', 'coffeescript', 'coffee-script'], - '.coffee.md': ['coffeescript/register', 'coffee-script/register', 'coffeescript', 'coffee-script'], - '.csv': 'require-csv', - '.eg': 'earlgrey/register', - '.esm.js': { - module: 'esm', - register: function(hook) { - // register on .js extension due to https://github.com/joyent/node/blob/v0.12.0/lib/module.js#L353 - // which only captures the final extension (.babel.js -> .js) - var esmLoader = hook(module); - require.extensions['.js'] = esmLoader('module')._extensions['.js']; - }, - }, - '.iced': ['iced-coffee-script/register', 'iced-coffee-script'], - '.iced.md': 'iced-coffee-script/register', - '.ini': 'require-ini', - '.js': null, - '.json': null, - '.json5': 'json5/lib/require', - '.jsx': [ - { - module: '@babel/register', - register: function(hook) { - hook({ extensions: '.jsx' }); - }, - }, - { - module: 'babel-register', - register: function(hook) { - hook({ extensions: '.jsx' }); - }, - }, - { - module: 'babel-core/register', - register: function(hook) { - hook({ extensions: '.jsx' }); - }, - }, - { - module: 'babel/register', - register: function(hook) { - hook({ extensions: '.jsx' }); - }, - }, - { - module: 'node-jsx', - register: function(hook) { - hook.install({ extension: '.jsx', harmony: true }); - }, - }, - ], - '.litcoffee': ['coffeescript/register', 'coffee-script/register', 'coffeescript', 'coffee-script'], - '.liticed': 'iced-coffee-script/register', - '.ls': ['livescript', 'LiveScript'], - '.mjs': '/absolute/path/to/interpret/mjs-stub.js', - '.node': null, - '.toml': { - module: 'toml-require', - register: function(hook) { - hook.install(); - }, - }, - '.ts': [ - 'ts-node/register', - 'typescript-node/register', - 'typescript-register', - 'typescript-require', - 'sucrase/register/ts', - { - module: '@babel/register', - register: function(hook) { - hook({ extensions: '.ts' }); - }, - }, - ], - '.tsx': [ - 'ts-node/register', - 'typescript-node/register', - 'sucrase/register', - { - module: '@babel/register', - register: function(hook) { - hook({ extensions: '.tsx' }); - }, - }, - ], - '.wisp': 'wisp/engine/node', - '.xml': 'require-xml', - '.yaml': 'require-yaml', - '.yml': 'require-yaml', -} -``` - -### jsVariants -Same as above, but only include the extensions which are javascript variants. - -## How to use it - -Consumers should use the exported `extensions` or `jsVariants` object to determine which module should be loaded for a given extension. If a matching extension is found, consumers should do the following: - -1. If the value is null, do nothing. - -2. If the value is a string, try to require it. - -3. If the value is an object, try to require the `module` property. If successful, the `register` property (a function) should be called with the module passed as the first argument. - -4. If the value is an array, iterate over it, attempting step #2 or #3 until one of the attempts does not throw. - -[require.extensions]: http://nodejs.org/api/globals.html#globals_require_extensions - -[downloads-image]: http://img.shields.io/npm/dm/interpret.svg -[npm-url]: https://www.npmjs.com/package/interpret -[npm-image]: http://img.shields.io/npm/v/interpret.svg - -[travis-url]: https://travis-ci.org/gulpjs/interpret -[travis-image]: http://img.shields.io/travis/gulpjs/interpret.svg?label=travis-ci - -[appveyor-url]: https://ci.appveyor.com/project/gulpjs/interpret -[appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/interpret.svg?label=appveyor - -[coveralls-url]: https://coveralls.io/r/gulpjs/interpret -[coveralls-image]: http://img.shields.io/coveralls/gulpjs/interpret/master.svg - -[gitter-url]: https://gitter.im/gulpjs/gulp -[gitter-image]: https://badges.gitter.im/gulpjs/gulp.svg |