react-native-macos/RNTester
Kevin Gozali 83edd0c5fe codegen: set up Gradle plugin for more maintable codegen build steps
Summary:
Instead of sourcing-in a .gradle file to setup codegen tasks in Gradle, let's define a proper `com.facebook.react.codegen` Gradle plugin, so that any Gradle project (lib/app) can include it via:

```
plugins {
    id 'com.facebook.react.codegen'
}
```

The idea (not yet implemented in this commit) is to then allow those projects to add this section in the projects:

```
codegen {
    enableCodegen = ...
    jsRootDir = ...
}
```

This is more scalable and less hacky.

Important notes:
* The Gradle plugin should be prepared during the build, we're not going to publish it to Maven or other repo at this point.
* This setup is inspired by composite build setup explained here: https://ncorti.com/blog/gradle-plugins-and-composite-builds
* All android specific setup is added under `packages/react-native-codegen/android/` dir, but long term, we may want to move it up to `packages/react-native-codegen/` along side setup for other platforms.
* As part of this setup, the plugin will have an option (to be validated) to produce Java specs using https://github.com/square/javapoet
  * This is the same library already used for React Native Android annotation processors
  * This generator will not deal with parsing Flow types into schema, it will just takes in the schema and produce Java code
  * We're evaluating whether JavaPoet is a better choice for Java code generation long term, vs building it in JS via string concatenation: https://github.com/facebook/react-native/blob/master/packages/react-native-codegen/src/generators/modules/GenerateModuleJavaSpec.js
  * This commit produces a sample Java code, not the actual codegen output

Changelog: [Internal]

To try this out, run this Gradle task:

```
USE_CODEGEN=1 ./gradlew :ReactAndroid:generateJava
```

Reviewed By: JoshuaGross, mdvacca

Differential Revision: D22917315

fbshipit-source-id: 0b79dba939b73ff1305b4b4fd86ab897c7a48d53
2020-08-04 00:55:23 -07:00
..
NativeModuleExample Convert easy files to flow strict-local 2019-12-05 16:06:46 -08:00
RCTTest Part 2: Update ObjC++ codegen classes to use ObjCTurboModule::InitParams 2020-04-16 17:29:55 -07:00
RNTester Fix RNTester TurboModules loading (#29538) 2020-07-31 21:26:35 -07:00
RNTester-tvOS Fix RNTest TVOS target (#25110) 2019-06-03 07:35:40 -07:00
RNTesterIntegrationTests Bump Xcode to 11.2.1 (#27434) 2020-01-14 13:30:05 -08:00
RNTesterPods.xcodeproj Add quotes around paths in shell script call (#29160) 2020-06-18 10:44:06 -07:00
RNTesterPods.xcworkspace Commit IDEWorkspaceChecks.plist [trivial] (#25424) 2019-06-28 16:43:17 -07:00
RNTesterUnitTests Check whether packager is running in RCTBundleURLProvider for saved JSLocation 2020-07-06 09:08:44 -07:00
android/app codegen: set up Gradle plugin for more maintable codegen build steps 2020-08-04 00:55:23 -07:00
e2e Back out "Upgrade Prettier from 1.17 to 2.0.2." 2020-03-24 21:47:35 -07:00
js Fix alert screen crash in android in RNTester app (#29150) 2020-07-12 19:57:12 -07:00
.eslintrc Disable no-inline-styles lint rule for RNTester (#23169) 2019-01-28 03:26:12 -08:00
Gemfile Update RNTester CocoaPods to 1.8.4 (#27173) 2019-11-11 11:47:33 -08:00
Podfile Moved ART iOS files to FB internal 2020-07-19 13:59:06 -07:00
Podfile.lock Moved ART iOS files to FB internal 2020-07-19 13:59:06 -07:00
README.md Mention using bundler to install cocoapods in RNTester README (#28873) 2020-05-11 23:28:59 -07:00

README.md

RNTester

The RNTester showcases React Native views and modules.

Running this app

Before running the app, make sure you ran:

git clone https://github.com/facebook/react-native.git
cd react-native
yarn install

Running on iOS

Both macOS and Xcode are required.

  • Install Bundler: gem install bundler. We use bundler to install the right version of CocoaPods locally.
  • Install Bundler and CocoaPods dependencies: bundle install && bundle exec pod install
  • Open the generated RNTesterPods.xcworkspace. This is not checked in, as it is generated by CocoaPods. Do not open RNTesterPods.xcodeproj directly.

Running on Android

You'll need to have all the prerequisites (SDK, NDK) for Building React Native installed.

Start an Android emulator.

cd react-native
./gradlew :RNTester:android:app:installJscDebug
./scripts/packager.sh

Note: Building for the first time can take a while.

Open the RNTester app in your emulator. If you want to use a physical device, run adb devices, then adb -s <device name> reverse tcp:8081 tcp:8081. See Running on Device for additional instructions on using a physical device.

Running with Buck

Follow the same setup as running with gradle.

Install Buck from here.

Run the following commands from the react-native folder:

./gradlew :ReactAndroid:packageReactNdkLibsForBuck
buck fetch rntester
buck install -r rntester
./scripts/packager.sh

Note: The native libs are still built using gradle. Full build with buck is coming soon(tm).

Running Detox Tests on iOS

Install Detox from here.

To run the e2e tests locally, run the following commands from the react-native folder:

yarn build-ios-e2e
yarn test-ios-e2e

These are the equivalent of running:

detox build -c ios.sim.release
detox test -c ios.sim.release --cleanup

These build the app in Release mode, so the production code is bundled and included in the built app.

When developing E2E tests, you may want to run in development mode, so that changes to the production code show up immediately. To do this, run:

detox build -c ios.sim.debug
detox test -c ios.sim.debug

You will also need to have Metro running in another terminal. Note that if you've previously run the E2E tests in release mode, you may need to delete the RNTester/build folder before rerunning detox build.

Building from source

Building the app on both iOS and Android means building the React Native framework from source. This way you're running the latest native and JS code the way you see it in your clone of the github repo.

This is different from apps created using react-native init which have a dependency on a specific version of React Native JS and native code, declared in a package.json file (and build.gradle for Android apps).