From e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d Mon Sep 17 00:00:00 2001
From: Piotr Russ <mail@pruss.it>
Date: Mon, 16 Nov 2020 00:10:28 +0100
Subject: api, login, auth

---
 node_modules/babel-register/README.md | 103 ++++++++++++++++++++++++++++++++++
 1 file changed, 103 insertions(+)
 create mode 100644 node_modules/babel-register/README.md

(limited to 'node_modules/babel-register/README.md')

diff --git a/node_modules/babel-register/README.md b/node_modules/babel-register/README.md
new file mode 100644
index 0000000..413e7a6
--- /dev/null
+++ b/node_modules/babel-register/README.md
@@ -0,0 +1,103 @@
+# babel-register
+
+> The require hook will bind itself to node's require and automatically compile files on the fly.
+
+One of the ways you can use Babel is through the require hook. The require hook
+will bind itself to node's `require` and automatically compile files on the
+fly. This is equivalent to CoffeeScript's
+[coffee-script/register](http://coffeescript.org/v2/annotated-source/register.html).
+
+## Install
+
+```sh
+npm install babel-register --save-dev
+```
+
+## Usage
+
+```js
+require("babel-register");
+```
+
+All subsequent files required by node with the extensions `.es6`, `.es`, `.jsx`
+and `.js` will be transformed by Babel.
+
+<blockquote class="babel-callout babel-callout-info">
+  <h4>Polyfill not included</h4>
+  <p>
+    You must include the <a href="https://babeljs.io/docs/usage/polyfill/">polyfill</a> separately
+    when using features that require it, like generators.
+  </p>
+</blockquote>
+
+### Ignores `node_modules` by default
+
+**NOTE:** By default all requires to `node_modules` will be ignored. You can
+override this by passing an ignore regex via:
+
+```js
+require("babel-register")({
+  // This will override `node_modules` ignoring - you can alternatively pass
+  // an array of strings to be explicitly matched or a regex / glob
+  ignore: false
+});
+```
+
+## Specifying options
+
+```javascript
+require("babel-register")({
+  // Optional ignore regex - if any filenames **do** match this regex then they
+  // aren't compiled.
+  ignore: /regex/,
+
+  // Ignore can also be specified as a function.
+  ignore: function(filename) {
+    if (filename === "/path/to/es6-file.js") {
+      return false;
+    } else {
+      return true;
+    }
+  },
+
+  // Optional only regex - if any filenames **don't** match this regex then they
+  // aren't compiled
+  only: /my_es6_folder/,
+
+  // Setting this will remove the currently hooked extensions of .es6, `.es`, `.jsx`
+  // and .js so you'll have to add them back if you want them to be used again.
+  extensions: [".es6", ".es", ".jsx", ".js"],
+
+  // Setting this to false will disable the cache.
+  cache: true
+});
+```
+
+You can pass in all other [options](https://babeljs.io/docs/usage/api/#options) as well,
+including `plugins` and `presets`. But note that the closest [`.babelrc`](https://babeljs.io/docs/usage/babelrc/)
+to each file still applies, and takes precedence over any options you pass in here.
+
+## Environment variables
+
+By default `babel-node` and `babel-register` will save to a json cache in your
+temporary directory.
+
+This will heavily improve with the startup and compilation of your files. There
+are however scenarios where you want to change this behaviour and there are
+environment variables exposed to allow you to do this.
+
+### BABEL_CACHE_PATH
+
+Specify a different cache location.
+
+```sh
+BABEL_CACHE_PATH=/foo/my-cache.json babel-node script.js
+```
+
+### BABEL_DISABLE_CACHE
+
+Disable the cache.
+
+```sh
+BABEL_DISABLE_CACHE=1 babel-node script.js
+```
-- 
cgit v1.2.3