feat: add kotlin support to turbo module template

satya164 · satya164 · commit ad4384374e05 · 2022-10-21T15:50:33.000+02:00
diff --git a/.github/workflows/build-templates.yml b/.github/workflows/build-templates.yml
@@ -10,6 +10,9 @@ jobs:
       matrix:
         type:
           - module
+          - module-legacy
+          - module-mixed
+          - module-turbo
           - view
         language:
           - java-objc
@@ -19,22 +22,26 @@ jobs:
           - cpp
         example:
           - native
+        exclude:
+          - type: module-turbo
+            language: java-swift
+          - type: module-turbo
+            language: kotlin-swift
+          - type: module-mixed
+            language: java-swift
+          - type: module-mixed
+            language: kotlin-swift
+          - type: module-legacy
+            language: java-swift
+          - type: module-legacy
+            language: kotlin-swift
         include:
           - type: module
             language: js
             example: expo
           - type: module
             language: js
             example: native
-          - type: module-legacy
-            language: java-objc
-            example: native
-          - type: module-turbo
-            language: java-objc
-            example: native
-          - type: module-mixed
-            language: java-objc
-            example: native
 
     steps:
       - name: Checkout
diff --git a/packages/create-react-native-library/src/index.ts b/packages/create-react-native-library/src/index.ts
@@ -49,7 +49,9 @@ const OBJC_FILES = {
 };
 
 const KOTLIN_FILES = {
-  module: path.resolve(__dirname, '../templates/kotlin-library'),
+  module_legacy: path.resolve(__dirname, '../templates/kotlin-library-legacy'),
+  module_turbo: path.resolve(__dirname, '../templates/kotlin-library-turbo'),
+  module_mixed: path.resolve(__dirname, '../templates/kotlin-library-mixed'),
   view: path.resolve(__dirname, '../templates/kotlin-view-library'),
 };
 
