refactor: unify module implementation across templates

Author: satya164

src/create.ts

@@ -16,6 +16,7 @@ const COMMON_FILES = path.resolve(__dirname, '../templates/common');
 const NATIVE_FILES = path.resolve(__dirname, '../templates/native-library');
 const EXPO_FILES = path.resolve(__dirname, '../templates/expo-library');
 const CPP_FILES = path.resolve(__dirname, '../templates/cpp-library');
+const OBJC_FILES = path.resolve(__dirname, '../templates/objc-library');
 
 export default async function create(argv: yargs.Arguments<any>) {
   const folder = path.join(process.cwd(), argv.name);
@@ -55,8 +56,8 @@ export default async function create(argv: yargs.Arguments<any>) {
     authorEmail,
     authorUrl,
     githubUrl: repo,
-    useNative,
-    useCpp,
+    native,
+    cpp,
   } = (await inquirer.prompt([
     {
       type: 'input',
@@ -126,16 +127,16 @@ export default async function create(argv: yargs.Arguments<any>) {
     },
     {
       type: 'confirm',
-      name: 'useNative',
+      name: 'native',
       message: 'Do you want to use Java or Objective-C code?',
       default: true,
     },
     {
       type: 'confirm',
-      name: 'useCpp',
+      name: 'cpp',
       message: 'Do you want to use C++ code?',
       default: false,
-      when: (response) => response.useNative,
+      when: (response) => response.native,
     },
   ])) as {
     slug: string;
@@ -144,8 +145,8 @@ export default async function create(argv: yargs.Arguments<any>) {
     authorEmail: string;
     authorUrl: string;
     githubUrl: string;
-    useNative: boolean;
-    useCpp: boolean;
+    native: boolean;
+    cpp: boolean;
   };
 
   const project = slug.replace(/^(react-native-|@[^/]+\/)/, '');
@@ -164,7 +165,8 @@ export default async function create(argv: yargs.Arguments<any>) {
         .slice(1)}`,
       package: slug.replace(/[^a-z0-9]/g, '').toLowerCase(),
       podspec: slug.replace(/[^a-z0-9]+/g, '-').replace(/^-/, ''),
-      useCpp,
+      native,
+      cpp,
     },
     author: {
       name: authorName,
@@ -199,14 +201,16 @@ export default async function create(argv: yargs.Arguments<any>) {
 
   await copyDir(COMMON_FILES, folder);
 
-  if (useNative) {
+  if (native) {
     await copyDir(NATIVE_FILES, folder);
   } else {
     await copyDir(EXPO_FILES, folder);
   }
 
-  if (useCpp) {
+  if (cpp) {
     await copyDir(CPP_FILES, folder);
+  } else {
+    await copyDir(OBJC_FILES, folder);
   }
 
   try {
@@ -219,23 +223,29 @@ export default async function create(argv: yargs.Arguments<any>) {
     // Ignore error
   }
 
+  const platforms = {
+    ios: { name: 'iOS', color: 'cyan' },
+    android: { name: 'Android', color: 'green' },
+    ...(native ? null : { web: { name: 'Web', color: 'blue' } }),
+  };
+
   console.log(
     dedent(chalk`
-      Project created successfully at {blue ${argv.name}}!
+      Project created successfully at {yellow ${argv.name}}!
 
       {magenta {bold Get started} with the project}{gray :}
 
         {gray $} yarn bootstrap
+      ${Object.entries(platforms)
+        .map(
+          ([script, { name, color }]) => chalk`
+      {${color} Run the example app on {bold ${name}}}{gray :}
 
-      {cyan Run the example app on {bold iOS}}{gray :}
-
-        {gray $} yarn example ios
-
-      {green Run the example app on {bold Android}}{gray :}
-
-        {gray $} yarn example android
+        {gray $} yarn example ${script}`
+        )
+        .join('\n')}
 
-      {blue Good luck!}
+      {yellow Good luck!}
     `)
   );
 }

templates/common/CONTRIBUTING.md

@@ -27,9 +27,15 @@ yarn example android
 To run the example app on iOS:
 
 ```sh
-yarn example android
+yarn example ios
 ```
+<% if (!project.native) { %>
+To run the example app on Web:
 
+```sh
+yarn example web
+```
+<% } %>
 Make sure your code passes TypeScript and ESLint. Run the following to verify:
 
 ```sh
@@ -48,7 +54,11 @@ Remember to add tests for your change if possible. Run the unit tests by:
 ```sh
 yarn test
 ```
+<% if (project.native) { %>
+To edit the Objective-C files, open `example/ios/<%= project.name %>Example.xcworkspace` in XCode and find the source files at `Pods > Development Pods > <%= project.slug %>`.
 
+To edit the Java files, open `example/android` in Android studio and find the source files at `<%= project.package %>` under `Android`.
+<% } %>
 ### Commit message convention
 
 We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:

templates/common/README.md

@@ -15,7 +15,7 @@ import <%= project.name %> from "<%= project.slug %>";
 
 // ...
 
-const deviceName = await <%= project.name %>.getDeviceName();
+const result = await <%= project.name %>.multiply(3, 7);
 ```
 
 ## Contributing

templates/expo-library/example/src/App.tsx renamed to templates/common/example/src/App.tsx

@@ -3,9 +3,15 @@ import { StyleSheet, View, Text } from 'react-native';
 import <%= project.name %> from '<%= project.slug %>';
 
 export default function App() {
+  const [result, setResult] = React.useState<number | undefined>();
+
+  React.useEffect(() => {
+    <%= project.name %>.multiply(3, 7).then(setResult);
+  }, []);
+
   return (
     <View style={styles.container}>
-      <Text>{<%= project.name %>}</Text>
+      <Text>Result: {result}</Text>
     </View>
   );
 }

templates/cpp-library/cpp/example.cpp

@@ -1,7 +1,7 @@
 #include "example.h"
 
 namespace example {
-	int multiply(int a, int b) {
+	int multiply(float a, float b) {
 		return a * b;
 	}
 }

templates/cpp-library/cpp/example.h

@@ -2,7 +2,7 @@
 #define EXAMPLE_H
 
 namespace example {
-  int multiply(int a, int b);
+  int multiply(float a, float b);
 }
 
 #endif /* EXAMPLE_H */

templates/native-library/ios/<%= project.name %>.h renamed to templates/cpp-library/ios/<%= project.name %>.h

@@ -1,12 +1,10 @@
 #import <React/RCTBridgeModule.h>
 
-<%if (project.useCpp==true) {%>
 #ifdef __cplusplus
 
 #import "example.h"
 
 #endif
-<%}%>
 
 @interface <%= project.name %> : NSObject <RCTBridgeModule>
 

templates/cpp-library/ios/<%= project.name %>.mm

@@ -0,0 +1,17 @@
+#import "<%= project.name %>.h"
+
+@implementation <%= project.name %>
+
+RCT_EXPORT_MODULE()
+
+// Example method for C++
+RCT_EXPORT_METHOD(multiply:(nonnull NSNumber*)a withB:(nonnull NSNumber*)b
+                  resolver:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
+{
+    NSNumber *result = @(example::multiply([a floatValue], [b floatValue]));
+
+    resolve(result);
+}
+
+@end

templates/expo-library/src/index.tsx

@@ -1 +1,5 @@
-export default 'Hello World';
+export default {
+  multiply(a: number, b: number) {
+    return Promise.resolve(a * b);
+  },
+};

templates/native-library/<%= project.podspec %>.podspec

@@ -13,12 +13,11 @@ Pod::Spec.new do |s|
   s.platforms    = { :ios => "9.0" }
   s.source       = { :git => "<%= repo %>.git", :tag => "#{s.version}" }
 
-  s.source_files = "ios/**/*.{h,m,mm}"
-
-  <% if(project.useCpp==true){ %>
+  <% if(project.cpp){ %>
   s.source_files = "ios/**/*.{h,m,mm}", "cpp/**/*.{h,cpp}"
-   <% } else{ %>
+  <% } else{ %>
   s.source_files = "ios/**/*.{h,m,mm}"
   <% } %>
+
   s.dependency "React"
 end