https://github.com/microsoft/react-native-tscodegen
Generate react-native turbo modules using TypeScript
https://github.com/microsoft/react-native-tscodegen
Last synced: 8 months ago
JSON representation
Generate react-native turbo modules using TypeScript
- Host: GitHub
- URL: https://github.com/microsoft/react-native-tscodegen
- Owner: microsoft
- License: other
- Created: 2019-08-20T23:41:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-16T18:09:22.000Z (over 2 years ago)
- Last Synced: 2025-05-15T00:08:39.268Z (8 months ago)
- Language: TypeScript
- Size: 2.25 MB
- Stars: 467
- Watchers: 42
- Forks: 26
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-list - react-native-tscodegen - native turbo modules using TypeScript | microsoft | 407 | (TypeScript)
README
# react-native-tscodegen
## All works are ported to react-native, this project has stopped developing.
TypeScript Code Generation for React Native Turbo Module
- Index
- Contributing
- Building this repo
- Packages
- Deploying
- Development
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Building this repo
```cmd
yarn
yarn build
yarn test
```
## Packages
### @react-native-ts-codegen/tslint-shared
This is the shared tslint configuration for all other packages.
### RN-TSCodegen
This is the TypeScript code generation for TurboModule in react native.
There are two important exported functions:
- **typeScriptToCodeSchema** function:
- **fileName** argument: Full path to a TypeScript source file, a module name.
- **moduleName** argument: The module name. It is not reflected in generated files.
- **targetName** argument (optional): It will be used in **the entry header file**, if this TypeScript source file registers a native module.
- Output: A `SchemaType` data structure.
- **generator.generate** function
- **options** argument:
- **libraryName** property: A string that becomes part of type names in generated files.
- **schema** property: Result from `typeScriptToCodeSchema`
- **outputDirectory** property: Full path to a folder to write files. Multiple files will be generated and most of the file names are hard-coded.
- **moduleSpecName** property: Name of **the entry header file**, no file extension.
- **config** arguments:
- **generators** property: An array that is or a subset of `['descriptors', 'events', 'props', 'tests', 'shadow-nodes', 'modules']` to control what files are generated.
### RN-TSCodegen-Test
This package contains all test cases for RN-TSCodegen, with unit test code.
### @react-native-ts-codegen/minimum-flow-parser
This is a Flow parser, just enough to convert necessary files to TypeScript for this repo.
### update-test-files
Get generated files sync to `facebook/react-native`
## Deploying
- [npm install react-native-tscodegen-types](https://www.npmjs.com/package/react-native-tscodegen-types)
- [npm install react-native-tscodegen](https://www.npmjs.com/package/react-native-tscodegen)
- Follow the description to build your first Turbo Module program!
- [Demo project](https://github.com/ZihanChen-MSFT/react-native-tscodegen-demo) (not ready)
You are welcome to use cli tool `react-native-tscodegen` instead of calling functions in build scripts by yourself if possible.
Basically, just add `react-native-tscodegen ./react-native-tscodegen.json` to npm scripts, after getting `react-native-tscodegen.json` prepared.
The file name is not important.
```json
{
"libraryName": "PlaygroundModule",
"outputDirectory": "./lib/cpp-generated",
"moduleSpecName": "PlaygroundModuleSpec",
"generators": [
"descriptors",
"events",
"props",
"tests",
"shadow-nodes",
"modules"
],
"inputFile": "./src/turboModule.ts"
}
```
`libraryName` and `moduleSpecName` control file names and some generated C++ class names.
`generators` controls what files get generated.
After the cli tool is successfully executed,
files will be created under `outputDirectory`.
## Development
### Sync react-native after pull
```cmd
git submodule update
```
### Sync react-native to a new version
```cmd
pushd react-native
git fetch
git checkout
popd
git status
```
### Works to do after updating react-native
```cmd
yarn
yarn build
pushd packages\update-test-files
npm run start
popd
git status
```
### Fixing test case codegen
```cmd
cls & pushd packages\update-test-files & npm run build & cd ..\RN-TSCodegen-Test & npm run build & popd
```
### Fixing compiler
```cmd
cls & pushd packages\RN-TSCodegen & npm run build & cd ..\RN-TSCodegen-Test & npm run build & npm run test & popd
```