Update examples and README

drewolson · Jan 11, 2025 · 750365d · 750365d
1 parent 6b2eea0
commit 750365d
Show file tree

Hide file tree

Showing 14 changed files with 42 additions and 103 deletions.
diff --git a/README.md b/README.md
@@ -9,28 +9,36 @@
 
 ```gleam
 import argv
-import clip
+import clip.{type Command}
 import clip/help
-import clip/opt
+import clip/opt.{type Opt}
 import gleam/io
 import gleam/string
 
 type Person {
   Person(name: String, age: Int)
 }
 
-fn command() {
+fn name_opt() -> Opt(String) {
+  opt.new("name") |> opt.help("Your name")
+}
+
+fn age_opt() -> Opt(Int) {
+  opt.new("age") |> opt.int |> opt.help("Your age")
+}
+
+fn command() -> Command(Person) {
   clip.command({
     use name <- clip.parameter
     use age <- clip.parameter
 
     Person(name, age)
   })
-  |> clip.opt(opt.new("name") |> opt.help("Your name"))
-  |> clip.opt(opt.new("age") |> opt.int |> opt.help("Your age"))
+  |> clip.opt(name_opt())
+  |> clip.opt(age_opt())
 }
 
-pub fn main() {
+pub fn main() -> Nil {
   let result =
     command()
     |> clip.help(help.simple("person", "Create a person"))

diff --git a/examples/custom-opt-types/manifest.toml b/examples/custom-opt-types/manifest.toml
@@ -3,8 +3,8 @@
 
 packages = [
   { name = "argv", version = "1.0.2", build_tools = ["gleam"], requirements = [], otp_app = "argv", source = "hex", outer_checksum = "BA1FF0929525DEBA1CE67256E5ADF77A7CDDFE729E3E3F57A5BDCAA031DED09D" },
-  { name = "clip", version = "0.6.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../.." },
-  { name = "gleam_stdlib", version = "0.43.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "69EF22E78FDCA9097CBE7DF91C05B2A8B5436826D9F66680D879182C0860A747" },
+  { name = "clip", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../.." },
+  { name = "gleam_stdlib", version = "0.52.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "50703862DF26453B277688FFCDBE9DD4AC45B3BD9742C0B370DB62BC1629A07D" },
 ]
 
 [requirements]

diff --git a/examples/default-values/manifest.toml b/examples/default-values/manifest.toml
@@ -3,8 +3,8 @@
 
 packages = [
   { name = "argv", version = "1.0.2", build_tools = ["gleam"], requirements = [], otp_app = "argv", source = "hex", outer_checksum = "BA1FF0929525DEBA1CE67256E5ADF77A7CDDFE729E3E3F57A5BDCAA031DED09D" },
-  { name = "clip", version = "0.6.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../.." },
-  { name = "gleam_stdlib", version = "0.43.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "69EF22E78FDCA9097CBE7DF91C05B2A8B5436826D9F66680D879182C0860A747" },
+  { name = "clip", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../.." },
+  { name = "gleam_stdlib", version = "0.52.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "50703862DF26453B277688FFCDBE9DD4AC45B3BD9742C0B370DB62BC1629A07D" },
 ]
 
 [requirements]

diff --git a/examples/javascript/manifest.toml b/examples/javascript/manifest.toml
@@ -3,8 +3,8 @@
 
 packages = [
   { name = "argv", version = "1.0.2", build_tools = ["gleam"], requirements = [], otp_app = "argv", source = "hex", outer_checksum = "BA1FF0929525DEBA1CE67256E5ADF77A7CDDFE729E3E3F57A5BDCAA031DED09D" },
-  { name = "clip", version = "0.6.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../.." },
-  { name = "gleam_stdlib", version = "0.43.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "69EF22E78FDCA9097CBE7DF91C05B2A8B5436826D9F66680D879182C0860A747" },
+  { name = "clip", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../.." },
+  { name = "gleam_stdlib", version = "0.52.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "50703862DF26453B277688FFCDBE9DD4AC45B3BD9742C0B370DB62BC1629A07D" },
 ]
 
 [requirements]

diff --git a/examples/many-opts/manifest.toml b/examples/many-opts/manifest.toml
@@ -3,8 +3,8 @@
 
 packages = [
   { name = "argv", version = "1.0.2", build_tools = ["gleam"], requirements = [], otp_app = "argv", source = "hex", outer_checksum = "BA1FF0929525DEBA1CE67256E5ADF77A7CDDFE729E3E3F57A5BDCAA031DED09D" },
-  { name = "clip", version = "0.6.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../.." },
-  { name = "gleam_stdlib", version = "0.43.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "69EF22E78FDCA9097CBE7DF91C05B2A8B5436826D9F66680D879182C0860A747" },
+  { name = "clip", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../.." },
+  { name = "gleam_stdlib", version = "0.52.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "50703862DF26453B277688FFCDBE9DD4AC45B3BD9742C0B370DB62BC1629A07D" },
 ]
 
 [requirements]

diff --git a/examples/parameter-syntax/.gitignore b/examples/parameter-syntax/.gitignore
diff --git a/examples/parameter-syntax/README.md b/examples/parameter-syntax/README.md
diff --git a/examples/parameter-syntax/gleam.toml b/examples/parameter-syntax/gleam.toml
diff --git a/examples/parameter-syntax/manifest.toml b/examples/parameter-syntax/manifest.toml
diff --git a/examples/parameter-syntax/src/cli.gleam b/examples/parameter-syntax/src/cli.gleam
diff --git a/examples/simple/manifest.toml b/examples/simple/manifest.toml
@@ -3,8 +3,8 @@
 
 packages = [
   { name = "argv", version = "1.0.2", build_tools = ["gleam"], requirements = [], otp_app = "argv", source = "hex", outer_checksum = "BA1FF0929525DEBA1CE67256E5ADF77A7CDDFE729E3E3F57A5BDCAA031DED09D" },
-  { name = "clip", version = "0.6.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../.." },
-  { name = "gleam_stdlib", version = "0.43.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "69EF22E78FDCA9097CBE7DF91C05B2A8B5436826D9F66680D879182C0860A747" },
+  { name = "clip", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../.." },
+  { name = "gleam_stdlib", version = "0.52.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "50703862DF26453B277688FFCDBE9DD4AC45B3BD9742C0B370DB62BC1629A07D" },
 ]
 
 [requirements]

diff --git a/examples/simple/src/cli.gleam b/examples/simple/src/cli.gleam
@@ -1,26 +1,34 @@
 import argv
-import clip
+import clip.{type Command}
 import clip/help
-import clip/opt
+import clip/opt.{type Opt}
 import gleam/io
 import gleam/string
 
 type Person {
   Person(name: String, age: Int)
 }
 
-fn command() {
+fn name_opt() -> Opt(String) {
+  opt.new("name") |> opt.help("Your name")
+}
+
+fn age_opt() -> Opt(Int) {
+  opt.new("age") |> opt.int |> opt.help("Your age")
+}
+
+fn command() -> Command(Person) {
   clip.command({
     use name <- clip.parameter
     use age <- clip.parameter
 
     Person(name, age)
   })
-  |> clip.opt(opt.new("name") |> opt.help("Your name"))
-  |> clip.opt(opt.new("age") |> opt.int |> opt.help("Your age"))
+  |> clip.opt(name_opt())
+  |> clip.opt(age_opt())
 }
 
-pub fn main() {
+pub fn main() -> Nil {
   let result =
     command()
     |> clip.help(help.simple("person", "Create a person"))

diff --git a/examples/subcommand-with-default/manifest.toml b/examples/subcommand-with-default/manifest.toml
@@ -3,8 +3,8 @@
 
 packages = [
   { name = "argv", version = "1.0.2", build_tools = ["gleam"], requirements = [], otp_app = "argv", source = "hex", outer_checksum = "BA1FF0929525DEBA1CE67256E5ADF77A7CDDFE729E3E3F57A5BDCAA031DED09D" },
-  { name = "clip", version = "0.6.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../.." },
-  { name = "gleam_stdlib", version = "0.43.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "69EF22E78FDCA9097CBE7DF91C05B2A8B5436826D9F66680D879182C0860A747" },
+  { name = "clip", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../.." },
+  { name = "gleam_stdlib", version = "0.52.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "50703862DF26453B277688FFCDBE9DD4AC45B3BD9742C0B370DB62BC1629A07D" },
 ]
 
 [requirements]

diff --git a/examples/subcommand/manifest.toml b/examples/subcommand/manifest.toml
@@ -3,8 +3,8 @@
 
 packages = [
   { name = "argv", version = "1.0.2", build_tools = ["gleam"], requirements = [], otp_app = "argv", source = "hex", outer_checksum = "BA1FF0929525DEBA1CE67256E5ADF77A7CDDFE729E3E3F57A5BDCAA031DED09D" },
-  { name = "clip", version = "0.6.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../.." },
-  { name = "gleam_stdlib", version = "0.43.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "69EF22E78FDCA9097CBE7DF91C05B2A8B5436826D9F66680D879182C0860A747" },
+  { name = "clip", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../.." },
+  { name = "gleam_stdlib", version = "0.52.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "50703862DF26453B277688FFCDBE9DD4AC45B3BD9742C0B370DB62BC1629A07D" },
 ]
 
 [requirements]