decasify 0.7.6__tar.gz → 0.8.0__tar.gz

{decasify-0.7.6 → decasify-0.8.0}/Cargo.lock

@@ -37,9 +37,9 @@ checksum = "5c6cb57a04249c6480766f7f7cef5467412af1490f8d1e243141daddada3264f"
 
 [[package]]
 name = "anstream"
-version = "0.6.15"
+version = "0.6.17"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "64e15c1ab1f89faffbf04a634d5e1962e9074f2741eef6d97f3c4e322426d526"
+checksum = "23a1e53f0f5d86382dafe1cf314783b2044280f406e7e1506368220ad11b1338"
 dependencies = [
  "anstyle",
  "anstyle-parse",
@@ -52,36 +52,36 @@ dependencies = [
 
 [[package]]
 name = "anstyle"
-version = "1.0.8"
+version = "1.0.9"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1bec1de6f59aedf83baf9ff929c98f2ad654b97c9510f4e70cf6f661d49fd5b1"
+checksum = "8365de52b16c035ff4fcafe0092ba9390540e3e352870ac09933bebcaa2c8c56"
 
 [[package]]
 name = "anstyle-parse"
-version = "0.2.5"
+version = "0.2.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "eb47de1e80c2b463c735db5b217a0ddc39d612e7ac9e2e96a5aed1f57616c1cb"
+checksum = "3b2d16507662817a6a20a9ea92df6652ee4f94f914589377d69f3b21bc5798a9"
 dependencies = [
  "utf8parse",
 ]
 
 [[package]]
 name = "anstyle-query"
-version = "1.1.1"
+version = "1.1.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6d36fc52c7f6c869915e99412912f22093507da8d9e942ceaf66fe4b7c14422a"
+checksum = "79947af37f4177cfead1110013d678905c37501914fba0efea834c3fe9a8d60c"
 dependencies = [
- "windows-sys 0.52.0",
+ "windows-sys 0.59.0",
 ]
 
 [[package]]
 name = "anstyle-wincon"
-version = "3.0.4"
+version = "3.0.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5bf74e1b6e971609db8ca7a9ce79fd5768ab6ae46441c572e46cf596f59e57f8"
+checksum = "2109dbce0e72be3ec00bed26e6a7479ca384ad226efdd66db8fa2e3a38c83125"
 dependencies = [
  "anstyle",
- "windows-sys 0.52.0",
+ "windows-sys 0.59.0",
 ]
 
 [[package]]
@@ -213,9 +213,9 @@ dependencies = [
 
 [[package]]
 name = "clap_complete"
-version = "4.5.33"
+version = "4.5.35"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9646e2e245bf62f45d39a0f3f36f1171ad1ea0d6967fd114bca72cb02a8fcdfb"
+checksum = "07a13ab5b8cb13dbe35e68b83f6c12f9293b2f601797b71bc9f23befdb329feb"
 dependencies = [
  "clap",
 ]
@@ -256,9 +256,9 @@ checksum = "cbd0f76e066e64fdc5631e3bb46381254deab9ef1158292f27c8c57e3bf3fe59"
 
 [[package]]
 name = "colorchoice"
-version = "1.0.2"
+version = "1.0.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d3fd119d74b830634cea2a0f58bbd0d54540518a14397557951e79340abc28c0"
+checksum = "5b63caa9aa9397e2d9480a9b13673856c78d8ac123288526c37d7839f2a86990"
 
 [[package]]
 name = "crc32fast"
@@ -306,7 +306,7 @@ dependencies = [
 
 [[package]]
 name = "decasify"
-version = "0.7.6"
+version = "0.8.0"
 dependencies = [
  "anyhow",
  "assert_cmd",
@@ -317,6 +317,7 @@ dependencies = [
  "predicates",
  "pyo3",
  "regex",
+ "snafu",
  "strum",
  "strum_macros",
  "titlecase",
@@ -383,6 +384,12 @@ version = "1.0.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "92773504d58c093f6de2459af4af33faa518c13451eb8f2b5698ed3d36e7c813"
 
+[[package]]
+name = "either"
+version = "1.13.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "60b1af1c220855b6ceac025d3f6ecdd2b7c4894bfe9cd9bda4fbb4bc7c0d4cf0"
+
 [[package]]
 name = "errno"
 version = "0.3.9"
@@ -1103,23 +1110,24 @@ dependencies = [
 
 [[package]]
 name = "mlua"
-version = "0.9.9"
+version = "0.10.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d111deb18a9c9bd33e1541309f4742523bfab01d276bfa9a27519f6de9c11dc7"
+checksum = "0f6ddbd668297c46be4bdea6c599dcc1f001a129586272d53170b7ac0a62961e"
 dependencies = [
  "bstr",
+ "either",
  "mlua-sys",
  "mlua_derive",
  "num-traits",
- "once_cell",
+ "parking_lot",
  "rustc-hash",
 ]
 
 [[package]]
 name = "mlua-sys"
-version = "0.6.3"
+version = "0.6.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ebe026d6bd1583a9cf9080e189030ddaea7e6f5f0deb366a8e26f8a26c4135b8"
+checksum = "e9eebac25c35a13285456c88ee2fde93d9aee8bcfdaf03f9d6d12be3391351ec"
 dependencies = [
  "cc",
  "cfg-if",
@@ -1128,9 +1136,9 @@ dependencies = [
 
 [[package]]
 name = "mlua_derive"
-version = "0.9.3"
+version = "0.10.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "09697a6cec88e7f58a02c7ab5c18c611c6907c8654613df9cc0192658a4fb859"
+checksum = "2cfc5faa2e0d044b3f5f0879be2920e0a711c97744c42cf1c295cb183668933e"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -1348,9 +1356,9 @@ dependencies = [
 
 [[package]]
 name = "regex"
-version = "1.11.0"
+version = "1.11.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "38200e5ee88914975b69f657f0801b6f6dccafd44fd9326302a4aaeecfacb1d8"
+checksum = "b544ef1b4eac5dc2db33ea63606ae9ffcfac26c1416a2806ae0bf5f56b201191"
 dependencies = [
  "aho-corasick",
  "memchr",
@@ -1514,6 +1522,27 @@ version = "1.13.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "3c5e1a9a646d36c3599cd173a41282daf47c44583ad367b8e6837255952e5c67"
 
+[[package]]
+name = "snafu"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "223891c85e2a29c3fe8fb900c1fae5e69c2e42415e3177752e8718475efa5019"
+dependencies = [
+ "snafu-derive",
+]
+
+[[package]]
+name = "snafu-derive"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "03c3c6b7927ffe7ecaa769ee0e3994da3b8cafc8f444578982c83ecb161af917"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "strsim"
 version = "0.11.1"
@@ -1541,9 +1570,9 @@ dependencies = [
 
 [[package]]
 name = "syn"
-version = "2.0.82"
+version = "2.0.85"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "83540f837a8afc019423a8edb95b52a8effe46957ee402287f4292fae35be021"
+checksum = "5023162dfcd14ef8f32034d8bcd4cc5ddc61ef7a247c024a33e24e1f24d21b56"
 dependencies = [
  "proc-macro2",
  "quote",

{decasify-0.7.6 → decasify-0.8.0}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "decasify"
-version = "0.7.6"
+version = "0.8.0"
 authors = ["Caleb Maclennan <caleb@alerque.com>"]
 edition = "2021"
 rust-version = "1.73.0"
@@ -23,12 +23,12 @@ required-features = ["cli"]
 [features]
 default = []
 full = ["cli", "bash", "elvish", "fish", "manpage", "powershell", "zsh"]
-completions = ["cli", "clap_complete"]
-cli = ["clap"]
+completions = ["cli", "dep:clap_complete"]
+cli = ["dep:clap"]
 bash = ["completions"]
 elvish = ["completions"]
 fish = ["completions"]
-manpage = ["clap_mangen"]
+manpage = ["dep:clap_mangen"]
 powershell = ["completions"]
 zsh = ["completions"]
 luamodule = []
@@ -37,17 +37,19 @@ lua53 = ["luamodule", "mlua/lua53"]
 lua52 = ["luamodule", "mlua/lua52"]
 lua51 = ["luamodule", "mlua/lua51"]
 luajit = ["luamodule", "mlua/luajit"]
-pythonmodule = ["pyo3"]
-wasm = ["wasm-bindgen"]
+pythonmodule = ["dep:pyo3"]
+unstable-trait = []
+wasm = ["dep:wasm-bindgen"]
 
 [profile.release]
 lto = true
 
 [dependencies]
-regex = "1.10"
+regex = "1.11"
+snafu = "0.8"
 strum = "0.26"
 strum_macros = "0.26"
-unicode_titlecase = "2.3"
+unicode_titlecase = "2.4"
 
   [dependencies.clap]
   version = "4.5"
@@ -55,7 +57,7 @@ unicode_titlecase = "2.3"
   features = ["derive", "wrap_help"]
 
   [dependencies.mlua]
-  version = "0.9"
+  version = "0.10.0"
   optional = true
   features = ["module"]
 
@@ -73,6 +75,7 @@ unicode_titlecase = "2.3"
   optional = true
 
 [build-dependencies]
+snafu = "0.8"
 strum = "0.26"
 strum_macros = "0.26"
 
@@ -104,6 +107,10 @@ predicates = "3.1"
 [lints.rust]
 unexpected_cfgs = { level = "warn", check-cfg = ['cfg(build)'] }
 
+[package.metadata.docs.rs]
+features = ["luamodule", "luajit", "pythonmodule", "wasm", "unstable-trait"]
+rustdoc-args = ["--cfg", "docsrs"]
+
 [package.metadata.git-cliff.git]
 protect_breaking_commits = true
 commit_parsers = [

{decasify-0.7.6 → decasify-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: decasify
-Version: 0.7.6
+Version: 0.8.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
@@ -54,15 +54,6 @@ The AP style is largely unimplemented.
 
 Contributions are welcome for better style guide support or further languages.
 
-``` console
-$ decasify -l tr ILIK SU VE İTEN RÜZGARLAR
-Ilık Su ve İten Rüzgarlar
-$ echo ILIK SU VE İTEN RÜZGARLAR | decasify -l tr
-Ilık Su ve İten Rüzgarlar
-$ echo foo BAR AND baz: an alter ego | decasify -l en -s gruber
-Foo BAR and Baz: An Alter Ego
-```
-
 [tdk]: https://tdk.gov.tr/icerik/yazim-kurallari/buyuk-harflerin-kullanildigi-yerler/
 [titlecase_crate]: https://crates.io/crates/titlecase
 
@@ -70,27 +61,23 @@ Foo BAR and Baz: An Alter Ego
 
 Use of the CLI is pretty simple.
 Input may be either shell arguments or STDIN.
+Arguments can control the various options.
+For full usage information check `decasify --help` or `man decasify`.
 
-```console
-$ decasify --help
-A CLI tool to convert all-caps strings to title-case or other less aggressive tones that supports
-Turkish input
-
-Usage: decasify [OPTIONS] [INPUT]...
-
-Arguments:
-  [INPUT]...  Input string
-
-Options:
-  -l, --locale <LOCALE>  Locale [default: EN] [possible values: EN, TR]
-  -c, --case <CASE>      Target case [default: Title] [possible values: Lower, Sentence, Title,
-                         Upper]
-  -s, --style <STYLE>    Style Guide [possible values: ap, cmos, gruber]
-  -h, --help             Print help
-  -V, --version          Print version
+``` console
+$ decasify -l tr ILIK SU VE İTEN RÜZGARLAR
+Ilık Su ve İten Rüzgarlar
+
+$ echo ILIK SU VE İTEN RÜZGARLAR | decasify -l tr
+Ilık Su ve İten Rüzgarlar
+
+$ echo foo BAR AND baz: an alter ego | decasify -l en -s gruber
+Foo BAR and Baz: An Alter Ego
 ```
 
-First, check your distro for packages, e.g. for Arch Linux get it [from the AUR](https://aur.archlinux.org/packages/decasify).
+### Installation
+
+To install, first check your distro for packages, e.g. for [Arch Linux](https://archlinux.org/packages/extra/x86_64/decasify/) just install via `pacman -S decasify`.
 
 Otherwise for many platforms you can run it directly or install it to a shell using Nix Flakes:
 
@@ -126,21 +113,21 @@ In your `Cargo.toml` file.
 
 ```toml
 [dependencies]
-decasify = "0.7"
+decasify = "0.8"
 ```
 
 Then use the crate functions and types in your project something like this:
 
 ```rust
-use decasify::to_titlecase;
+use decasify::titlecase;
 use decasify::{Locale, StyleGuide};
 
 fn demo() {
     let input = "ILIK SU VE İTEN RÜZGARLAR";
-    let output = to_titlecase(input, Locale::TR, StyleGuide::LanguageDefault);
+    let output = titlecase(input, Locale::TR, StyleGuide::LanguageDefault);
     eprintln! {"{output}"};
     let input = "title with a twist: a colon";
-    let output = to_titlecase(input, Locale::EN, StyleGuide::DaringFireball);
+    let output = titlecase(input, Locale::EN, StyleGuide::DaringFireball);
     eprintln! {"{output}"};
 }
 ```

{decasify-0.7.6 → decasify-0.8.0}/README.md

@@ -32,15 +32,6 @@ The AP style is largely unimplemented.
 
 Contributions are welcome for better style guide support or further languages.
 
-``` console
-$ decasify -l tr ILIK SU VE İTEN RÜZGARLAR
-Ilık Su ve İten Rüzgarlar
-$ echo ILIK SU VE İTEN RÜZGARLAR | decasify -l tr
-Ilık Su ve İten Rüzgarlar
-$ echo foo BAR AND baz: an alter ego | decasify -l en -s gruber
-Foo BAR and Baz: An Alter Ego
-```
-
 [tdk]: https://tdk.gov.tr/icerik/yazim-kurallari/buyuk-harflerin-kullanildigi-yerler/
 [titlecase_crate]: https://crates.io/crates/titlecase
 
@@ -48,27 +39,23 @@ Foo BAR and Baz: An Alter Ego
 
 Use of the CLI is pretty simple.
 Input may be either shell arguments or STDIN.
+Arguments can control the various options.
+For full usage information check `decasify --help` or `man decasify`.
 
-```console
-$ decasify --help
-A CLI tool to convert all-caps strings to title-case or other less aggressive tones that supports
-Turkish input
-
-Usage: decasify [OPTIONS] [INPUT]...
-
-Arguments:
-  [INPUT]...  Input string
-
-Options:
-  -l, --locale <LOCALE>  Locale [default: EN] [possible values: EN, TR]
-  -c, --case <CASE>      Target case [default: Title] [possible values: Lower, Sentence, Title,
-                         Upper]
-  -s, --style <STYLE>    Style Guide [possible values: ap, cmos, gruber]
-  -h, --help             Print help
-  -V, --version          Print version
+``` console
+$ decasify -l tr ILIK SU VE İTEN RÜZGARLAR
+Ilık Su ve İten Rüzgarlar
+
+$ echo ILIK SU VE İTEN RÜZGARLAR | decasify -l tr
+Ilık Su ve İten Rüzgarlar
+
+$ echo foo BAR AND baz: an alter ego | decasify -l en -s gruber
+Foo BAR and Baz: An Alter Ego
 ```
 
-First, check your distro for packages, e.g. for Arch Linux get it [from the AUR](https://aur.archlinux.org/packages/decasify).
+### Installation
+
+To install, first check your distro for packages, e.g. for [Arch Linux](https://archlinux.org/packages/extra/x86_64/decasify/) just install via `pacman -S decasify`.
 
 Otherwise for many platforms you can run it directly or install it to a shell using Nix Flakes:
 
@@ -104,21 +91,21 @@ In your `Cargo.toml` file.
 
 ```toml
 [dependencies]
-decasify = "0.7"
+decasify = "0.8"
 ```
 
 Then use the crate functions and types in your project something like this:
 
 ```rust
-use decasify::to_titlecase;
+use decasify::titlecase;
 use decasify::{Locale, StyleGuide};
 
 fn demo() {
     let input = "ILIK SU VE İTEN RÜZGARLAR";
-    let output = to_titlecase(input, Locale::TR, StyleGuide::LanguageDefault);
+    let output = titlecase(input, Locale::TR, StyleGuide::LanguageDefault);
     eprintln! {"{output}"};
     let input = "title with a twist: a colon";
-    let output = to_titlecase(input, Locale::EN, StyleGuide::DaringFireball);
+    let output = titlecase(input, Locale::EN, StyleGuide::DaringFireball);
     eprintln! {"{output}"};
 }
 ```

{decasify-0.7.6 → decasify-0.8.0}/build-aux/build.rs

@@ -36,6 +36,9 @@ fn main() -> AnyhowResult<()> {
     if let Ok(val) = env::var("VERSION_FROM_AUTOTOOLS") {
         println!("cargo:rustc-env=VERGEN_GIT_DESCRIBE={val}");
         builder.add_instructions(&RustcBuilder::all_rustc()?)?;
+    } else if let Ok(val) = env::var("LUA_ROCKSPEC_VERSION") {
+        println!("cargo:rustc-env=VERGEN_GIT_DESCRIBE=v{val}");
+        builder.add_instructions(&RustcBuilder::all_rustc()?)?;
     } else {
         builder.add_instructions(&GixBuilder::all_git()?)?;
     };

decasify-0.8.0/src/bin/decasify.rs

@@ -0,0 +1,88 @@
+// SPDX-FileCopyrightText: © 2023 Caleb Maclennan <caleb@alerque.com>
+// SPDX-License-Identifier: LGPL-3.0-only
+
+use decasify::cli::Cli;
+use decasify::{lowercase, sentencecase, titlecase, uppercase};
+use decasify::{Case, Locale, StyleGuide};
+
+use snafu::prelude::*;
+
+use clap::CommandFactory;
+use std::io;
+use std::io::BufRead;
+
+#[derive(Snafu)]
+enum Error {
+    #[snafu(display("Failed to identify input"))]
+    Input {},
+
+    #[snafu(display("Failed to resolve a known locale"))]
+    Locale {},
+
+    #[snafu(display("Failed to resolve a known case"))]
+    Case {},
+
+    #[snafu(display("Failed to resolve a known style guide"))]
+    StyleGuide {},
+}
+
+// Clap CLI errors are reported using the Debug trait, but Snafu sets up the Display trait.
+// So we delegate. c.f. https://github.com/shepmaster/snafu/issues/110
+impl std::fmt::Debug for Error {
+    fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
+        std::fmt::Display::fmt(self, fmt)
+    }
+}
+
+type Result<T, E = Error> = std::result::Result<T, E>;
+
+fn main() -> Result<()> {
+    let version = option_env!("VERGEN_GIT_DESCRIBE").unwrap_or_else(|| env!("CARGO_PKG_VERSION"));
+    let app = Cli::command().version(version);
+    let matches = app.get_matches();
+    let locale = matches.get_one::<Locale>("locale").context(LocaleSnafu)?;
+    let case = matches
+        .get_one::<Case>("case")
+        .context(CaseSnafu)?
+        .to_owned();
+    let style = matches
+        .get_one::<StyleGuide>("style")
+        .context(StyleGuideSnafu)?
+        .to_owned();
+    match matches.contains_id("input") {
+        true => {
+            let input: Vec<String> = matches
+                .get_many::<String>("input")
+                .context(InputSnafu)?
+                .cloned()
+                .collect();
+            let input: Vec<String> = vec![input.join(" ")];
+            process(input.iter().map(|ln| ln.to_string()), *locale, case, style);
+        }
+        false => process(
+            io::stdin().lock().lines().map(|ln| ln.unwrap()),
+            *locale,
+            case,
+            style,
+        ),
+    }
+    Ok(())
+}
+
+fn process<I: IntoIterator<Item = String>>(
+    strings: I,
+    locale: Locale,
+    case: Case,
+    style: StyleGuide,
+) {
+    for string in strings {
+        let output = match case {
+            Case::Title => titlecase(string, locale, style),
+            Case::Lower => lowercase(string, locale),
+            Case::Upper => uppercase(string, locale),
+            Case::Sentence => sentencecase(string, locale),
+            _ => unreachable!(),
+        };
+        println!("{output}")
+    }
+}

decasify-0.8.0/src/cli.rs

@@ -0,0 +1,56 @@
+// SPDX-FileCopyrightText: © 2023 Caleb Maclennan <caleb@alerque.com>
+// SPDX-License-Identifier: LGPL-3.0-only
+
+#[cfg(build)]
+use crate::{Case, Locale, StyleGuide};
+
+use clap::{builder, Parser};
+use strum::VariantNames;
+
+#[macro_export]
+macro_rules! clap_enum_variants {
+    ($e: ty) => {{
+        use builder::TypedValueParser;
+        builder::PossibleValuesParser::new(<$e>::VARIANTS).map(|s| s.parse::<$e>().unwrap())
+    }};
+}
+
+/// Convert prose strings to other cases following locale specific rule sets.
+///
+/// Can convert input in any supported language from any case to any other case.
+#[derive(Parser, Debug)]
+#[clap(author, bin_name = "decasify")]
+pub struct Cli {
+    /// The locale of the input text
+    ///
+    /// Used to identify what language-specific handling needs to be done. This can affect how
+    /// individual Unicode characters are coveted to other cases as well as change which style
+    /// guides are considered.
+    #[clap(short, long, default_value_t, ignore_case = true, value_parser = clap_enum_variants!(Locale))]
+    pub locale: Locale,
+
+    /// The desired output case
+    ///
+    /// What case to convert to. Note the output *can* be affected by the input case, so in some
+    /// cases (pun intended) you may need to to either process twice or avoid doing so depending on
+    /// the expected result. For example title-casing in some English styles tries to preserve
+    /// capitalized acronyms, but lower-casing does not. First converting to lower-case then to
+    /// title-case would give a different result than directly to title-case.
+    #[clap(short, long, default_value_t, ignore_case = true, value_parser = clap_enum_variants!(Case))]
+    pub case: Case,
+
+    /// Proffered style guide
+    ///
+    /// For languages with more than one style guide, this picks which set of guidelines to follow.
+    /// Each language will have a default (typically the one we have the most robust implementation
+    /// for or implemented first).
+    #[clap(short, long, default_value_t, ignore_case = true, value_parser = clap_enum_variants!(StyleGuide))]
+    pub style: StyleGuide,
+
+    /// The input string or strings (note STDIN also accepted)
+    ///
+    /// Note that all input arguments are processed together joined with a space, and STDIN streams
+    /// are processed line by line. This can effect the output, for example if using sentence case
+    /// the input should be on a single line, not broken across several.
+    pub input: Vec<String>,
+}

{decasify-0.7.6 → decasify-0.8.0}/src/content.rs

@@ -1,9 +1,10 @@
 // SPDX-FileCopyrightText: © 2023 Caleb Maclennan <caleb@alerque.com>
 // SPDX-License-Identifier: LGPL-3.0-only
 
-use crate::types::Result;
 use regex::Regex;
-use std::{borrow::Cow, error, fmt, fmt::Display, str::FromStr};
+use std::{borrow::Cow, fmt, fmt::Display, str::FromStr};
+
+use snafu::prelude::*;
 
 #[derive(Clone, Debug, PartialEq)]
 #[non_exhaustive]
@@ -12,12 +13,28 @@ pub enum Segment {
     Word(String),
 }
 
-#[derive(Debug, Clone)]
+#[derive(Clone, Debug)]
 #[non_exhaustive]
 pub struct Chunk {
     pub segments: Vec<Segment>,
 }
 
+#[derive(Snafu)]
+pub enum Error {
+    #[snafu(display("Unable to cast str to Chunk"))]
+    StrToChunk {},
+}
+
+// Clap CLI errors are reported using the Debug trait, but Snafu sets up the Display trait.
+// So we delegate. c.f. https://github.com/shepmaster/snafu/issues/110
+impl std::fmt::Debug for Error {
+    fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
+        std::fmt::Display::fmt(self, fmt)
+    }
+}
+
+pub type Result<T, E = Error> = std::result::Result<T, E>;
+
 fn split_chunk(s: &str) -> Chunk {
     let mut segments: Vec<Segment> = Vec::new();
     let captures = Regex::new(r"(?<separator>\p{Whitespace}+)|(?<word>\P{Whitespace}+)").unwrap();
@@ -56,7 +73,7 @@ impl From<&Cow<'_, str>> for Chunk {
 }
 
 impl FromStr for Chunk {
-    type Err = Box<dyn error::Error>;
+    type Err = Error;
     fn from_str(s: &str) -> Result<Self> {
         Ok(split_chunk(s))
     }