// NOTE: If you edit this file, please paste it (without this note) into // the README.md and as a documentation comment in the src/lib.rs file. #[macro_use] extern crate clap; use ::clishe::prelude::*; #[tokio::main] async fn main() { let mut ctx = Context("".to_owned()); // The same static methods available to the ::clap::Parser trait are // available here. If you have a vector of arguments, just use // `parse_from()`. If you want to capture the parsing errors instead of // letting clap print them and exit them, you should use `try_parse()` // vvvvv if let Err(err) = Food::parse().run(&mut ctx).await { // ^^^^^^^^ We ignore the Ok(_) scenario here since Returned is a // useless unit struct, but this is where we would handle it if the // returned value was meaningful. eprint!("error: {}", err); } } // Could also be called Database, State, ... depending on the domain of your // CLI. This is the single object available in commands aside from // arguments/options. The context has two likely lifetimes: // // - Created right before, handed to this command and dies with this command // - Created at the beginning of the shell, passed from one command to another pub struct Context(String); // Could be anything. This turns the cli app into a function(Context, args from // user) = Returned. // // This type offers us two approaches for our CLI apps: procedural and // functional in nature. In the first one, one would apply side-effects inside // of the application tree. On the other hand, one could aggregate functionally // all side-effects to the Returned type and execute them at the scope of the // main. pub struct Returned; // Dispatchers are commands which hold sub-commands. The root of a cli-like // application is often a dispatcher. The application then takes the shape of a // tree of dispatcher nodes, with commands!{} implementations as leaves. async_dispatchers! { // Any of the clap attributes you would use on top of the main clap app, // we will use here on the Food dispatcher, as we have chosen it to be the // root of our cli application. #[clap( name = "clishe", version = "0.3.0", about = "Food market", before_help = "In case you're hungry, here is a", after_help = "For you", )] Food(self, _: &mut Context) -> Result [ Veggies: veggies::Veggies, Meat: meat::Meat, ], } mod veggies { use ::clishe::prelude::*; // All dispatchers are created equal, they // could all be used as the root of an app. async_dispatchers! { // All clap macro attributes available on // top of clap commands can be used here. #[clap(about = "Welcome to the Jungle")] // The name under which commands are declared inside a dispatcher is // the name that is used. This is just the name of the structure // vvvv inside of the program. Same for dispatchers. Veggies(self, _: &mut crate::Context) -> Result [ Carrots: Carrots, Lettuce: Lettuce, ], } // These are clap commands, they contain concrete command implementations. // They are used as leaves under the dispatchers. They could also be used // as the root of the application, making most of the point of the // framework moot! async_commands! { Carrots(self, _ctx: &mut crate::Context) -> Result { Ok(crate::Returned) } struct { // All clap macro attributes available on top // of clap command fields can be used here. #[clap(short, long)] name: Option, }, // The return type must be the same for every command and dispatcher // in the command hierarchy. vvvvvvvvvvvvvvv Lettuce(self, _ctx: &mut crate::Context) -> Result { println!("Welcome to the table, {}", self.name.as_ref().map(|s| { s.as_ref() }).unwrap_or("unknown")); Ok(crate::Returned) } struct { name: Option, }, } } mod meat { use ::clishe::prelude::*; async_dispatchers! { // Overriding the command name at this level is not going to work. #[clap(name = "carne", about = "Aimez la viande, mangez-en mieux")] Meat(self, _: &mut crate::Context) -> Result [ // All sub-commands' clap attributes are shadowed by // attributes applied at higher levels in the command hierarchy. #[clap(about = "Le boeuf. C'est ça qu'on mange")] // If you want to override the name of a command, do it here. Boeuf: Beef, // You could use the clap macro attribute. With different abouts. #[clap(name = "vaca", about = "Vaca. Lo que vamos a comer")] Beef: Beef, ], } async_commands! { // The "about" override here and the "name" // override in the Meat dispatcher will combine. #[clap(about = "Beef. It's What for Dinner")] Beef(self, ctx: &mut crate::Context) -> Result { // All fields are available as owned in here vvvvvvvvv ctx.0 = format!("Welcome to the table, {}!", self.name); Ok(crate::Returned) } struct { name: String, }, } }