Skip to content

document Including Generated Code into Libraries #227

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

Merged
merged 2 commits into from
Sep 17, 2024
Merged

document Including Generated Code into Libraries #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58095de
document Including Generated Code into Libraries
vonovak Sep 17, 2024
928dcfc
turbomodules - Including Generated Code into Libraries
vonovak Sep 17, 2024
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
4 changes: 2 additions & 2 deletions docs/appendix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,8 +257,8 @@ node node_modules/react-native/scripts/generate-specs-cli.js \
```

> [!Note]
> The output artifacts of the Codegen are inside the build folder and should not be committed.
> They should be considered only for reference.
> By default, the output artifacts of the Codegen are written to the build folder and should not be committed. They should be considered only for reference.
> It is also possible to include the codegen output into your library. [Read more](./codegen.md#including-generated-code-into-libraries).

##### Example

Expand Down
3 changes: 2 additions & 1 deletion docs/turbo-modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,8 @@ When developing a React Native app that uses a Turbo Native Module, it is the re
As the first step for both iOS and Android, this guide shows how to execute manually the scripts used by **Codegen** to generate the required code. Further information on **Codegen** can be found [here](./codegen.md).

> [!Warning]
> The code generated by **Codegen** in this step should not be committed to the versioning system. React Native apps are able to generate the code when the app is built. This allows an app to ensure that all libraries have code generated for the correct version of React Native.
> The code generated by **Codegen** in this step should not be committed to the versioning system. React Native apps are able to generate the code when the app is built. This allows an app to ensure that all libraries have code generated for the correct version of React Native. It is also possible to [include the codegen output into your library](./codegen.md#including-generated-code-into-libraries).


### iOS

Expand Down