Update docs for plugins #832
Merged
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
saulecabrera
approved these changes
Nov 19, 2024
| Wasm module. Then you need to run | ||
|
|
||
| ``` | ||
| javy init-plugin <path_to_plugin> -o <path_to_initialized_module>` |
docs/docs-using-extending.md
Outdated
Comment on lines
73
to
94
| The Wasm API the Javy CLI expects Javy plugins to expose is the following: | ||
| - Exported `initialize_runtime() -> ()` function. This will initialize a mutable | ||
| global containing the Javy runtime for use by `compile_src` and `invoke`. | ||
| - Exported | ||
| `canonical_abi_realloc(orig_ptr: i32, orig_len: i32, new_ptr: i32, new_len: i32) -> ptr: i32` | ||
| function. This is used to allocate memory in the plugin module. | ||
| - Exported `compile_src(src_ptr: i32, src_len: i32) -> bytecode_wide_ptr: i32` | ||
| function. This is used to compile JavaScript source code to QuickJS bytecode. | ||
| The return pointer points to a tuple of | ||
| `(bytecode_ptr: i32, bytecode_len: i32)` in the plugin instance's linear | ||
| memory. | ||
| - Exported | ||
| `invoke(bytecode_ptr: i32, bytecode_len: i32, fn_name_ptr: i32, fn_name_len: i32) -> ()` | ||
| function. This is used to evaluate the JavaScript code and optionally to | ||
| call an exported JS function if `fn_name_ptr` is not `0`. | ||
| - Custom section named `import_namespace` containing a UTF-8 encoded string. | ||
| This is used to determine the namespace that will be used for the Wasm | ||
| imports in dynamically linked modules built with this plugin. | ||
|
|
||
| The `javy-plugin-api` crate will export implementations of all required exported | ||
| functions except `initialize_runtime`. `import_namespace!` will define the | ||
| `import_namespace` custom section. |
There was a problem hiding this comment.
Minor nit: what do you think of putting this information inside a table to improve readability? It'll for sure be less readable in markdown format, but potentially more readable when rendered.
There was a problem hiding this comment.
I don't think a table would help make it more readable. The explanation text would just be super squished. Maybe headers instead? That's how most documentation sites would render methods/functions.
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.
Description of the change
Updates documentation with new project architecture and how to extend Javy with plugins.
Why am I making this change?
Part of #768. The documentation was a bit out-of-date.
Checklist
javy-cliandjavy-plugindo not require updating CHANGELOG files.