Documentation III #125
Documentation III #125
Conversation
|
|
||
| ## Who is using `uniffi-bindgen-react-native`? | ||
|
|
||
| - [@unomed/react-native-matrix-sdk](https://www.npmjs.com/package/@unomed/react-native-matrix-sdk) |
|
|
||
| ## Binary builds | ||
|
|
||
| In order to distribute pre-built packages you will need to add to `.gitignore` the built `.a`: |
There was a problem hiding this comment.
I think I would reword this slightly. The main reason you'll want to add rust_modules/ and *.a to .gitignore is so that you don't track the large binaries in git (and the getting started page already gives that tip). The issue though is that when publishing, npm will also use .gitignore to decide which files to include in the package.
This can be worked around in two ways:
- By using
.npmignore. This will require you to duplicate those ignore patterns that git and npm have in common (which will be most of them). I personally think this isn't a good option because it's quite a footgun. You'll always have to remember to duplicate new entries as you add them in future. - By applying some clever logic by overriding parts of
.gitignorewith thefilesarray inpackage.json.
|
|
||
| ## Source packages | ||
|
|
||
| If asking your users to compile Rust source is acceptable, then adding a `postinstall` script to `package.json` may be enough. |
There was a problem hiding this comment.
It might also be helpful to advise remind consumers to build the Rust crate in release mode when shipping their projects? Maybe that's obvious. I just thought of it because the size difference can be enormous.
There was a problem hiding this comment.
Another excellent suggestion.
|
|
||
| but add them back in to the `files` section of `package.json`[^issue121]. | ||
|
|
||
| [^issue121]: [This advice](https://github.com/jhugman/uniffi-bindgen-react-native/issues/121) is from @Johennes |
There was a problem hiding this comment.
Not sure if it should go here or into #121 but it's probably a good idea run npm pack --dry-run and inspect the package contents before doing any actual publishing. I guess that's probably good practice for any npm release but it might be worth pointing out explicitly here due to the ignore trickery.
There was a problem hiding this comment.
I think you're right: we should land this and the improve this page with #121. Rather than me re-wording (without knowledge) your comment, would you mind raising a PR?
| @@ -136,7 +135,6 @@ Until then, you need to add the dependency to the app's Podfile, in this case `e | |||
| + # We need to specify this here in the app because we can't add a local dependency within | |||
There was a problem hiding this comment.
Is publishing to cocoapods still an option?
There was a problem hiding this comment.
Publishing uniffi-bindgen-react-native? yes definitely.
| } | ||
| log(message: string) { | ||
| if (!this.isEnabled()) { | ||
| throw new MyError.LoggingDisabled(); |
There was a problem hiding this comment.
What happens if I throw an error that doesn't conform to the MyError declared in the rust code?
There was a problem hiding this comment.
Aha. I'd missed this. Thanks for spotting that.
I've added some more docs.
Co-authored-by: Johannes Marbach <[email protected]>
Co-authored-by: Johannes Marbach <[email protected]>
Fixes #121
This PR completes the baseline documentation (I think).
It adds:
generate turbo-modulesusesReviewing theses docs has a guide now!
@Johennes : this page could do with your review/input.