Simplify repo setup and update (#258)

Author: ryantrem

Apps/Playground/package-lock.json

@@ -10,7 +10,8 @@
     "start": "react-native start",
     "test": "jest",
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
-    "postinstall": "node scripts/postinstall.js"
+    "postinstall": "node scripts/tools.js postinstall",
+    "iosCmake": "node scripts/tools.js iosCMake"
   },
   "dependencies": {
     "@babylonjs/core": "^5.0.0-alpha.30",
@@ -36,6 +37,7 @@
     "@typescript-eslint/eslint-plugin": "^2.27.0",
     "@typescript-eslint/parser": "^2.27.0",
     "babel-jest": "^26.6.3",
+    "chalk": "^4.1.1",
     "eslint": "7.14.0",
     "jest": "^26.6.3",
     "metro-config": "^0.64.0",

Apps/Playground/package.json

@@ -0,0 +1,38 @@
+const os = require('os');
+const shelljs = require('shelljs');
+const chalk = require('chalk');
+
+function iosCmake() {
+  console.log(chalk.black.bgCyan('Running CMake for iOS...'));
+  shelljs.exec('cmake -G Xcode -DCMAKE_TOOLCHAIN_FILE=../submodules/BabylonNative/Dependencies/ios-cmake/ios.toolchain.cmake -DPLATFORM=OS64COMBINED -DENABLE_ARC=0 -DENABLE_BITCODE=1 -DDEPLOYMENT_TARGET=12 -DENABLE_GLSLANG_BINARIES=OFF -DSPIRV_CROSS_CLI=OFF -DENABLE_PCH=OFF .', {cwd: 'node_modules/@babylonjs/react-native/ios'});
+}
+
+function postInstall() {
+  const version = shelljs.exec('npm --version', {silent: true});
+
+  if (!version.trim().match(/6\.\d+\.\d+/g)) {
+    throw `Error: BabylonReactNative Playground development requires npm version 6.13.*, Your current npm version is ${version}. Run npm install -g [email protected] to update your npm version.`;
+  }
+
+  console.log(chalk.black.bgCyan('Updating submodules...'));
+  shelljs.exec('git submodule update --init --recursive', {cwd: '../../'});
+
+  if (os.platform() === 'darwin') {
+    iosCmake();
+
+    console.log(chalk.black.bgCyan('Installing iOS pods...'));
+    shelljs.exec('pod install', {cwd: 'ios'});
+  }
+}
+
+// First arg will be 'node', second arg will be 'tools.js'
+const [command] = process.argv.slice(2);
+
+if (command === 'postinstall') {
+  postInstall();
+} else if (command === 'iosCMake') {
+  iosCmake();
+} else {
+  console.error(chalk.black.bgRedBright(`Unkown command: ${command}`));
+  process.exit(1);
+}

Apps/Playground/scripts/postinstall.js

@@ -11,6 +11,10 @@ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -x objective-c++")
 set(NAPI_JAVASCRIPT_ENGINE "JSI" CACHE STRING "The JavaScript engine to power N-API")
 
 get_filename_component(REACTNATIVE_DIR "${CMAKE_CURRENT_LIST_DIR}/../../../react-native" ABSOLUTE)
+if(NOT EXISTS ${REACTNATIVE_DIR})
+    get_filename_component(REACTNATIVE_DIR "${CMAKE_CURRENT_LIST_DIR}/../../../../Apps/Playground/node_modules/react-native" ABSOLUTE)
+endif()
+
 # The CMake generator for XCode produces relative paths to source files. Additionally, when an XCode project
 # that lives in a sym linked directory is added to an XCode workspace, XCode resolves the actual path of the
 # XCode project. This combination results in incorrect relative paths, so just copy the jsi directory locally.

Apps/Playground/scripts/tools.js

@@ -35,26 +35,20 @@ Step 1 for all development environments and targets is to clone the repo. Use a
 git clone https://github.com/BabylonJS/BabylonReactNative
 ```
 
-Babylon React Native makes extensive use of submodules to supply its dependencies, so it's also necessary to set up the submodules.
-
-```
-cd BabylonReactNative
-git submodule update --init --recursive
-```
-
-The Playground sample/test app is a standard React Native app, and as such also makes extensive use of NPM packages to supply its dependencies, so it's also necessary to install these packages.
+The Playground sample/test app is a standard React Native app, and as such makes extensive use of NPM packages to supply its dependencies, so it's also necessary to install these packages.
 
 ```
 cd Apps/Playground
 npm install
 ```
 
-For iOS, CocoaPods are also used, and these must be installed.
+This will also automatically do the following to prepare your repo for development:
 
-```
-cd Apps/Playground/ios
-pod install --repo-update
-```
+- Update git submodules to fetch Babylon Native and its dependencies
+- [MacOS only] Run CMake to generate the iOS XCode project for Babylon React Native
+- [MacOS only] Run `pod install` to install cocoa pod depdendencies
+
+After merging upstream changes in the future, you will need to either run `npm install` again, or run individual commands for the above operations (e.g. `git submodule update --init --submodule` / `npm run iosCMake` / `pod install`).
 
 ### **Configuring a Mac Dev Environment**
 
@@ -128,13 +122,9 @@ After having run the above commands, you can also open `Apps/Playground/android`
 
 #### iOS
 
-iOS can only be built on a Mac. Additionally, `CMake` must manually be run to generate the XCode project that the [Playground XCode workspace](Apps/Playground/ios/Playground.xcworkspace/contents.xcworkspacedata) includes.
+iOS can only be built on a Mac.
 
 ```
-pushd Apps/Playground/node_modules/@babylonjs/react-native/ios
-cmake -G Xcode -DCMAKE_TOOLCHAIN_FILE=../submodules/BabylonNative/Dependencies/ios-cmake/ios.toolchain.cmake -DPLATFORM=OS64COMBINED -DENABLE_ARC=0 -DENABLE_BITCODE=1 -DDEPLOYMENT_TARGET=12 -DENABLE_GLSLANG_BINARIES=OFF -DSPIRV_CROSS_CLI=OFF -DENABLE_PCH=OFF .
-popd
-
 cd Apps/Playground
 npm run ios
 ```