docs(api): Add api-common info on generating TypeScript bindings #3330
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Nutomic
reviewed
Jun 26, 2023
|
|
||
| ## Generate TypeScript bindings | ||
|
|
||
| TypeScript bindings (API types) can be generated by running `cargo test --features full`. |
There was a problem hiding this comment.
Mention that this needs to be done inside crates/api_common folder. Alternatively you can run cargo test -p lemmy_api_common --features full from root.
There was a problem hiding this comment.
This README is in the api_common folder. So I think that's implicitly clear and correct.
Documenting the folder and then stating that folder explicitly for actions seems redundant and - to me - confusing.
There was a problem hiding this comment.
In that case make the command this to be more clear.
cd crates/api_common
cargo test ...
Nutomic
reviewed
Jun 26, 2023
| ## Generate TypeScript bindings | ||
|
|
||
| TypeScript bindings (API types) can be generated by running `cargo test --features full`. | ||
| The ts files be generated into a `bindings` folder. |
There was a problem hiding this comment.
Output is in crates/api_common/bindings
There was a problem hiding this comment.
This README file is in crates/api_common. Referencing the bindings folder in it matches that path.
Nutomic
approved these changes
Jun 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR #2827 added support for generating TypeScript bindings.
I could not find any information or docs on how to generate them though. The MR description merely mentions tests generating them, but they won't generate unless the
fullfeature flag is used.This change adds information that this is possible, how to do it, and where they are put to to the api_common crate README.md.