react-native-unistyles 3.0.0-beta.7 → 3.0.0-beta.8

package/plugin/index.d.ts

@@ -1,18 +1,43 @@
-type RemapImport = {
+interface RemapImport {
+    /**
+     * The target import name if `isDefault` is false.
+     */
     name?: string,
+
+    /**
+     * Whether the import is default.
+     */
     isDefault: boolean,
+
+    /**
+     * The path to the target import.
+     */
     path: string,
+
+    /**
+     * The name of the Unistyles component, check `react-native-unistyles/src/components/native`
+     */
     mapTo: string
 }
 
-type RemapConfig = {
+/**
+ * A more powerful API that allows converting unmatched imports to Unistyles.
+ */
+export interface RemapConfig {
+    /**
+     * The node_modules path.
+     */
     path: string,
+
+    /**
+     * An array of import objects with the following properties:
+     */
     imports: Array<RemapImport>
 }
 
 export interface UnistylesPluginOptions {
     /**
-     * Example: "src" or "apps/mobile"
+     * Example: 'src' or 'apps/mobile'
      * Add this option if some of your components don't have `react-native-unistyles` import.
      * Babel plugin will automatically process all files under this root.
      */
@@ -25,29 +50,41 @@ export interface UnistylesPluginOptions {
     autoProcessImports?: Array<string>,
 
     /**
-     * Example: [{
-     *     path: "node_modules/custom-library/components",
+     * Example:
+     * ```js
+     * [{
+     *     path: 'node_modules/custom-library/components',
      *     imports: [
      *         {
-     *             name: "NativeText",
+     *             name: 'NativeText',
      *             isDefault: false,
-     *             path: "react-native/Libraries/Text/TextNativeComponent",
-     *             mapTo: "NativeText"
+     *             path: 'react-native/Libraries/Text/TextNativeComponent',
+     *             mapTo: 'NativeText'
      *         },
      *         {
      *             isDefault: true,
-     *             path: "react-native/Libraries/Components/View/ViewNativeComponent",
-     *             mapTo: "NativeView"
+     *             path: 'react-native/Libraries/Components/View/ViewNativeComponent',
+     *             mapTo: 'NativeView'
      *         }
      *     ]
      * }]
+     * ```
      *
      * Will map:
-     *      import { NativeText } from "react-native/Libraries/Text/TextNativeComponent"
-     *      to Unistyles "NativeText"
      *
-     *      import View from "react-native/Libraries/Components/View/ViewNativeComponent"
-     *      to Unistyles "NativeView"
+     * ```js
+     * import { NativeText } from 'react-native/Libraries/Text/TextNativeComponent'
+     * ```
+     *
+     * to Unistyles 'NativeText'
+     *
+     * and
+     *
+     * ```js
+     * import View from 'react-native/Libraries/Components/View/ViewNativeComponent'
+     * ```
+     *
+     * to Unistyles 'NativeView'
      *
      * This is the most powerful way of remapping imports. If 3rd party library uses imports different from `react-native` we can remap them to `react-native-unistyles` factories.
      * Internally we do that for raw RCTView and RCTText components.
@@ -83,7 +120,3 @@ export interface UnistylesPluginOptions {
     */
     isLocal?: boolean
 }
-
-export interface UnistylesPluginPass {
-    opts: UnistylesPluginOptions
-}