Skip to content

Commit

Permalink
Add warning about customising the output directory
Browse files Browse the repository at this point in the history
  • Loading branch information
Johennes committed Nov 25, 2024
1 parent 71bef48 commit 16681fc
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/src/reference/config-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,10 @@ To customize the `packageName`, you should edit or add the entry at the path `co

To customize the `codegenOutputDir`, you should edit or add the entry at the path `codegenConfig`/`outputDir`/`android` in `package.json`.

```admonish warning
Note that for Android the `outputDir` value in `package.json` needs to have a matching entry under `dependency`/`platforms`/`android`/`cmakeListsPath` in `react-native.config.js`. For example, if you set the Android output directory in `package.json` to `android/tmp`, the `cmakeListsPath` value in `react-native.config.js` needs to be set to `tmp/jni/CMakeLists.txt`.
```

## `ios`

This is to configure the build steps for the Rust, the bindings, and the turbo-module code for iOS.
Expand Down Expand Up @@ -129,6 +133,10 @@ The `directory` is the location of the iOS project, relative to the root of the

To customize the `codegenOutputDir`, you should edit or add the entry at the path `codegenConfig`/`outputDir`/`ios` in `package.json`.

```admonish warning
Note that for Android the `outputDir` value in `package.json` needs to have a matching entry under `dependency`/`platforms`/`android`/`cmakeListsPath` in `react-native.config.js`. For example, if you set the Android output directory in `package.json` to `android/tmp`, the `cmakeListsPath` value in `react-native.config.js` needs to be set to `tmp/jni/CMakeLists.txt`.
```

## `turboModule`

This section configures the location of the Typescript and C++ files generated by the `generate turbo-module` command.
Expand Down

0 comments on commit 16681fc

Please sign in to comment.