aboutsummaryrefslogtreecommitdiff
path: root/node_modules/interpret/README.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2016-10-10 03:43:44 +0200
committerFlorian Dold <florian.dold@gmail.com>2016-10-10 03:43:44 +0200
commitabd94a7f5a50f43c797a11b53549ae48fff667c3 (patch)
treeab8ed457f65cdd72e13e0571d2975729428f1551 /node_modules/interpret/README.md
parenta0247c6a3fd6a09a41a7e35a3441324c4dcb58be (diff)
downloadwallet-core-abd94a7f5a50f43c797a11b53549ae48fff667c3.tar.xz
add node_modules to address #4364
Diffstat (limited to 'node_modules/interpret/README.md')
-rw-r--r--node_modules/interpret/README.md136
1 files changed, 136 insertions, 0 deletions
diff --git a/node_modules/interpret/README.md b/node_modules/interpret/README.md
new file mode 100644
index 000000000..34ce5b644
--- /dev/null
+++ b/node_modules/interpret/README.md
@@ -0,0 +1,136 @@
+# interpret
+> A dictionary of file extensions and associated module loaders.
+
+[![NPM](https://nodei.co/npm/interpret.png)](https://nodei.co/npm/interpret/)
+
+## 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 (module) {
+ module({
+ // 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)
+ extensions: '.js'
+ });
+ }
+ },
+ {
+ module: 'babel-core/register',
+ register: function (module) {
+ module({
+ extensions: '.js'
+ });
+ }
+ },
+ {
+ module: 'babel/register',
+ register: function (module) {
+ module({
+ extensions: '.js'
+ });
+ }
+ }
+ ],
+ '.buble.js': [
+ {
+ module: 'buble/register',
+ register: function (module) {
+ module({
+ extensions: '.js'
+ });
+ }
+ }
+ ],
+ '.cirru': 'cirru-script/lib/register',
+ '.cjsx': 'node-cjsx/register',
+ '.co': 'coco',
+ '.coffee': ['coffee-script/register', 'coffee-script'],
+ '.coffee.md': ['coffee-script/register', 'coffee-script'],
+ '.csv': 'require-csv',
+ '.eg': 'earlgrey/register',
+ '.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 (module) {
+ module({
+ extensions: '.jsx'
+ });
+ }
+ },
+ {
+ module: 'babel-core/register',
+ register: function (module) {
+ module({
+ extensions: '.jsx'
+ });
+ }
+ },
+ {
+ module: 'babel/register',
+ register: function (module) {
+ module({
+ extensions: '.jsx'
+ });
+ },
+ },
+ {
+ module: 'node-jsx',
+ register: function (module) {
+ module.install({
+ extension: '.jsx',
+ harmony: true
+ });
+ }
+ }
+ ],
+ '.litcoffee': ['coffee-script/register', 'coffee-script'],
+ '.liticed': 'iced-coffee-script/register',
+ '.ls': ['livescript', 'LiveScript'],
+ '.node': null,
+ '.toml': {
+ module: 'toml-require',
+ register: function (module) {
+ module.install();
+ }
+ },
+ '.ts': ['ts-node/register', 'typescript-node/register', 'typescript-register', 'typescript-require'],
+ '.tsx': ['ts-node/register', 'typescript-node/register'],
+ '.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