Skip to content

Commit 7814be9

Browse files
Add documentation for BridgeJS generation script to CONTRIBUTING.md
Document the Utilities/bridge-js-generate.sh script and when to use it for updating AoT-generated BridgeJS files.
1 parent 42ddc65 commit 7814be9

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,5 +81,24 @@ To make changes to the runtime, you need to edit the TypeScript files and regene
8181
make regenerate_swiftpm_resources
8282
```
8383

84+
### Working with BridgeJS
85+
86+
BridgeJS is a Swift Package Manager plugin that automatically generates Swift bindings from TypeScript definitions. This repository contains pre-generated files created by BridgeJS in AoT (Ahead of Time) mode that are checked into version control.
87+
88+
To update these pre-generated files, use the utility script:
89+
90+
```bash
91+
./Utilities/bridge-js-generate.sh
92+
```
93+
94+
This script runs the BridgeJS plugin in AoT mode (`swift package bridge-js`) on several SwiftPM packages in this repository.
95+
96+
Run this script when you've made changes to:
97+
- TypeScript definitions
98+
- BridgeJS configuration
99+
- BridgeJS code generator itself
100+
101+
These changes require updating the pre-generated Swift bindings committed to the repository.
102+
84103
## Support
85104
If you have any questions or need assistance, feel free to reach out via [GitHub Issues](https://github.com/swiftwasm/JavaScriptKit/issues) or [Discord](https://discord.gg/ashJW8T8yp).

0 commit comments

Comments
 (0)