@@ -287,21 +289,25 @@ async function create(argv: yargs.Arguments<any>) {
       ],
     },
     'languages': {
-      type: (_, values) =>
-        values.type === 'library' ||
-        values.type === 'module-turbo' ||
-        values.type === 'module-mixed'
-          ? null
-          : 'select',
+      type: (_, values) => (values.type !== 'library' ? 'select' : null),
       name: 'languages',
       message: 'Which languages do you want to use?',
-      choices: [
-        { title: 'Java & Objective-C', value: 'java-objc' },
-        { title: 'Java & Swift', value: 'java-swift' },
-        { title: 'Kotlin & Objective-C', value: 'kotlin-objc' },
-        { title: 'Kotlin & Swift', value: 'kotlin-swift' },
-        { title: 'C++ for both iOS & Android', value: 'cpp' },
-      ],
+      choices: (_, values) => {
+        const languages = [
+          { title: 'Java & Objective-C', value: 'java-objc' },
+          { title: 'Kotlin & Objective-C', value: 'kotlin-objc' },
+        ];
+
+        if (values.type !== 'module-turbo' && values.type !== 'module-mixed') {
+          languages.push(
+            { title: 'Java & Swift', value: 'java-swift' },
+            { title: 'Kotlin & Swift', value: 'kotlin-swift' },
+            { title: 'C++ for both iOS & Android', value: 'cpp' }
+          );
+        }
+
+        return languages;
+      },
     },
     'example': {
       type: (_, values) => (values.type === 'library' ? 'select' : null),
@@ -440,7 +446,7 @@ async function create(argv: yargs.Arguments<any>) {
 
   await fs.mkdirp(folder);
 
-  const spinner = ora('Generating example app').start();
+  const spinner = ora('Generating example').start();
 
   await generateExampleApp({
     type: example,
@@ -449,9 +455,7 @@ async function create(argv: yargs.Arguments<any>) {
     isNewArch: options.project.turbomodule,
   });
 
-  spinner.succeed(
-    `Project created successfully at ${kleur.yellow(argv.name)}!\n`
-  );
+  spinner.text = 'Copying files';
 
   await copyDir(COMMON_FILES, folder);
 
@@ -493,14 +497,12 @@ async function create(argv: yargs.Arguments<any>) {
       await copyDir(OBJC_FILES[moduleType], folder);
     }
 
-    if (options.project.kotlin) {
-      await copyDir(KOTLIN_FILES[moduleType], folder);
+    const android_files = options.project.kotlin ? KOTLIN_FILES : JAVA_FILES;
+
+    if (moduleType === 'module') {
+      await copyDir(android_files[`${moduleType}_${architecture}`], folder);
     } else {
-      if (moduleType === 'module') {
-        await copyDir(JAVA_FILES[`${moduleType}_${architecture}`], folder);
-      } else {
-        await copyDir(JAVA_FILES[moduleType], folder);
-      }
+      await copyDir(android_files[moduleType], folder);
     }
 
     if (options.project.cpp) {
@@ -532,6 +534,10 @@ async function create(argv: yargs.Arguments<any>) {
     // Ignore error
   }
 
+  spinner.succeed(
+    `Project created successfully at ${kleur.yellow(argv.name)}!\n`
+  );
+
   const platforms = {
     ios: { name: 'iOS', color: 'cyan' },
     android: { name: 'Android', color: 'green' },
diff --git a/packages/create-react-native-library/src/utils/generateExampleApp.ts b/packages/create-react-native-library/src/utils/generateExampleApp.ts
@@ -131,7 +131,7 @@ export default async function generateExampleApp({
 
     await fs.writeFile(
       path.join(directory, 'ios', 'Podfile'),
-      "ENV['RCT_NEW_ARCH_ENABLED'] = '1'\n" + podfile
+      "ENV['RCT_NEW_ARCH_ENABLED'] = '1'\n\n" + podfile
     );
   }
 }
diff --git a/packages/create-react-native-library/templates/common/CONTRIBUTING.md b/packages/create-react-native-library/templates/common/CONTRIBUTING.md
@@ -32,6 +32,12 @@ To run the example app on iOS:
 yarn example ios
 ```
 
+<% if (project.architecture == 'mixed') { -%>
+By default, the example is configured to build with the new architecture. To build with the old architecture, you can change the following:
+
+1. For Android, change `newArchEnabled=true` to `newArchEnabled=false` in `example/android/gradle.properties`.
+2. For iOS, change `ENV['RCT_NEW_ARCH_ENABLED'] = '1'` to `ENV['RCT_NEW_ARCH_ENABLED'] = '0'` in `example/ios/Podfile`.
+<% } -%>
 <% if (!project.native) { -%>
 To run the example app on Web:
 
diff --git a/packages/create-react-native-library/templates/java-library-mixed/android/src/legacy/{%- project.name %}Module.java b/packages/create-react-native-library/templates/java-library-mixed/android/src/legacy/{%- project.name %}Module.java
@@ -16,7 +16,7 @@ public class <%- project.name -%>Module extends ReactContextBaseJavaModule {
   @Override
   @NonNull
   public String getName() {
-    return <%- project.name -%>ModuleImpl.NAME;
+    return NAME;
   }
 
   // Example method
diff --git a/packages/create-react-native-library/templates/java-library-mixed/android/src/turbo/{%- project.name %}Module.java b/packages/create-react-native-library/templates/java-library-mixed/android/src/turbo/{%- project.name %}Module.java
@@ -15,7 +15,7 @@ public class <%- project.name -%>Module extends Native<%- project.name -%>Spec {
   @Override
   @NonNull
   public String getName() {
-    return <%- project.name -%>ModuleImpl.NAME;
+    return NAME;
   }
 
   // Example method
diff --git a/packages/create-react-native-library/templates/java-library-turbo/android/src/main/java/com/{%- project.package %}/{%- project.name %}Module.java b/packages/create-react-native-library/templates/java-library-turbo/android/src/main/java/com/{%- project.package %}/{%- project.name %}Module.java
@@ -2,9 +2,7 @@
 
 import androidx.annotation.NonNull;
 
-import com.facebook.react.bridge.Promise;
 import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.bridge.ReactMethod;
 import com.facebook.react.module.annotations.ReactModule;
 
 @ReactModule(name = <%- project.name -%>Module.NAME)
diff --git a/packages/create-react-native-library/templates/kotlin-library-legacy/android/src/main/java/com/{%- project.package %}/{%- project.name %}Module.kt b/packages/create-react-native-library/templates/kotlin-library-legacy/android/src/main/java/com/{%- project.package %}/{%- project.name %}Module.kt
diff --git a/packages/create-react-native-library/templates/kotlin-library-legacy/android/src/main/java/com/{%- project.package %}/{%- project.name %}Package.kt b/packages/create-react-native-library/templates/kotlin-library-legacy/android/src/main/java/com/{%- project.package %}/{%- project.name %}Package.kt
diff --git a/packages/create-react-native-library/templates/kotlin-library-mixed/android/src/legacy/{%- project.name %}Module.kt b/packages/create-react-native-library/templates/kotlin-library-mixed/android/src/legacy/{%- project.name %}Module.kt
@@ -0,0 +1,25 @@
+package com.<%- project.package -%>;
+
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.ReactContextBaseJavaModule
+import com.facebook.react.bridge.ReactMethod
+import com.facebook.react.bridge.Promise
+
+class <%- project.name -%>Module internal constructor(context: ReactApplicationContext?) :
+    ReactContextBaseJavaModule(context) {
+
+    override fun getName(): String {
+        return NAME
+    }
+
+    // Example method
+    // See https://reactnative.dev/docs/native-modules-android
+    @ReactMethod
+    fun multiply(a: Double, b: Double, promise: Promise) {
+        <%- project.name -%>ModuleImpl.multiply(a, b, promise)
+    }
+
+    companion object {
+        const val NAME = <%- project.name -%>ModuleImpl.NAME
+    }
+}
diff --git a/packages/create-react-native-library/templates/kotlin-library-mixed/android/src/main/java/com/{%- project.package %}/{%- project.name %}ModuleImpl.kt b/packages/create-react-native-library/templates/kotlin-library-mixed/android/src/main/java/com/{%- project.package %}/{%- project.name %}ModuleImpl.kt
@@ -0,0 +1,15 @@
+package com.<%- project.package -%>;
+
+import com.facebook.react.bridge.Promise
+
+/**
+ * This is where the module implementation lives
+ * The exposed methods can be defined in the `turbo` and `legacy` folders
+ */
+object <%- project.name -%>ModuleImpl {
+    const val NAME = "<%- project.name -%>"
+
+    fun multiply(a: Double, b: Double, promise: Promise) {
+        promise.resolve(a * b)
+    }
+}
diff --git a/packages/create-react-native-library/templates/kotlin-library-mixed/android/src/main/java/com/{%- project.package %}/{%- project.name %}Package.kt b/packages/create-react-native-library/templates/kotlin-library-mixed/android/src/main/java/com/{%- project.package %}/{%- project.name %}Package.kt
@@ -0,0 +1,35 @@
+package com.<%- project.package -%>;
+
+import com.facebook.react.TurboReactPackage
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.NativeModule
+import com.facebook.react.module.model.ReactModuleInfoProvider
+import com.facebook.react.module.model.ReactModuleInfo
+import java.util.HashMap
+
+class <%- project.name -%>Package : TurboReactPackage() {
+    override fun getModule(name: String, reactContext: ReactApplicationContext): NativeModule? {
+        return if (name == <%- project.name -%>Module.NAME) {
+            <%- project.name -%>Module(reactContext)
+        } else {
+            null
+        }
+    }
+
+    override fun getReactModuleInfoProvider(): ReactModuleInfoProvider {
+        return ReactModuleInfoProvider {
+            val moduleInfos: MutableMap<String, ReactModuleInfo> = HashMap()
+            val isTurboModule: Boolean = BuildConfig.IS_NEW_ARCHITECTURE_ENABLED
+            moduleInfos[<%- project.name -%>Module.NAME] = ReactModuleInfo(
+                <%- project.name -%>Module.NAME,
+                <%- project.name -%>Module.NAME,
+                false,  // canOverrideExistingModule
+                false,  // needsEagerInit
+                true,  // hasConstants
+                false,  // isCxxModule
+                isTurboModule // isTurboModule
+            )
+            moduleInfos
+        }
+    }
+}
diff --git a/packages/create-react-native-library/templates/kotlin-library-mixed/android/src/turbo/{%- project.name %}Module.kt b/packages/create-react-native-library/templates/kotlin-library-mixed/android/src/turbo/{%- project.name %}Module.kt
@@ -0,0 +1,23 @@
+package com.<%- project.package -%>;
+
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.ReactMethod
+import com.facebook.react.bridge.Promise
+
+class <%- project.name -%>Module internal constructor(context: ReactApplicationContext?) :
+    Native<%- project.name -%>Spec(context) {
+    override fun getName(): String {
+        return NAME
+    }
+
+    // Example method
+    // See https://reactnative.dev/docs/native-modules-android
+    @ReactMethod
+    override fun multiply(a: Double, b: Double, promise: Promise) {
+        <%- project.name -%>ModuleImpl.multiply(a, b, promise)
+    }
+
+    companion object {
+        val NAME: String = <%- project.name -%>ModuleImpl.NAME
+    }
+}
diff --git a/packages/create-react-native-library/templates/kotlin-library-turbo/android/src/main/java/com/{%- project.package %}/{%- project.name %}Module.kt b/packages/create-react-native-library/templates/kotlin-library-turbo/android/src/main/java/com/{%- project.package %}/{%- project.name %}Module.kt
@@ -0,0 +1,21 @@
+package com.<%- project.package -%>
+
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.module.annotations.ReactModule
+
+@ReactModule(name = <%- project.name -%>Module.NAME)
+class <%- project.name -%>Module(reactContext: ReactApplicationContext?) : Native<%- project.name -%>Spec(reactContext) {
+    override fun getName(): String {
+        return NAME
+    }
+
+    // Example method
+    // See https://reactnative.dev/docs/native-modules-android
+    override fun multiply(a: Double, b: Double): Double {
+        return a * b
+    }
+
+    companion object {
+        const val NAME = "<%- project.name -%>"
+    }
+}
diff --git a/packages/create-react-native-library/templates/kotlin-library-turbo/android/src/main/java/com/{%- project.package %}/{%- project.name %}Package.kt b/packages/create-react-native-library/templates/kotlin-library-turbo/android/src/main/java/com/{%- project.package %}/{%- project.name %}Package.kt
@@ -0,0 +1,34 @@
+package com.<%- project.package -%>
+
+import com.facebook.react.TurboReactPackage
+import com.facebook.react.bridge.NativeModule
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.module.model.ReactModuleInfo
+import com.facebook.react.module.model.ReactModuleInfoProvider
+import java.util.HashMap
+
+class <%- project.name -%>Package : TurboReactPackage() {
+    override fun getModule(name: String, reactContext: ReactApplicationContext): NativeModule? {
+        return if (name == <%- project.name -%>Module.NAME) {
+            <%- project.name -%>Module(reactContext)
+        } else {
+            null
+        }
+    }
+
+    override fun getReactModuleInfoProvider(): ReactModuleInfoProvider {
+        return ReactModuleInfoProvider {
+            val moduleInfos: MutableMap<String, ReactModuleInfo> = HashMap()
+            moduleInfos[<%- project.name -%>Module.NAME] = ReactModuleInfo(
+                <%- project.name -%>Module.NAME,
+                <%- project.name -%>Module.NAME,
+                false,  // canOverrideExistingModule
+                false,  // needsEagerInit
+                true,  // hasConstants
+                false,  // isCxxModule
+                true // isTurboModule
+            )
+            moduleInfos
+        }
+    }
+}
diff --git a/packages/create-react-native-library/templates/native-common/android/build.gradle b/packages/create-react-native-library/templates/native-common/android/build.gradle
@@ -79,13 +79,29 @@ android {
     sourceCompatibility JavaVersion.VERSION_1_8
     targetCompatibility JavaVersion.VERSION_1_8
   }
-<% if (project.architecture == 'mixed') { -%>
+
+<% if (project.architecture == 'turbo') { -%>
+  sourceSets {
+    main {
+      if (isNewArchitectureEnabled()) {
+          java.srcDirs += [
+            // This is needed to build Kotlin project with TurboModules enabled
+            "${project.buildDir}/generated/source/codegen/java"
+          ]
+      }
+    }
+  }
+<% } else if (project.architecture == 'mixed') { -%>
   sourceSets {
     main {
       if (isNewArchitectureEnabled()) {
-          java.srcDirs += ['src/turbo']
+          java.srcDirs += [
+            "src/turbo",
+            // This is needed to build Kotlin project with TurboModules enabled
+            "${project.buildDir}/generated/source/codegen/java"
+          ]
       } else {
-          java.srcDirs += ['src/legacy']
+          java.srcDirs += ["src/legacy"]
       }
     }
   }

Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,7 @@ export default async function generateExampleApp({`
`131`	`131`
`132`	`132`	`await fs.writeFile(`
`133`	`133`	`path.join(directory, 'ios', 'Podfile'),`
`134`		`- "ENV['RCT_NEW_ARCH_ENABLED'] = '1'\n" + podfile`
	`134`	`+ "ENV['RCT_NEW_ARCH_ENABLED'] = '1'\n\n" + podfile`
`135`	`135`	`);`
`136`	`136`	`}`
`137`	`137`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public class <%- project.name -%>Module extends ReactContextBaseJavaModule {`
`16`	`16`	`@Override`
`17`	`17`	`@NonNull`
`18`	`18`	`public String getName() {`
`19`		`- return <%- project.name -%>ModuleImpl.NAME;`
	`19`	`+ return NAME;`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`// Example method`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public class <%- project.name -%>Module extends Native<%- project.name -%>Spec {`
`15`	`15`	`@Override`
`16`	`16`	`@NonNull`
`17`	`17`	`public String getName() {`
`18`		`- return <%- project.name -%>ModuleImpl.NAME;`
	`18`	`+ return NAME;`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`// Example method`