[WIP] refactor: use exported @react-native-community/cli init function to generate example - DRAFT WIP

lib/lib.js

@@ -6,6 +6,8 @@ const path = require('path');
 
 const { info, warn, error } = require('console');
 
+const { init } = require('@react-native-community/cli')
+
 // default execa object
 const execaDefault = require('execa');
 
@@ -130,20 +132,10 @@ exampleReactNativeVersion: ${exampleReactNativeVersion}
   const commandSync = execa.commandSync;
 
   if (generateExample) {
-    const reactNativeVersionCommand = 'react-native --version';
     const yarnVersionCommand = 'yarn --version';
 
     const checkCliOptions = { stdio: 'inherit' };
-    const errorRemedyMessage = 'both react-native-cli and yarn CLI tools are needed to generate example project';
-
-    try {
-      info('CREATE: Check for valid react-native-cli tool version, as needed to generate the example project');
-      commandSync(reactNativeVersionCommand, checkCliOptions);
-      info(`${reactNativeVersionCommand} ok`);
-    } catch (e) {
-      throw new Error(
-        `${reactNativeVersionCommand} failed; ${errorRemedyMessage}`);
-    }
+    const errorRemedyMessage = 'yarn CLI is needed to generate example project';
 
     try {
       info('CREATE: Check for valid Yarn CLI tool version, as needed to generate the example project');
@@ -195,22 +187,21 @@ exampleReactNativeVersion: ${exampleReactNativeVersion}
   // multiple test or sample apps in the future.
   const generateExampleApp =
     () => {
-      const exampleReactNativeInitCommand =
-        `react-native init ${exampleName} --version ${exampleReactNativeVersion}`;
+      // resolve **absolute** module & example paths before
+      // react-native-community/cli init(Compat) function call
+      // which may affect the process cwd state
+      // (absolute paths are needed for the steps below to work)
+      const modulePath = path.resolve('.', moduleName);
+      const pathExampleApp = path.join(modulePath, exampleName);
 
-      info(
-        `CREATE example app with the following command: ${exampleReactNativeInitCommand}`);
-
-      const execOptions = { cwd: `./${moduleName}`, stdio: 'inherit' };
+      info(`INIT example app in ${moduleName}/${exampleName}`);
 
       // (with the work done in a promise chain)
       return Promise.resolve()
         .then(() => {
-          // We use synchronous execSync / commandSync call here
-          // which is able to output its stdout to stdout in this process.
-          // Note that any exception would be properly handled since this
-          // call is executed within a Promise.resolve().then() callback.
-          commandSync(exampleReactNativeInitCommand, execOptions);
+          // @react-native-community/cli function call
+          // (...)
+          return init(`./${moduleName}/${exampleName}`, exampleName);
         })
         .then(() => {
           // Render the example template
@@ -226,16 +217,13 @@ exampleReactNativeVersion: ${exampleReactNativeVersion}
 
           return Promise.all(
             exampleTemplates.map((template) => {
-              return renderTemplateIfValid(fs, moduleName, template, templateArgs);
+              return renderTemplateIfValid(fs, modulePath, template, templateArgs);
             })
           );
         })
         .then(() => {
           // Adds and link the new library
           return new Promise((resolve, reject) => {
-            // determine this path before the next steps:
-            const pathExampleApp = `./${moduleName}/${exampleName}`;
-
             // postinstall workaround script *only* needed in case
             // the DEPRECATED --example-file-linkage option
             // (exampleFileLinkage: true) is used

package.json

@@ -43,6 +43,7 @@
   },
   "homepage": "https://github.com/brodybits/create-react-native-module#readme",
   "dependencies": {
+    "@react-native-community/cli": "^4.14.0",
     "commander": "^6.2.1",
     "console": "^0.7.2",
     "execa": "^5.0.0",
@@ -54,6 +55,7 @@
     "param-case": "^3.0.4",
     "pascal-case": "^3.1.2",
     "please-upgrade-node": "^3.2.0",
+    "react-native": "^0.63.4",
     "update-notifier": "^5.1.0"
   },
   "devDependencies": {

tests/with-injection/create/view/with-example/with-defaults/__snapshots__/create-view-with-example-with-defaults.test.js.snap

@@ -794,11 +794,11 @@ content:
 ",
   "* execa.commandSync command: react-native init example --version react-native@latest options: {\\"cwd\\":\\"./react-native-alice-bobbi\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* ensureDir dir: react-native-alice-bobbi/example/
+  "* ensureDir dir: .../react-native-alice-bobbi/example/
 ",
-  "* ensureDir dir: react-native-alice-bobbi/example/
+  "* ensureDir dir: .../react-native-alice-bobbi/example/
 ",
-  "* outputFile name: react-native-alice-bobbi/example/metro.config.js
+  "* outputFile name: .../react-native-alice-bobbi/example/metro.config.js
 content:
 --------
 // metro.config.js
@@ -832,7 +832,7 @@ module.exports = {
 
 <<<<<<<< ======== >>>>>>>>
 ",
-  "* outputFile name: react-native-alice-bobbi/example/App.js
+  "* outputFile name: .../react-native-alice-bobbi/example/App.js
 content:
 --------
 /**
@@ -883,11 +883,11 @@ const styles = StyleSheet.create({
 
 <<<<<<<< ======== >>>>>>>>
 ",
-  "* execa.commandSync command: yarn add link:../ options: {\\"cwd\\":\\"./react-native-alice-bobbi/example\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: yarn add link:../ options: {\\"cwd\\":\\".../react-native-alice-bobbi/example\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* execa.commandSync command: pod --version options: {\\"cwd\\":\\"./react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: pod --version options: {\\"cwd\\":\\".../react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* execa.commandSync command: pod install options: {\\"cwd\\":\\"./react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: pod install options: {\\"cwd\\":\\".../react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
 ",
 ]
 `;

tests/with-injection/create/view/with-example/with-options/__snapshots__/create-view-with-example-with-options.test.js.snap

@@ -794,11 +794,11 @@ content:
 ",
   "* execa.commandSync command: react-native init test-demo --version [email protected] options: {\\"cwd\\":\\"./react-native-alice-bobbi\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* ensureDir dir: react-native-alice-bobbi/test-demo/
+  "* ensureDir dir: .../react-native-alice-bobbi/test-demo/
 ",
-  "* ensureDir dir: react-native-alice-bobbi/test-demo/
+  "* ensureDir dir: .../react-native-alice-bobbi/test-demo/
 ",
-  "* outputFile name: react-native-alice-bobbi/test-demo/metro.config.js
+  "* outputFile name: .../react-native-alice-bobbi/test-demo/metro.config.js
 content:
 --------
 // metro.config.js
@@ -832,7 +832,7 @@ module.exports = {
 
 <<<<<<<< ======== >>>>>>>>
 ",
-  "* outputFile name: react-native-alice-bobbi/test-demo/App.js
+  "* outputFile name: .../react-native-alice-bobbi/test-demo/App.js
 content:
 --------
 /**
@@ -883,11 +883,11 @@ const styles = StyleSheet.create({
 
 <<<<<<<< ======== >>>>>>>>
 ",
-  "* execa.commandSync command: yarn add link:../ options: {\\"cwd\\":\\"./react-native-alice-bobbi/test-demo\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: yarn add link:../ options: {\\"cwd\\":\\".../react-native-alice-bobbi/test-demo\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* execa.commandSync command: pod --version options: {\\"cwd\\":\\"./react-native-alice-bobbi/test-demo/ios\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: pod --version options: {\\"cwd\\":\\".../react-native-alice-bobbi/test-demo/ios\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* execa.commandSync command: pod install options: {\\"cwd\\":\\"./react-native-alice-bobbi/test-demo/ios\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: pod install options: {\\"cwd\\":\\".../react-native-alice-bobbi/test-demo/ios\\",\\"stdio\\":\\"inherit\\"}
 ",
 ]
 `;

tests/with-injection/create/with-example/for-android-only/__snapshots__/create-with-example-for-android-only.test.js.snap

@@ -387,11 +387,11 @@ sdk.dir=/Users/{username}/Library/Android/sdk
 ",
   "* execa.commandSync command: react-native init example --version react-native@latest options: {\\"cwd\\":\\"./react-native-alice-bobbi\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* ensureDir dir: react-native-alice-bobbi/example/
+  "* ensureDir dir: .../react-native-alice-bobbi/example/
 ",
-  "* ensureDir dir: react-native-alice-bobbi/example/
+  "* ensureDir dir: .../react-native-alice-bobbi/example/
 ",
-  "* outputFile name: react-native-alice-bobbi/example/metro.config.js
+  "* outputFile name: .../react-native-alice-bobbi/example/metro.config.js
 content:
 --------
 // metro.config.js
@@ -425,7 +425,7 @@ module.exports = {
 
 <<<<<<<< ======== >>>>>>>>
 ",
-  "* outputFile name: react-native-alice-bobbi/example/App.js
+  "* outputFile name: .../react-native-alice-bobbi/example/App.js
 content:
 --------
 /**
@@ -488,7 +488,7 @@ const styles = StyleSheet.create({
 
 <<<<<<<< ======== >>>>>>>>
 ",
-  "* execa.commandSync command: yarn add link:../ options: {\\"cwd\\":\\"./react-native-alice-bobbi/example\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: yarn add link:../ options: {\\"cwd\\":\\".../react-native-alice-bobbi/example\\",\\"stdio\\":\\"inherit\\"}
 ",
 ]
 `;

tests/with-injection/create/with-example/with-defaults/__snapshots__/create-with-example-with-defaults.test.js.snap

@@ -790,11 +790,11 @@ content:
 ",
   "* execa.commandSync command: react-native init example --version react-native@latest options: {\\"cwd\\":\\"./react-native-alice-bobbi\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* ensureDir dir: react-native-alice-bobbi/example/
+  "* ensureDir dir: .../react-native-alice-bobbi/example/
 ",
-  "* ensureDir dir: react-native-alice-bobbi/example/
+  "* ensureDir dir: .../react-native-alice-bobbi/example/
 ",
-  "* outputFile name: react-native-alice-bobbi/example/metro.config.js
+  "* outputFile name: .../react-native-alice-bobbi/example/metro.config.js
 content:
 --------
 // metro.config.js
@@ -828,7 +828,7 @@ module.exports = {
 
 <<<<<<<< ======== >>>>>>>>
 ",
-  "* outputFile name: react-native-alice-bobbi/example/App.js
+  "* outputFile name: .../react-native-alice-bobbi/example/App.js
 content:
 --------
 /**
@@ -891,11 +891,11 @@ const styles = StyleSheet.create({
 
 <<<<<<<< ======== >>>>>>>>
 ",
-  "* execa.commandSync command: yarn add link:../ options: {\\"cwd\\":\\"./react-native-alice-bobbi/example\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: yarn add link:../ options: {\\"cwd\\":\\".../react-native-alice-bobbi/example\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* execa.commandSync command: pod --version options: {\\"cwd\\":\\"./react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: pod --version options: {\\"cwd\\":\\".../react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* execa.commandSync command: pod install options: {\\"cwd\\":\\"./react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: pod install options: {\\"cwd\\":\\".../react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
 ",
 ]
 `;

tests/with-injection/create/with-example/with-missing-package-scripts/__snapshots__/recover-from-missing-package-scripts.test.js.snap

@@ -790,11 +790,11 @@ content:
 ",
   "* execa.commandSync command: react-native init example --version react-native@latest options: {\\"cwd\\":\\"./react-native-alice-bobbi\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* ensureDir dir: react-native-alice-bobbi/scripts/
+  "* ensureDir dir: .../react-native-alice-bobbi/scripts/
 ",
-  "* ensureDir dir: react-native-alice-bobbi/example/
+  "* ensureDir dir: .../react-native-alice-bobbi/example/
 ",
-  "* outputFile name: react-native-alice-bobbi/scripts/examples_postinstall.js
+  "* outputFile name: .../react-native-alice-bobbi/scripts/examples_postinstall.js
 content:
 --------
 #!/usr/bin/env node
@@ -911,7 +911,7 @@ content:
 
 <<<<<<<< ======== >>>>>>>>
 ",
-  "* outputFile name: react-native-alice-bobbi/example/App.js
+  "* outputFile name: .../react-native-alice-bobbi/example/App.js
 content:
 --------
 /**
@@ -976,11 +976,11 @@ const styles = StyleSheet.create({
 ",
   Object {
     "call": "fs.readFileSync",
-    "jsonFilePath": "./react-native-alice-bobbi/example/package.json",
+    "jsonFilePath": ".../react-native-alice-bobbi/example/package.json",
   },
   Object {
     "call": "fs.writeFileSync",
-    "filePath": "./react-native-alice-bobbi/example/package.json",
+    "filePath": ".../react-native-alice-bobbi/example/package.json",
     "json": "{
   \\"name\\": \\"example\\",
   \\"version\\": \\"0.0.1\\",
@@ -999,11 +999,11 @@ const styles = StyleSheet.create({
       "spaces": 2,
     },
   },
-  "* execa.commandSync command: yarn add file:../ options: {\\"cwd\\":\\"./react-native-alice-bobbi/example\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: yarn add file:../ options: {\\"cwd\\":\\".../react-native-alice-bobbi/example\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* execa.commandSync command: pod --version options: {\\"cwd\\":\\"./react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: pod --version options: {\\"cwd\\":\\".../react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* execa.commandSync command: pod install options: {\\"cwd\\":\\"./react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: pod install options: {\\"cwd\\":\\".../react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
 ",
 ]
 `;

tests/with-injection/create/with-example/with-missing-package-scripts/recover-from-missing-package-scripts.test.js

@@ -2,6 +2,8 @@ const lib = require('../../../../../lib/lib.js');
 
 const ioInject = require('../../../helpers/io-inject.js');
 
+const mockcwd = require('process').cwd();
+
 test('create alice-bobbi module with example, with `exampleFileLinkage: true` then recover from missing scripts in example package.json', async () => {
   const mysnap = [];
 
@@ -13,7 +15,7 @@ test('create alice-bobbi module with example, with `exampleFileLinkage: true` th
       readFileSync: (jsonFilePath) => {
         mysnap.push({
           call: 'fs.readFileSync',
-          jsonFilePath: jsonFilePath.replace(/\\/g, '/'),
+          jsonFilePath: jsonFilePath.replace(mockcwd, '...').replace(/\\/g, '/'),
         });
         return `{ "name": "example", "version": "0.0.1" }`;
       }

tests/with-injection/create/with-example/with-null-options/with-null-prefix/__snapshots__/create-with-example-with-null-prefix.test.js.snap

@@ -790,11 +790,11 @@ content:
 ",
   "* execa.commandSync command: react-native init example --version react-native@latest options: {\\"cwd\\":\\"./react-native-alice-bobbi\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* ensureDir dir: react-native-alice-bobbi/example/
+  "* ensureDir dir: .../react-native-alice-bobbi/example/
 ",
-  "* ensureDir dir: react-native-alice-bobbi/example/
+  "* ensureDir dir: .../react-native-alice-bobbi/example/
 ",
-  "* outputFile name: react-native-alice-bobbi/example/metro.config.js
+  "* outputFile name: .../react-native-alice-bobbi/example/metro.config.js
 content:
 --------
 // metro.config.js
@@ -828,7 +828,7 @@ module.exports = {
 
 <<<<<<<< ======== >>>>>>>>
 ",
-  "* outputFile name: react-native-alice-bobbi/example/App.js
+  "* outputFile name: .../react-native-alice-bobbi/example/App.js
 content:
 --------
 /**
@@ -891,11 +891,11 @@ const styles = StyleSheet.create({
 
 <<<<<<<< ======== >>>>>>>>
 ",
-  "* execa.commandSync command: yarn add link:../ options: {\\"cwd\\":\\"./react-native-alice-bobbi/example\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: yarn add link:../ options: {\\"cwd\\":\\".../react-native-alice-bobbi/example\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* execa.commandSync command: pod --version options: {\\"cwd\\":\\"./react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: pod --version options: {\\"cwd\\":\\".../react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
 ",
-  "* execa.commandSync command: pod install options: {\\"cwd\\":\\"./react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
+  "* execa.commandSync command: pod install options: {\\"cwd\\":\\".../react-native-alice-bobbi/example/ios\\",\\"stdio\\":\\"inherit\\"}
 ",
 ]
 `;