@lwc/babel-plugin-component 2.42.0 → 2.43.0

package/README.md

@@ -1,5 +1,7 @@
 # @lwc/babel-plugin-component
 
+## Summary
+
 This babel plugin does the following transform:
 
 -   Global decorator transform:
@@ -11,3 +13,38 @@ This babel plugin does the following transform:
     -   Import and inject `render` from a collocated template if a component class doesn't already implement a `render` method.
 -   Optimization:
     -   If the compiler inject the default template a component, it will also wire the template style to the component.
+
+## Installation
+
+    npm install babel @lwc/babel-plugin-component
+
+## Usage
+
+```js
+const babel = require('@babel/core');
+const lwcPlugin = require('@lwc/babel-plugin-component');
+
+const source = `
+import { LightningElement } from 'lwc';
+export default class extends LightningElement {}`;
+
+const { code } = babel.transformSync(source, {
+    plugins: [
+        [
+            lwcPlugin,
+            {
+                /* options */
+            },
+        ],
+    ],
+});
+```
+
+## Options
+
+-   `name` (type: `string`, optional) - name of the component, e.g. `foo` in `x/foo`.
+-   `namespace` (type: `string`, optional) - namepace of the component, e.g. `x` in `x/foo`.
+-   `isExplicitImport` (type: `boolean`, optional) - true if this is an explicit import.
+-   `dynamicImports` (type: `object`, optional) - see below:
+    -   `loader` (type: `string`, optional) - loader to use at runtime.
+    -   `strictSpecifier` (type: `boolean`, optional) - true if a strict specifier should be used.