spin icon indicating copy to clipboard operation
spin copied to clipboard

Settle on a convention for crates that are Spin CLI specific

Open calebschoepp opened this issue 1 year ago • 5 comments

We have a number of crates that are relevant to only the Spin CLI and it would be nice to have a naming convention to easily pick them out. One example is the sqlite crate which only deals with Spin CLI specific runtime configuration toml parsing. It would be nice if it were clear from the name of the crate that that was the case.

calebschoepp avatar Sep 13 '24 16:09 calebschoepp

Somewhere or other I suggested a spin-up- prefix for crates that only apply to the spin up runtime. I guess that is arguably different than "CLI-specific", but I think it would apply to the sqlite example anyway.

lann avatar Sep 16 '24 13:09 lann

What about spin-cli- prefix given that it applies to things like spin watch too?

calebschoepp avatar Sep 16 '24 16:09 calebschoepp

@calebschoepp at the moment, watch isn't a crate, but a module in the spin-cli crate.

itowlson avatar Sep 16 '24 20:09 itowlson

@calebschoepp at the moment, watch isn't a crate, but a module in the spin-cli crate.

Thanks for clarifying Ivan. I'm just trying to demonstrate that the scope of a crate like this is broader than just spin up but rather is relevant to the entire Spin CLI.

calebschoepp avatar Sep 16 '24 20:09 calebschoepp

Doh! Sorry Caleb, I misread your comment.

itowlson avatar Sep 16 '24 20:09 itowlson