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

package/plugin/consts.js

@@ -0,0 +1,63 @@
+const REACT_NATIVE_COMPONENT_NAMES = [
+    'ActivityIndicator',
+    'View',
+    'Text',
+    'Image',
+    'ImageBackground',
+    'KeyboardAvoidingView',
+    'Pressable',
+    'ScrollView',
+    'FlatList',
+    'SectionList',
+    'Switch',
+    'TextInput',
+    'RefreshControl',
+    'TouchableHighlight',
+    'TouchableOpacity',
+    'VirtualizedList',
+    'Animated'
+    // Modal - there is no exposed native handle
+    // TouchableWithoutFeedback - can't accept a ref
+]
+
+// auto replace RN imports to Unistyles imports under these paths
+// our implementation simply borrows 'ref' to register it in ShadowRegistry
+// so we won't affect anyone's implementation
+const REPLACE_WITH_UNISTYLES_PATHS = [
+    'react-native-reanimated/src/component',
+    'react-native-gesture-handler/src/components'
+]
+
+// this is more powerful API as it allows to convert unmatched imports to Unistyles
+// { path: string, imports: Array<{ name: string, isDefault: boolean, path: string, mapTo: string }> }
+// path => node_modules path
+// imports:
+// name? <- target import name if isDefault is false
+// isDefault <- is the import default?
+// path <- path to the target import
+// mapTo <- name of the Unistyles component
+const REPLACE_WITH_UNISTYLES_EXOTIC_PATHS = []
+
+// this list will additionally detect React Native direct imports
+const NATIVE_COMPONENTS_PATHS = {
+    imports: [
+        {
+            name: 'NativeText',
+            isDefault: false,
+            path: 'react-native/Libraries/Text/TextNativeComponent',
+            mapTo: 'NativeText'
+        },
+        {
+            isDefault: true,
+            path: 'react-native/Libraries/Components/View/ViewNativeComponent',
+            mapTo: 'NativeView'
+        }
+    ]
+}
+
+module.exports = {
+    NATIVE_COMPONENTS_PATHS,
+    REACT_NATIVE_COMPONENT_NAMES,
+    REPLACE_WITH_UNISTYLES_PATHS,
+    REPLACE_WITH_UNISTYLES_EXOTIC_PATHS
+}

package/plugin/exotic.js

@@ -0,0 +1,54 @@
+function handleExoticImport(t, path, state, exoticImport) {
+    const specifiers = path.node.specifiers
+    const source = path.node.source
+
+    if (path.node.importKind !== 'value') {
+        return
+    }
+
+    specifiers.forEach(specifier => {
+        for (const rule of exoticImport.imports) {
+            const hasMatchingImportType = (!rule.isDefault && t.isImportSpecifier(specifier)) || (rule.isDefault && t.isImportDefaultSpecifier(specifier))
+            const hasMatchingImportName = rule.isDefault || (!rule.isDefault && rule.name === specifier.local.name)
+            const hasMatchingPath = rule.path === source.value
+
+            if (!hasMatchingImportType || !hasMatchingImportName || !hasMatchingPath) {
+                continue
+            }
+
+            if (t.isImportDefaultSpecifier(specifier)) {
+                const newImport = t.importDeclaration(
+                    [t.importDefaultSpecifier(t.identifier(specifier.local.name))],
+                    t.stringLiteral(state.opts.isLocal
+                        ? state.file.opts.filename.split('react-native-unistyles').at(0).concat(`react-native-unistyles/components/native/${rule.mapTo}`)
+                        : `react-native-unistyles/components/native/${rule.mapTo}`
+                    )
+                )
+
+                path.replaceWith(newImport)
+            } else {
+                const newImport = t.importDeclaration(
+                    [t.importSpecifier(t.identifier(rule.mapTo), t.identifier(rule.mapTo))],
+                    t.stringLiteral(state.opts.isLocal
+                        ? state.file.opts.filename.split('react-native-unistyles').at(0).concat(`react-native-unistyles/components/native/${rule.mapTo}`)
+                        : `react-native-unistyles/components/native/${rule.mapTo}`
+                    )
+                )
+
+                path.node.specifiers = specifiers.filter(s => s !== specifier)
+
+                if (path.node.specifiers.length === 0) {
+                    path.replaceWith(newImport)
+                } else {
+                    path.insertBefore(newImport)
+                }
+            }
+
+            return
+        }
+    })
+}
+
+module.exports = {
+    handleExoticImport
+}

package/plugin/import.js

@@ -31,7 +31,7 @@ function addUnistylesImport(t, path, state) {
         const newImport = t.importDeclaration(
             [t.importSpecifier(t.identifier(localName), t.identifier(name))],
             t.stringLiteral(state.opts.isLocal
-                ? state.file.opts.filename.split('react-native-unistyles').at(0).concat(`react-native-unistyles/components/native/${name}`)
+                ? state.file.opts.filename.split('react-native-unistyles').at(0).concat(`react-native-unistyles/src/components/native/${name}`)
                 : `react-native-unistyles/components/native/${name}`
             )
         )

package/plugin/index.d.ts

@@ -1,41 +1,89 @@
+type RemapImport = {
+    name?: string,
+    isDefault: boolean,
+    path: string,
+    mapTo: string
+}
+
+type RemapConfig = {
+    path: string,
+    imports: Array<RemapImport>
+}
+
 export interface UnistylesPluginOptions {
-  /**
-   * By default babel plugin will look for any `react-native-unistyles` import to start processing your file.
-   * However, in some cases you might want to process files that miss such import:
-   * - ui-kits that aggregates Unistyles components
-   * - monorepos that use Unistyles under absolute path like `@codemask/styles`
-   *
-   * If that's your case, you can configure the Babel plugin to process them.
-   */
-  autoProcessImports?: string[]
-
-  /**
-   * By default babel plugin will ignore `node_modules`.
-   * However similar to `autoProcessImports`, you can configure it to process extra paths.
-   *
-   * Under these paths we will replace `react-native` imports with `react-native-unistyles` factories that will borrow components refs [read more](https://www.unistyl.es/v3/other/babel-plugin#3-component-factory-borrowing-ref).
-   *
-   * Defaults to:
-   *
-   * ```ts
-   * ['react-native-reanimated/src/component', 'react-native-gesture-handler/src/components']
-   * ```
-   */
-  autoProcessPaths?: string[];
-
-  /**
-   * In order to list detected dependencies by the Babel plugin you can enable the `debug` flag.
-   * It will `console.log` name of the file and component with Unistyles dependencies.
-   */
-  debug?: boolean;
-
-  /**
-   * Only applicable for Unistyles monorepo for
-   * path resolution, don't use it!
-   */
-  isLocal?: boolean;
+    /**
+     * 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.
+     */
+    autoProcessRoot?: string,
+
+    /**
+    * Example: ['@codemask/styles']
+    * Enable this option if you want to process only files containing specific imports.
+    */
+    autoProcessImports?: Array<string>,
+
+    /**
+     * Example: [{
+     *     path: "node_modules/custom-library/components",
+     *     imports: [
+     *         {
+     *             name: "NativeText",
+     *             isDefault: false,
+     *             path: "react-native/Libraries/Text/TextNativeComponent",
+     *             mapTo: "NativeText"
+     *         },
+     *         {
+     *             isDefault: true,
+     *             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"
+     *
+     * 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.
+     *
+     * path -> must be within node_modules folder
+     * imports.name is Optional if library used export default
+     * imports.mapTo - name of the component from react-native-unistyles/src/components/native
+     */
+    autoRemapImports?: Array<RemapConfig>,
+
+    /**
+    * Example: ['external-library/components']
+    * Enable this option to process some 3rd party components under `node_modules`.
+    * Under these paths we will replace `react-native` imports with `react-native-unistyles` factories that will borrow components refs [read more](https://www.unistyl.es/v3/other/babel-plugin#3-component-factory-borrowing-ref).
+    *
+    * Defaults to:
+    *
+    * ```ts
+    * ['react-native-reanimated/src/component', 'react-native-gesture-handler/src/components']
+    * ```
+    */
+    autoProcessPaths?: Array<string>,
+
+    /**
+    * In order to list detected dependencies by the Babel plugin you can enable the `debug` flag.
+    * It will `console.log` name of the file and component with Unistyles dependencies.
+    */
+    debug?: boolean,
+
+    /**
+    * Only applicable for Unistyles monorepo for
+    * path resolution, don't use it!
+    */
+    isLocal?: boolean
 }
 
 export interface UnistylesPluginPass {
-  opts: UnistylesPluginOptions;
+    opts: UnistylesPluginOptions
 }

package/plugin/index.js

@@ -1,36 +1,9 @@
 const { addUnistylesImport, isInsideNodeModules } = require('./import')
 const { hasStringRef } = require('./ref')
-const { isUnistylesStyleSheet, analyzeDependencies, addStyleSheetTag, getUnistyles, isKindOfStyleSheet } = require('./stylesheet')
+const { isUnistylesStyleSheet, addStyleSheetTag, isKindOfStyleSheet, getStylesDependenciesFromFunction, addDependencies, getStylesDependenciesFromObject } = require('./stylesheet')
 const { extractVariants } = require('./variants')
-
-const reactNativeComponentNames = [
-    'ActivityIndicator',
-    'View',
-    'Text',
-    'Image',
-    'ImageBackground',
-    'KeyboardAvoidingView',
-    'Pressable',
-    'ScrollView',
-    'FlatList',
-    'SectionList',
-    'Switch',
-    'TextInput',
-    'RefreshControl',
-    'TouchableHighlight',
-    'TouchableOpacity',
-    'VirtualizedList',
-    // Modal - there is no exposed native handle
-    // TouchableWithoutFeedback - can't accept a ref
-]
-
-// auto replace RN imports to Unistyles imports under these paths
-// our implementation simply borrows 'ref' to register it in ShadowRegistry
-// so we won't affect anyone's implementation
-const REPLACE_WITH_UNISTYLES_PATHS = [
-    'react-native-reanimated/src/component',
-    'react-native-gesture-handler/src/components'
-]
+const { REACT_NATIVE_COMPONENT_NAMES, REPLACE_WITH_UNISTYLES_PATHS, REPLACE_WITH_UNISTYLES_EXOTIC_PATHS, NATIVE_COMPONENTS_PATHS } = require('./consts')
+const { handleExoticImport } = require('./exotic')
 
 module.exports = function ({ types: t }) {
     return {
@@ -44,18 +17,21 @@ module.exports = function ({ types: t }) {
                         .some(path => state.filename.includes(path))
 
                     state.file.hasAnyUnistyle = false
+                    state.file.hasUnistylesImport = false
                     state.file.hasVariants = false
                     state.file.styleSheetLocalName = ''
                     state.file.tagNumber = 0
                     state.reactNativeImports = {}
-                    state.file.forceProcessing = false
+                    state.file.forceProcessing = state.opts.autoProcessRoot
+                        ? state.filename.includes(`${state.file.opts.root}/${state.opts.autoProcessRoot}/`)
+                        : false
                 },
                 exit(path, state) {
                     if (isInsideNodeModules(state) && !state.file.replaceWithUnistyles) {
                         return
                     }
 
-                    if (state.file.hasAnyUnistyle || state.file.hasVariants || state.file.replaceWithUnistyles) {
+                    if (state.file.hasAnyUnistyle || state.file.hasVariants || state.file.replaceWithUnistyles || state.file.forceProcessing) {
                         addUnistylesImport(t, path, state)
                     }
                 }
@@ -105,6 +81,14 @@ module.exports = function ({ types: t }) {
             },
             /** @param {import('./index').UnistylesPluginPass} state */
             ImportDeclaration(path, state) {
+                const exoticImport = REPLACE_WITH_UNISTYLES_EXOTIC_PATHS
+                    .concat(state.opts.autoRemapImports ?? [])
+                    .find(exotic => state.filename.includes(exotic.path))
+
+                if (exoticImport) {
+                    return handleExoticImport(t, path, state, exoticImport)
+                }
+
                 if (isInsideNodeModules(state) && !state.file.replaceWithUnistyles) {
                     return
                 }
@@ -112,6 +96,8 @@ module.exports = function ({ types: t }) {
                 const importSource = path.node.source.value
 
                 if (importSource.includes('react-native-unistyles')) {
+                    state.file.hasUnistylesImport = true
+
                     path.node.specifiers.forEach(specifier => {
                         if (specifier.imported && specifier.imported.name === 'StyleSheet') {
                             state.file.styleSheetLocalName = specifier.local.name
@@ -121,12 +107,16 @@ module.exports = function ({ types: t }) {
 
                 if (importSource === 'react-native') {
                     path.node.specifiers.forEach(specifier => {
-                        if (specifier.imported && reactNativeComponentNames.includes(specifier.imported.name)) {
+                        if (specifier.imported && REACT_NATIVE_COMPONENT_NAMES.includes(specifier.imported.name)) {
                             state.reactNativeImports[specifier.local.name] = specifier.imported.name
                         }
                     })
                 }
 
+                if (importSource.includes('react-native/Libraries')) {
+                    handleExoticImport(t, path, state, NATIVE_COMPONENTS_PATHS)
+                }
+
                 if (!state.file.forceProcessing && Array.isArray(state.opts.autoProcessImports)) {
                     state.file.forceProcessing = state.opts.autoProcessImports.includes(importSource)
                 }
@@ -162,45 +152,38 @@ module.exports = function ({ types: t }) {
 
                 const arg = path.node.arguments[0]
 
-                // Object passed to StyleSheet.create
+                // Object passed to StyleSheet.create (may contain variants)
                 if (t.isObjectExpression(arg)) {
-                    arg.properties.forEach(property => {
-                        if (t.isObjectProperty(property)) {
-                            const propertyValues = getUnistyles(t, property)
-
-                            propertyValues.forEach(propertyValue => {
-                                analyzeDependencies(t, state, property.key.name, propertyValue)
+                    const detectedDependencies = getStylesDependenciesFromObject(t, path)
+
+                    if (detectedDependencies) {
+                        if (t.isObjectExpression(arg)) {
+                            arg.properties.forEach(property => {
+                                if (detectedDependencies.hasOwnProperty(property.key.name)) {
+                                    addDependencies(t, state, property.key.name, property, detectedDependencies[property.key.name])
+                                }
                             })
                         }
-                    })
+                    }
                 }
 
                 // Function passed to StyleSheet.create (e.g., theme => ({ container: {} }))
                 if (t.isArrowFunctionExpression(arg) || t.isFunctionExpression(arg)) {
-                    const params = arg.params
-                    const hasTheme = params.length >= 1
-                    const hasMiniRuntime = params.length === 2
-                    const themeLocalName = hasTheme
-                        ? params[0].name
-                        : undefined
-                    const miniRuntimeLocalName = hasMiniRuntime
-                        ? params[1].name
-                        : undefined
-                    const body = t.isBlockStatement(arg.body)
-                        ? arg.body.body.find(statement => t.isReturnStatement(statement)).argument
-                        : arg.body
-
-                    // Ensure the function body returns an object
-                    if (t.isObjectExpression(body)) {
-                        body.properties.forEach(property => {
-                            if (t.isObjectProperty(property)) {
-                                const propertyValues = getUnistyles(t, property)
-
-                                propertyValues.forEach(propertyValue => {
-                                    analyzeDependencies(t, state, property.key.name, propertyValue, themeLocalName, miniRuntimeLocalName)
-                                })
-                            }
-                        })
+                    const detectedDependencies = getStylesDependenciesFromFunction(t, path)
+
+                    if (detectedDependencies) {
+                        const body = t.isBlockStatement(arg.body)
+                            ? arg.body.body.find(statement => t.isReturnStatement(statement)).argument
+                            : arg.body
+
+                        // Ensure the function body returns an object
+                        if (t.isObjectExpression(body)) {
+                            body.properties.forEach(property => {
+                                if (detectedDependencies.hasOwnProperty(property.key.name)) {
+                                    addDependencies(t, state, property.key.name, property, detectedDependencies[property.key.name])
+                                }
+                            })
+                        }
                     }
                 }
             }