V3.0.0 Rewrite

Cargo.toml

@@ -4,6 +4,6 @@ description = "The simple, dependency-less cli library ✨"
 repository = "https://github.com/rust-cli/climake"
 readme = "README.md"
 license = "MIT OR Apache-2.0"
-version = "2.1.0"
+version = "3.0.0-pre.1"
 authors = ["Owez <root@ogriffiths.com>"]
 edition = "2018"

README.md

@@ -1,44 +1,27 @@
-# climake
+# climake 
 
-The simple, dependency-less cli library ✨
+The simple, dependency-free cli library ✨
 
 - [Crates.io](https://crates.io/crates/climake)
 - [Documentation](https://docs.rs/climake)
 
+---
+
+This branch represents the unpublished rewrite version of climake with many advantages compared to the original version which is no longer updated!
+
+---
+
 ## Example 📚
 
-```rust
-use climake::{Argument, CLIMake, DataType};
-
-fn main() {
-    let args = &[
-        Argument::new(
-            &['o'],
-            &["output", "out"],
-            Some("Example output arg"),
-            DataType::Files,
-        ).unwrap(),
-        Argument::new(
-            &['a', 'b', 'c'],
-            &[],
-            Some("Alphabet!"),
-            DataType::None,
-        ).unwrap(),
-    ];
-
-    let cli = CLIMake::new(args, Some("A showcase CLI to demonstrate climake"), None).unwrap();
-
-    println!("Args used: {:#?}", cli.parse());
-}
-```
+Rewrite example coming soon!
 
 ## Installation 🚀
 
 Simply add the following to your `Cargo.toml` file:
 
 ```toml
 [dependencies]
-climake = "2.1"
+climake = "3.0" # note: rewrite isn't out just yet!
 ```
 
 ## License

examples/header_showcase.rs

@@ -0,0 +1,44 @@
+//! Example which simply prints header infomation. Please note that this does not
+//! parse any cli infomation, but just simply prints out infomation about this cli
+
+use climake::CliMake;
+use std::io;
+
+const DIVIDER: &str =
+    "--------------------------------------------------------------------------------";
+
+fn main() -> io::Result<()> {
+    let mut stdout = io::stdout();
+
+    println!("Simple:\n{}", DIVIDER);
+    CliMake::new(
+        "Example program",
+        vec![],
+        vec![],
+        "A simple description",
+        "1.0.0",
+    )
+    .header_msg(None, &mut stdout)?;
+
+    println!("{0}\n\nLong:\n{0}", DIVIDER);
+    CliMake::new(
+        "Example program", 
+        vec![], 
+        vec![], 
+        "A very long description, designed to potentially span multiple lines to test the prowess of formatting climake uses",
+        "1.0.0"
+    ).header_msg(None, &mut stdout)?;
+    println!("{}", DIVIDER);
+
+    println!("{0}\n\nSubcommand example:\n{0}", DIVIDER);
+    CliMake::new(
+        "Example program", 
+        vec![], 
+        vec![], 
+        "This program contains the subcommand aptly named w/the `my_subcommand` command added onto this",
+        "1.0.0"
+    ).header_msg("my_subcommand", &mut stdout)?;
+    println!("{}", DIVIDER);
+
+    Ok(())
+}

examples/help_empty.rs

@@ -0,0 +1,11 @@
+//! Example of the most empty possible CLI you can make, to showcase edge case
+//! handling in regards to help generation
+
+use climake::CliMake;
+use std::io;
+
+fn main() -> io::Result<()> {
+    let cli = CliMake::new("my-cli", vec![], vec![], None, None);
+
+    cli.help_msg(&mut io::stdout())
+}

examples/help_print.rs

@@ -0,0 +1,30 @@
+//! Example to show help generation in action. Please note that this does not
+//! parse any cli infomation, but just simply prints out infomation about this cli
+
+use climake::{Argument, CliMake, Input};
+use std::io;
+
+fn main() -> std::io::Result<()> {
+    let verbose = Argument::new(
+        "Toggles verbose mode",
+        vec!['v'],
+        vec!["verbose"],
+        Input::None,
+    );
+    let debug = Argument::new(
+        "Toggles debug infomation",
+        vec!['d'],
+        vec!["debug"],
+        Input::None,
+    );
+
+    let cli = CliMake::new(
+        "Help info",
+        vec![&verbose, &debug],
+        vec![],
+        "A simple utility cli to print help info",
+        "1.0.0",
+    );
+
+    cli.help_msg(&mut io::stdout())
+}

examples/help_subcommand.rs

@@ -0,0 +1,40 @@
+//! Example showing a demonstration subcommand utilising help generation for itself
+//! with semi-complex recursion/duplication of subcommands
+
+use climake::{CliMake, Subcommand};
+use std::io;
+
+fn main() -> io::Result<()> {
+    let subcmd_img = Subcommand::new("img", vec![], vec![], "An image");
+    let subcmd_text = Subcommand::new("text", vec![], vec![], "Textual input");
+
+    let subcmd_add = Subcommand::new(
+        "add",
+        vec![],
+        vec![&subcmd_img, &subcmd_text],
+        "Adds a new post",
+    );
+    let subcmd_rem = Subcommand::new(
+        "rem",
+        vec![],
+        vec![&subcmd_img, &subcmd_text],
+        "Removes an existing post",
+    );
+
+    let cli = CliMake::new(
+        "subcommandsgalore",
+        vec![],
+        vec![&subcmd_add, &subcmd_rem],
+        "A demonstration cli to show subcommand help",
+        None,
+    );
+
+    println!("Help message overall:\n----");
+    cli.help_msg(&mut io::stdout())?;
+    println!("----\nAdd subcommand help message:\n----");
+    subcmd_add.help_msg(&cli, &mut io::stdout())?;
+    println!("----\nRemove subcommand help message:\n----");
+    subcmd_rem.help_msg(&cli, &mut io::stdout())?;
+
+    Ok(())
+}