Merge pull request #135 from BenWiederhake/dev-complete-visibility

tertsdiepraam · web-flow · commit 985af4aa3345 · 2025-04-16T08:58:06.000+02:00
Make 'complete' available to procmacro's output by conversion to module
diff --git a/Cargo.toml b/Cargo.toml
@@ -10,13 +10,13 @@ repository = "https://github.com/uutils/uutils-args"
 readme = "README.md"
 
 [dependencies]
-uutils-args-derive = { version = "0.1.0", path = "derive" }
-uutils-args-complete = { version = "0.1.0", path = "complete" }
-strsim = "0.11.1"
 lexopt = "0.3.0"
+roff = "0.2.1"
+strsim = "0.11.1"
+uutils-args-derive = { version = "0.1.0", path = "derive" }
 
 [features]
 parse-is-complete = []
 
 [workspace]
-members = ["derive", "complete"]
+members = ["derive"]
diff --git a/complete/Cargo.toml b/complete/Cargo.toml
diff --git a/complete/LICENSE b/complete/LICENSE
diff --git a/derive/src/complete.rs b/derive/src/complete.rs
@@ -49,11 +49,15 @@ pub fn complete(args: &[Argument], file: &Option<String>) -> TokenStream {
             .map(|Flag { flag, value }| {
                 let flag = flag.to_string();
                 let value = match value {
-                    Value::No => quote!(::uutils_args_complete::Value::No),
-                    Value::Optional(name) => quote!(::uutils_args_complete::Value::Optional(#name)),
-                    Value::Required(name) => quote!(::uutils_args_complete::Value::Required(#name)),
+                    Value::No => quote!(::uutils_args::complete::Value::No),
+                    Value::Optional(name) => {
+                        quote!(::uutils_args::complete::Value::Optional(#name))
+                    }
+                    Value::Required(name) => {
+                        quote!(::uutils_args::complete::Value::Required(#name))
+                    }
                 };
-                quote!(::uutils_args_complete::Flag {
+                quote!(::uutils_args::complete::Flag {
                     flag: #flag,
                     value: #value
                 })
@@ -64,11 +68,15 @@ pub fn complete(args: &[Argument], file: &Option<String>) -> TokenStream {
             .iter()
             .map(|Flag { flag, value }| {
                 let value = match value {
-                    Value::No => quote!(::uutils_args_complete::Value::No),
-                    Value::Optional(name) => quote!(::uutils_args_complete::Value::Optional(#name)),
-                    Value::Required(name) => quote!(::uutils_args_complete::Value::Required(#name)),
+                    Value::No => quote!(::uutils_args::complete::Value::No),
+                    Value::Optional(name) => {
+                        quote!(::uutils_args::complete::Value::Optional(#name))
+                    }
+                    Value::Required(name) => {
+                        quote!(::uutils_args::complete::Value::Required(#name))
+                    }
                 };
-                quote!(::uutils_args_complete::Flag {
+                quote!(::uutils_args::complete::Flag {
                     flag: #flag,
                     value: #value
                 })
@@ -81,7 +89,7 @@ pub fn complete(args: &[Argument], file: &Option<String>) -> TokenStream {
         };
 
         arg_specs.push(quote!(
-            ::uutils_args_complete::Arg {
+            ::uutils_args::complete::Arg {
                 short: vec![#(#short),*],
                 long: vec![#(#long),*],
                 help: #help,
@@ -90,7 +98,7 @@ pub fn complete(args: &[Argument], file: &Option<String>) -> TokenStream {
         ))
     }
 
-    quote!(::uutils_args_complete::Command {
+    quote!(::uutils_args::complete::Command {
         name: option_env!("CARGO_BIN_NAME").unwrap_or(env!("CARGO_PKG_NAME")),
         summary: #summary,
         after_options: #after_options,
diff --git a/derive/src/lib.rs b/derive/src/lib.rs
@@ -117,7 +117,7 @@ pub fn arguments(input: TokenStream) -> TokenStream {
                 #version_string
             }
 
-            fn complete() -> ::uutils_args_complete::Command<'static> {
+            fn complete() -> ::uutils_args::complete::Command<'static> {
                 use ::uutils_args::Value;
                 #complete_command
             }
@@ -212,9 +212,9 @@ pub fn value(input: TokenStream) -> TokenStream {
                 })
             }
 
-            fn value_hint() -> ::uutils_args_complete::ValueHint {
+            fn value_hint() -> ::uutils_args::complete::ValueHint {
                 let keys: [&str; #keys_len] = [#(#all_keys),*];
-                ::uutils_args_complete::ValueHint::Strings(
+                ::uutils_args::complete::ValueHint::Strings(
                     keys
                         .into_iter()
                         .map(ToString::to_string)
diff --git a/src/complete/bash.rs b/src/complete/bash.rs
@@ -1,7 +1,7 @@
 // For the full copyright and license information, please view the LICENSE
 // file that was distributed with this source code.
 
-use crate::{Command, Flag};
+use crate::complete::{Command, Flag};
 
 /// Create completion script for `bash`
 ///
@@ -35,7 +35,7 @@ pub fn render(c: &Command) -> String {
 #[cfg(test)]
 mod test {
     use super::render;
-    use crate::{Arg, Command, Flag, Value};
+    use crate::complete::{Arg, Command, Flag, Value};
 
     #[test]
     fn simple() {
diff --git a/src/complete/fish.rs b/src/complete/fish.rs
@@ -1,7 +1,7 @@
 // For the full copyright and license information, please view the LICENSE
 // file that was distributed with this source code.
 
-use crate::{Command, Flag, ValueHint};
+use crate::complete::{Command, Flag, ValueHint};
 
 /// Create completion script for `fish`
 ///
@@ -45,7 +45,7 @@ fn render_value_hint(value: &ValueHint) -> String {
 #[cfg(test)]
 mod test {
     use super::render;
-    use crate::{Arg, Command, Flag, Value, ValueHint};
+    use crate::complete::{Arg, Command, Flag, Value, ValueHint};
 
     #[test]
     fn short() {
diff --git a/src/complete/man.rs b/src/complete/man.rs
@@ -1,7 +1,7 @@
 // For the full copyright and license information, please view the LICENSE
 // file that was distributed with this source code.
 
-use crate::{Command, Flag, Value};
+use crate::complete::{Command, Flag, Value};
 use roff::{Roff, bold, italic, roman};
 
 pub fn render(c: &Command) -> String {
diff --git a/src/complete/md.rs b/src/complete/md.rs
@@ -1,7 +1,7 @@
 // For the full copyright and license information, please view the LICENSE
 // file that was distributed with this source code.
 
-use crate::{Command, Flag, Value};
+use crate::complete::{Command, Flag, Value};
 
 /// Render command to a markdown file for mdbook
 pub fn render(c: &Command) -> String {
diff --git a/src/complete/mod.rs b/src/complete/mod.rs
diff --git a/src/complete/nu.rs b/src/complete/nu.rs
@@ -1,7 +1,7 @@
 // For the full copyright and license information, please view the LICENSE
 // file that was distributed with this source code.
 
-use crate::{Arg, Command, Flag, Value, ValueHint};
+use crate::complete::{Arg, Command, Flag, Value, ValueHint};
 use std::fmt::Write;
 
 /// Create completion script for `nushell`
diff --git a/src/complete/zsh.rs b/src/complete/zsh.rs
@@ -1,7 +1,7 @@
 // For the full copyright and license information, please view the LICENSE
 // file that was distributed with this source code.
 
-use crate::{Arg, Command, Flag, Value, ValueHint};
+use crate::complete::{Arg, Command, Flag, Value, ValueHint};
 
 /// Create completion script for `zsh`
 pub fn render(c: &Command) -> String {
diff --git a/src/lib.rs b/src/lib.rs
@@ -9,6 +9,7 @@
 //!
 #![doc = include_str!("../README.md")]
 
+pub mod complete;
 mod error;
 pub mod internal;
 pub mod positional;
@@ -103,7 +104,7 @@ pub trait Arguments: Sized {
         Ok(())
     }
 
-    fn complete() -> uutils_args_complete::Command<'static>;
+    fn complete() -> complete::Command<'static>;
 }
 
 /// An iterator over arguments.
@@ -197,7 +198,7 @@ pub trait Options<Arg: Arguments>: Sized {
     }
 
     fn complete(shell: &str) -> String {
-        uutils_args_complete::render(&Arg::complete(), shell)
+        complete::render(&Arg::complete(), shell)
     }
 }
 
diff --git a/src/value.rs b/src/value.rs
@@ -1,12 +1,12 @@
 // For the full copyright and license information, please view the LICENSE
 // file that was distributed with this source code.
 
+use crate::complete::ValueHint;
 use crate::error::{Error, ErrorKind};
 use std::{
     ffi::{OsStr, OsString},
     path::PathBuf,
 };
-use uutils_args_complete::ValueHint;
 
 pub type ValueResult<T> = Result<T, Box<dyn std::error::Error + Send + Sync + 'static>>;
 
@@ -95,7 +95,7 @@ where
         Ok(Some(T::from_value(value)?))
     }
 
-    fn value_hint() -> uutils_args_complete::ValueHint {
+    fn value_hint() -> ValueHint {
         T::value_hint()
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ pub fn arguments(input: TokenStream) -> TokenStream {`
`117`	`117`	`#version_string`
`118`	`118`	`}`
`119`	`119`
`120`		`- fn complete() -> ::uutils_args_complete::Command<'static> {`
	`120`	`+ fn complete() -> ::uutils_args::complete::Command<'static> {`
`121`	`121`	`use ::uutils_args::Value;`
`122`	`122`	`#complete_command`
`123`	`123`	`}`
`@@ -212,9 +212,9 @@ pub fn value(input: TokenStream) -> TokenStream {`
`212`	`212`	`})`
`213`	`213`	`}`
`214`	`214`
`215`		`- fn value_hint() -> ::uutils_args_complete::ValueHint {`
	`215`	`+ fn value_hint() -> ::uutils_args::complete::ValueHint {`
`216`	`216`	`let keys: [&str; #keys_len] = [#(#all_keys),*];`
`217`		`- ::uutils_args_complete::ValueHint::Strings(`
	`217`	`+ ::uutils_args::complete::ValueHint::Strings(`
`218`	`218`	`keys`
`219`	`219`	`.into_iter()`
`220`	`220`	`.map(ToString::to_string)`