Mirrors/nushell
2
0
Fork 0
mirror of https://github.com/nushell/nushell synced 2024-11-14 00:47:09 +00:00
Code Issues Projects Releases Packages Wiki Activity
nushell/crates/nu-plugin
History
JT 8e98df8b28
bump to dev version (#5635)
2022-05-25 19:09:44 -05:00
..
src update miette and switch to GenericErrors (#5222) 2022-04-19 00:34:10 +12:00
Cargo.toml bump to dev version (#5635) 2022-05-25 19:09:44 -05: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:

  1. Change src/serializers/capnp/schema/plugin.capnp as necessary
  2. Install capnp tool (it's a C++ binary, commonly available in package managers)
  3. 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=.
  4. Then, call capnp compile -orust plugin.capnp (change path as necessary)
  5. The result should be plugin_capnp.rs file: Use it to replace the old src/plugin_capnp.rs.
  6. It needs to be autoformatted (cargo fmt --all)
  7. Modify the serialize/deserialize functions. Check the following PRs for details: