mirror of https://github.com/nushell/nushell.git synced 2024-11-26 18:33:50 +01:00

History

JT d1c719a8cc bump to 0.64 (#5777 ) Co-authored-by: sholderbach <sholderbach@users.noreply.github.com>		2022-06-15 14:39:17 +12:00
..
src	Address lints from clippy for beta/nightly (#5709 )	2022-06-04 18:47:36 +12:00
Cargo.toml	bump to 0.64 (#5777 )	2022-06-15 14:39:17 +12:00
LICENSE	Include license text in all crates (#5094 )	2022-04-08 10:47:13 +02:00
README.md	Add a README about changing capnp schema (#4998 )	2022-03-27 19:02:19 -05:00

README.md

nu-plugin

Updating Cap'n Proto schema

When modifying a protocol's struct that is used in plugins (such as Signature), you need to update the capnproto schema file and recompile it into the Rust source code. The steps are as follows:

Change src/serializers/capnp/schema/plugin.capnp as necessary
Install capnp tool (it's a C++ binary, commonly available in package managers)
Install Rust support for capnp called capnpc-rust:
1. git clone https://github.com/capnproto/capnproto-rust somewhere
2. cd capnproto-rust/capnpc
3. cargo install --path=.
Then, call capnp compile -orust plugin.capnp (change path as necessary)
The result should be plugin_capnp.rs file: Use it to replace the old src/plugin_capnp.rs.
It needs to be autoformatted (cargo fmt --all)
Modify the serialize/deserialize functions. Check the following PRs for details:
- https://github.com/nushell/nushell/pull/4980
- https://github.com/nushell/nushell/pull/4920