Update readme (#35)

* update gifs

* beautify help

* update readme

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased] - yyyy-mm-dd
 
+## [0.1.3] - 2024-09-19
+
+- Introduce `mog` dependency for help function formatting.
+
 ## [0.1.2] - 2024-09-13
 
 - First release with a changelog! Added rattler build and conda publish.

README.md

@@ -1,13 +1,13 @@
 # Prism
 
-![Mojo 24.5](https://img.shields.io/badge/Mojo%F0%9F%94%A5-24.5-purple)
-
 A Budding CLI Library!
 
 Inspired by: `Cobra`!
 
-> [!NOTE]
-> This library will often have breaking changes and it should not be used for anything in production.
+![Mojo Version](https://img.shields.io/badge/Mojo%F0%9F%94%A5-24.5-orange)
+![Build Status](https://github.com/thatstoasty/prism/actions/workflows/build.yml/badge.svg)
+![Test Status](https://github.com/thatstoasty/prism/actions/workflows/test.yml/badge.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ## Installation
 
@@ -19,7 +19,33 @@ Inspired by: `Cobra`!
 
 Here's an example of a basic command and subcommand!
 
-![Basic Example](https://github.com/thatstoasty/prism/blob/main/doc/images/chromeria.png)
+```mojo
+from memory import Arc
+from prism import Command
+
+
+fn test(command: Arc[Command], args: List[String]) -> None:
+    print("Pass chromeria as a subcommand!")
+
+
+fn hello(command: Arc[Command], args: List[String]) -> None:
+    print("Hello from Chromeria!")
+
+
+fn main() -> None:
+    var root_command = Arc(
+        Command(
+            name="hello",
+            description="This is a dummy command!",
+            run=test,
+        )
+    )
+
+    var hello_command = Arc(Command(name="chromeria", description="This is a dummy command!", run=hello))
+
+    root_command[].add_command(hello_command)
+    root_command[].execute()
+```
 
 ![Chromeria](https://github.com/thatstoasty/prism/blob/main/doc/tapes/hello-chromeria.gif)
 
@@ -261,14 +287,9 @@ fn init() -> None:
 
 - Flags can have values passed by using the `=` operator. Like `--count=5` OR like `--count 5`.
 - This library leans towards Errors as values over raising Exceptions.
-- `Optional[Error]` would be much cleaner for Command `erroring_run` functions. For now return `Error()` if there's no `Error` to return.
 
 ## TODO
 
-### Repository
-
-- [ ] Add a description
-
 ### Documentation
 
 ### Features

doc/tapes/aliases.tape

@@ -1,11 +1,14 @@
-Output demos/tapes/aliases.gif
+Output doc/tapes/aliases.gif
 
 Set Shell "zsh"
 Set FontSize 20
 Set Width 1200
 Set Height 400
+Set WindowBar Colorful
+Set Theme "Catppuccin Frappe"
+Set BorderRadius 10
 
-Type "mojo build examples/aliases/root.mojo -o aliases" Sleep 500ms  Enter
+Type "mojo build examples/aliases.mojo -o aliases" Sleep 500ms  Enter
 Sleep 2s
 Type "./aliases" Sleep 500ms  Enter
 Sleep 2s

doc/tapes/arg_validators.tape

@@ -1,12 +1,14 @@
-Output demos/tapes/arg_validators.gif
+Output doc/tapes/arg_validators.gif
 
 Set Shell "zsh"
 Set FontSize 20
 Set Width 1200
 Set Height 600
+Set WindowBar Colorful
+Set Theme "Catppuccin Frappe"
+Set BorderRadius 10
 
-
-Type "mojo build examples/arg_validators/root.mojo -o validators" Sleep 500ms  Enter
+Type "mojo build examples/arg_validators.mojo -o validators" Sleep 500ms  Enter
 Sleep 2s
 Type "./validators Hello from Mojo!" Sleep 500ms  Enter
 Sleep 2s

doc/tapes/hello-chromeria.tape → doc/tapes/chromeria.tape

@@ -1,11 +1,15 @@
-Output demos/tapes/hello-chromeria.gif
+Output doc/tapes/chromeria.gif
 
 Set Shell "zsh"
 Set FontSize 23
 Set Width 1200
 Set Height 300
+Set WindowBar Colorful
+Set Theme "Catppuccin Frappe"
+Set BorderRadius 10
 
-Type "mojo build examples/hello_chromeria/root.mojo -o hello" Sleep 500ms  Enter
+
+Type "mojo build examples/chromeria.mojo -o hello" Sleep 500ms  Enter
 Sleep 1500ms
 Type "./hello" Sleep 500ms  Enter
 Sleep 1500ms

doc/tapes/flag_groups-2.tape

@@ -1,12 +1,14 @@
-Output demos/tapes/flag_groups-2.gif
+Output doc/tapes/flag_groups-2.gif
 
 Set Shell "zsh"
 Set FontSize 20
 Set Width 1200
 Set Height 600
+Set WindowBar Colorful
+Set Theme "Catppuccin Frappe"
+Set BorderRadius 10
 
-
-Type "mojo build examples/flag_groups/child.mojo -o group" Sleep 500ms  Enter
+Type "mojo build examples/fg_child.mojo -o group" Sleep 500ms  Enter
 Sleep 4s
 Type "./group tool --required -a --host=www.example.com --port 8080" Sleep 500ms  Enter
 Sleep 2s

doc/tapes/flag_groups.tape

@@ -1,12 +1,14 @@
-Output demos/tapes/flag_groups.gif
+Output doc/tapes/flag_groups.gif
 
 Set Shell "zsh"
 Set FontSize 20
 Set Width 1200
 Set Height 600
+Set WindowBar Colorful
+Set Theme "Catppuccin Frappe"
+Set BorderRadius 10
 
-
-Type "mojo build examples/flag_groups/parent.mojo -o group" Sleep 500ms  Enter
+Type "mojo build examples/fg_parent.mojo -o group" Sleep 500ms  Enter
 Sleep 3s
 Type "./group --required --host=www.example.com --port 8080" Sleep 500ms  Enter
 Sleep 2s

doc/tapes/help.tape

@@ -1,12 +1,14 @@
-Output demos/tapes/help.gif
+Output doc/tapes/help.gif
 
 Set Shell "zsh"
 Set FontSize 20
 Set Width 1200
 Set Height 600
+Set WindowBar Colorful
+Set Theme "Catppuccin Frappe"
+Set BorderRadius 10
 
-
-Type "mojo build examples/flag_groups/child.mojo -o group" Sleep 500ms  Enter
+Type "mojo build examples/fg_child.mojo -o group" Sleep 500ms  Enter
 Sleep 3s
 Type "./group --help" Sleep 500ms  Enter
 Sleep 5s

doc/tapes/logging.tape

@@ -1,9 +1,12 @@
-Output demos/tapes/logging.gif
+Output doc/tapes/logging.gif
 
 Set Shell "zsh"
 Set FontSize 20
 Set Width 1200
 Set Height 400
+Set WindowBar Colorful
+Set Theme "Catppuccin Frappe"
+Set BorderRadius 10
 
 Type "mojo build examples/logging/root.mojo -o logger" Sleep 500ms  Enter
 Sleep 4s

doc/tapes/nested/nested-1.tape

@@ -1,4 +1,4 @@
-Output demos/tapes/nested-1.gif
+Output doc/tapes/nested-1.gif
 
 Set Shell "zsh"
 Set FontSize 32

doc/tapes/nested/nested-2.tape

@@ -55,7 +55,7 @@
 #   Hide                            Hide the subsequent commands from the output
 #   Show                            Show the subsequent commands in the output
 
-Output demos/tapes/nested-2.gif
+Output doc/tapes/nested-2.gif
 
 Set Shell "zsh"
 Set FontSize 30

doc/tapes/nested/nested-3.tape

@@ -55,7 +55,7 @@
 #   Hide                            Hide the subsequent commands from the output
 #   Show                            Show the subsequent commands in the output
 
-Output demos/tapes/nested-3.gif
+Output doc/tapes/nested-3.gif
 
 Require echo
 

doc/tapes/nested/nested-4.tape

@@ -55,7 +55,7 @@
 #   Hide                            Hide the subsequent commands from the output
 #   Show                            Show the subsequent commands in the output
 
-Output demos/tapes/nested-4.gif
+Output doc/tapes/nested-4.gif
 
 Require echo
 

doc/tapes/persistent.tape

@@ -1,13 +1,16 @@
-Output demos/tapes/persistent.gif
+Output doc/tapes/persistent.gif
 
 Set Shell "zsh"
 Set FontSize 20
 Set Width 1200
 Set Height 400
+Set WindowBar Colorful
+Set Theme "Catppuccin Frappe"
+Set BorderRadius 10
 
 # Type "mojo build examples/persistent/root.mojo -o pet_facts" Sleep 500ms  Enter
 # Sleep 1500ms
 # Type "./pet_facts get dog -l" Sleep 500ms  Enter
-Type "mojo run examples/persistent/root.mojo get dog -l" Sleep 500ms  Enter
+Type "mojo run examples/persistent_flags.mojo get dog -l" Sleep 500ms  Enter
 Sleep 3s
 Sleep 5s

doc/tapes/printer.tape

@@ -1,10 +1,12 @@
-Output demos/tapes/printer.gif
+Output doc/tapes/printer.gif
 
 Set Shell "zsh"
 Set FontSize 23
 Set Width 1200
 Set Height 400
-
+Set WindowBar Colorful
+Set Theme "Catppuccin Frappe"
+Set BorderRadius 10
 
 Type "mojo build examples/printer/printer.mojo -o printer" Sleep 500ms  Enter
 Sleep 4s

examples/aliases.mojo

@@ -10,7 +10,7 @@ fn tool_func(command: Arc[Command], args: List[String]) -> None:
     print("My tool!")
 
 
-fn init() -> None:
+fn main() -> None:
     var root_command = Arc(
         Command(
             name="my",
@@ -27,7 +27,3 @@ fn init() -> None:
 
     root_command[].add_command(tool_command)
     root_command[].execute()
-
-
-fn main() -> None:
-    init()

examples/arg_validators.mojo

@@ -13,7 +13,7 @@ fn hello(command: Arc[Command], args: List[String]) -> None:
     print(cmd[].name, "Hello from Chromeria!")
 
 
-fn init() -> None:
+fn main() -> None:
     var root_command = Arc(
         Command(
             name="hello",
@@ -57,7 +57,3 @@ fn init() -> None:
     root_command[].add_command(exact_args_command)
     root_command[].add_command(range_args_command)
     root_command[].execute()
-
-
-fn main() -> None:
-    init()

examples/chromeria.mojo

@@ -10,7 +10,7 @@ fn hello(command: Arc[Command], args: List[String]) -> None:
     print("Hello from Chromeria!")
 
 
-fn init() -> None:
+fn main() -> None:
     var root_command = Arc(
         Command(
             name="hello",
@@ -23,7 +23,3 @@ fn init() -> None:
 
     root_command[].add_command(hello_command)
     root_command[].execute()
-
-
-fn main() -> None:
-    init()

examples/fg_child.mojo

@@ -10,7 +10,7 @@ fn tool_func(command: Arc[Command], args: List[String]) -> None:
     print("My tool!")
 
 
-fn init() -> None:
+fn main() -> None:
     var root_command = Arc(
         Command(
             name="my",
@@ -35,7 +35,3 @@ fn init() -> None:
     tool_command[].mark_flags_mutually_exclusive("host", "uri")
 
     root_command[].execute()
-
-
-fn main() -> None:
-    init()

examples/fg_parent.mojo

@@ -10,7 +10,7 @@ fn tool_func(command: Arc[Command], args: List[String]) -> None:
     print("My tool!")
 
 
-fn init() -> None:
+fn main() -> None:
     var root_command = Arc(
         Command(
             name="my",
@@ -27,7 +27,3 @@ fn init() -> None:
     root_command[].mark_flag_required("required")
 
     root_command[].execute()
-
-
-fn main() -> None:
-    init()

examples/hello_world.mojo

@@ -81,7 +81,7 @@ fn test(command: Arc[Command], args: List[String]) -> None:
     return None
 
 
-fn init() -> None:
+fn main() -> None:
     var root_command = Arc(
         Command(
             name="tones",
@@ -102,7 +102,3 @@ fn init() -> None:
     root_command[].add_command(printer_command)
 
     root_command[].execute()
-
-
-fn main() -> None:
-    init()

examples/nested.mojo

@@ -65,7 +65,7 @@ fn get_dog_breeds(command: Arc[Command], args: List[String]) -> Error:
     return Error()
 
 
-fn init() -> None:
+fn main() -> None:
     var root_command = Arc(Command(name="nested", description="Base command.", run=base))
 
     var get_command = Arc(
@@ -98,7 +98,3 @@ fn init() -> None:
     get_command[].add_command(dog_command)
     root_command[].add_command(get_command)
     root_command[].execute()
-
-
-fn main() -> None:
-    init()