Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify the Configure Codegen in your Gradle File section #2993

Merged
merged 2 commits into from
Mar 10, 2022
Merged

Clarify the Configure Codegen in your Gradle File section #2993

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b12baad
Clarify the Configure Codegen in your Gradle File section
cortinico Mar 3, 2022
816a9cd
Update docs/new-architecture-library-android.md
cortinico Mar 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions docs/new-architecture-library-android.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@ You can now configure Codegen by specifying the following in the module-level `b

```groovy
react {
reactRoot = rootProject.file("../node_modules/react-native/")
jsRootDir = rootProject.file("../js/")
codegenDir = rootProject.file("../node_modules/react-native-codegen/")
libraryName = "samplelibrary"
codegenJavaPackageName = "com.example.samplelibrary"
root = rootProject.file("..")
jsRootDir = rootProject.file("../js/")
reactNativeDir = rootProject.file("../node_modules/react-native/")
codegenDir = rootProject.file("../node_modules/react-native-codegen/")
}
```

Expand All @@ -29,18 +30,16 @@ Please note that this setup requires you to have the React Gradle Plugin configu

:::

There are three arguments that are required:

- `reactRoot`: Reference to the `react-native` package root. Usually located inside `../node_modules/react-native`. For third-party NPM libraries that are installed in `node_modules`, this will be `../react-native`.
- `jsRootDir`: Reference to the directory that contains the JavaScript specs for this library.
- `codegenDir`: Reference to the `react-native-codegen` root. Usually located inside `./node_modules/react-native-codegen`

These are optional:
All the arguments are **optional** and provide **default values**, you might want to customize them to follow your setup.

- `libraryName`: Optional. A string that identifies your library. By default, the codegen will use a library name that is derived from the name of the module with a `Spec` suffix. E.g. for `:example:project` it will be `ExampleProjectSpec`).
- `codegenJavaPackageName`: Optional. A string that represents the Java package your code should use. By default this will be `com.facebook.fbreact.specs` but you might want to customize it.
- `libraryName`: A string that identifies your library. By default, the codegen will use a library name that is derived from the name of the module with a `Spec` suffix. E.g. for `:example:project` it will be `ExampleProjectSpec`.
- `codegenJavaPackageName`: A string that represents the Java package your code should use. By default this will be `com.facebook.fbreact.specs` but you might want to customize it.
- `root`: Reference to the root of your project. By default is `..` as Gradle is running inside the `./android` folder.
- `reactNativeDir`: Reference to the `react-native` package root. Usually located inside `../node_modules/react-native`. For third-party NPM libraries that are installed in `node_modules`, this will be `../react-native`.
- `jsRootDir`: Reference to the directory that contains the JavaScript specs for this library. By default is `../js/`
- `codegenDir`: Reference to the `react-native-codegen` root. Usually located inside `../node_modules/react-native-codegen`
cortinico marked this conversation as resolved.
Show resolved Hide resolved

The generator will write its output inside the **build folder**, specifically inside `/build/generated/source/codegen`
The generator will write its output inside the **build folder**, specifically inside the `./build/generated/source/codegen` folder.

## 2. Extend or implement the code-generated native interfaces

Expand Down