aboutsummaryrefslogtreecommitdiff
path: root/node_modules/acorn-dynamic-import/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/acorn-dynamic-import/README.md')
-rwxr-xr-xnode_modules/acorn-dynamic-import/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/node_modules/acorn-dynamic-import/README.md b/node_modules/acorn-dynamic-import/README.md
new file mode 100755
index 000000000..8fcd583f7
--- /dev/null
+++ b/node_modules/acorn-dynamic-import/README.md
@@ -0,0 +1,33 @@
+# Dynamic import support in acorn
+
+This is plugin for [Acorn](http://marijnhaverbeke.nl/acorn/) - a tiny, fast JavaScript parser, written completely in JavaScript.
+
+For more information, check out the [proposal repo](https://github.com/tc39/proposal-dynamic-import).
+
+## Usage
+
+You can use this module directly in order to get Acorn instance with plugin installed:
+
+```js
+import acorn from 'acorn-dynamic-import';
+// or...
+const acorn = require('acorn-dynamic-import').default;
+```
+
+Or you can use `inject.js` for injecting plugin into your own version of Acorn like this:
+
+```js
+const acorn = require('acorn-dynamic-import/lib/inject').default(require('./custom-acorn'));
+```
+
+Then, use the `plugins` option whenever you need to support dynamicImport while parsing:
+
+```js
+const ast = acorn.parse(code, {
+ plugins: { dynamicImport: true }
+});
+```
+
+## License
+
+This plugin is issued under the [MIT license](./LICENSE).