Merge pull request #131 from BenWiederhake/dev-remove-complete-featureflag

tertsdiepraam · web-flow · commit 48aae1944424 · 2025-04-15T09:26:40.000+02:00
remove 'complete' feature flag, make it unconditional
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -20,7 +20,7 @@ jobs:
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@stable
       - uses: Swatinem/rust-cache@v2
-      - run: cargo test --features complete --workspace
+      - run: cargo test --workspace
 
   rustfmt:
     name: Rustfmt
@@ -48,7 +48,7 @@ jobs:
           components: clippy
       - uses: Swatinem/rust-cache@v2
       - name: Clippy check
-        run: cargo clippy --all-targets --features complete --workspace -- -D warnings
+        run: cargo clippy --all-targets --workspace -- -D warnings
 
   docs:
     name: Docs
diff --git a/Cargo.toml b/Cargo.toml
@@ -11,13 +11,12 @@ readme = "README.md"
 
 [dependencies]
 uutils-args-derive = { version = "0.1.0", path = "derive" }
-uutils-args-complete = { version = "0.1.0", path = "complete", optional = true }
+uutils-args-complete = { version = "0.1.0", path = "complete" }
 strsim = "0.11.1"
 lexopt = "0.3.0"
 
 [features]
-parse-is-complete = ["complete"]
-complete = ["uutils-args-complete"]
+parse-is-complete = []
 
 [workspace]
 members = ["derive", "complete"]
diff --git a/Justfile b/Justfile
@@ -1,5 +1,5 @@
 check:
     cargo fmt --all
-    cargo test --features complete
-    cargo clippy --all-targets --features complete  --workspace -- -D warnings
+    cargo test
+    cargo clippy --all-targets  --workspace -- -D warnings
     cargo doc
diff --git a/derive/src/lib.rs b/derive/src/lib.rs
@@ -117,7 +117,6 @@ pub fn arguments(input: TokenStream) -> TokenStream {
                 #version_string
             }
 
-            #[cfg(feature = "complete")]
             fn complete() -> ::uutils_args_complete::Command<'static> {
                 use ::uutils_args::Value;
                 #complete_command
@@ -213,7 +212,6 @@ pub fn value(input: TokenStream) -> TokenStream {
                 })
             }
 
-            #[cfg(feature = "complete")]
             fn value_hint() -> ::uutils_args_complete::ValueHint {
                 let keys: [&str; #keys_len] = [#(#all_keys),*];
                 ::uutils_args_complete::ValueHint::Strings(
diff --git a/docs/guide/completions.md b/docs/guide/completions.md
@@ -39,7 +39,7 @@ The `[shell]` value here can be `fish`, `zsh`, `nu`, `sh`, `bash`, `csh`, `elvis
 
 Additionally, the values `man` or `md` can be passed to generate man pages and markdown documentation (for `mdbook`).
 
-If you do not want to hijack the [`Options::parse`](crate::Options::parse) function, you can instead enable the `complete` feature flag. This makes the `Options::complete` function available in addition to the [`Options::parse`](crate::Options::parse) function to generate a `String` with the completion.
+If you do not want to hijack the [`Options::parse`](crate::Options::parse) function, you can instead use the `Options::complete` function available in addition to the [`Options::parse`](crate::Options::parse) function to generate a `String` with the completion.
 
 <div class="chapters">
 
diff --git a/src/lib.rs b/src/lib.rs
@@ -103,7 +103,6 @@ pub trait Arguments: Sized {
         Ok(())
     }
 
-    #[cfg(feature = "complete")]
     fn complete() -> uutils_args_complete::Command<'static>;
 }
 
@@ -197,7 +196,6 @@ pub trait Options<Arg: Arguments>: Sized {
         }
     }
 
-    #[cfg(feature = "complete")]
     fn complete(shell: &str) -> String {
         uutils_args_complete::render(&Arg::complete(), shell)
     }
diff --git a/src/value.rs b/src/value.rs
@@ -6,7 +6,6 @@ use std::{
     ffi::{OsStr, OsString},
     path::PathBuf,
 };
-#[cfg(feature = "complete")]
 use uutils_args_complete::ValueHint;
 
 pub type ValueResult<T> = Result<T, Box<dyn std::error::Error + Send + Sync + 'static>>;
@@ -54,7 +53,6 @@ impl std::fmt::Display for ValueError {
 pub trait Value: Sized {
     fn from_value(value: &OsStr) -> ValueResult<Self>;
 
-    #[cfg(feature = "complete")]
     fn value_hint() -> ValueHint {
         ValueHint::Unknown
     }
@@ -71,7 +69,6 @@ impl Value for PathBuf {
         Ok(PathBuf::from(value))
     }
 
-    #[cfg(feature = "complete")]
     fn value_hint() -> ValueHint {
         ValueHint::AnyPath
     }
@@ -98,7 +95,6 @@ where
         Ok(Some(T::from_value(value)?))
     }
 
-    #[cfg(feature = "complete")]
     fn value_hint() -> uutils_args_complete::ValueHint {
         T::value_hint()
     }

Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,6 @@ pub fn arguments(input: TokenStream) -> TokenStream {`
`117`	`117`	`#version_string`
`118`	`118`	`}`
`119`	`119`
`120`		`- #[cfg(feature = "complete")]`
`121`	`120`	`fn complete() -> ::uutils_args_complete::Command<'static> {`
`122`	`121`	`use ::uutils_args::Value;`
`123`	`122`	`#complete_command`
`@@ -213,7 +212,6 @@ pub fn value(input: TokenStream) -> TokenStream {`
`213`	`212`	`})`
`214`	`213`	`}`
`215`	`214`
`216`		`- #[cfg(feature = "complete")]`
`217`	`215`	`fn value_hint() -> ::uutils_args_complete::ValueHint {`
`218`	`216`	`let keys: [&str; #keys_len] = [#(#all_keys),*];`
`219`	`217`	`::uutils_args_complete::ValueHint::Strings(`
Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,6 @@ pub trait Arguments: Sized {`
`103`	`103`	`Ok(())`
`104`	`104`	`}`
`105`	`105`
`106`		`- #[cfg(feature = "complete")]`
`107`	`106`	`fn complete() -> uutils_args_complete::Command<'static>;`
`108`	`107`	`}`
`109`	`108`
`@@ -197,7 +196,6 @@ pub trait Options<Arg: Arguments>: Sized {`
`197`	`196`	`}`
`198`	`197`	`}`
`199`	`198`
`200`		`- #[cfg(feature = "complete")]`
`201`	`199`	`fn complete(shell: &str) -> String {`
`202`	`200`	`uutils_args_complete::render(&Arg::complete(), shell)`
`203`	`201`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,6 @@ use std::{`
`6`	`6`	`ffi::{OsStr, OsString},`
`7`	`7`	`path::PathBuf,`
`8`	`8`	`};`
`9`		`-#[cfg(feature = "complete")]`
`10`	`9`	`use uutils_args_complete::ValueHint;`
`11`	`10`
`12`	`11`	`pub type ValueResult<T> = Result<T, Box<dyn std::error::Error + Send + Sync + 'static>>;`
`@@ -54,7 +53,6 @@ impl std::fmt::Display for ValueError {`
`54`	`53`	`pub trait Value: Sized {`
`55`	`54`	`fn from_value(value: &OsStr) -> ValueResult<Self>;`
`56`	`55`
`57`		`- #[cfg(feature = "complete")]`
`58`	`56`	`fn value_hint() -> ValueHint {`
`59`	`57`	`ValueHint::Unknown`
`60`	`58`	`}`
`@@ -71,7 +69,6 @@ impl Value for PathBuf {`
`71`	`69`	`Ok(PathBuf::from(value))`
`72`	`70`	`}`
`73`	`71`
`74`		`- #[cfg(feature = "complete")]`
`75`	`72`	`fn value_hint() -> ValueHint {`
`76`	`73`	`ValueHint::AnyPath`
`77`	`74`	`}`
`@@ -98,7 +95,6 @@ where`
`98`	`95`	`Ok(Some(T::from_value(value)?))`
`99`	`96`	`}`
`100`	`97`
`101`		`- #[cfg(feature = "complete")]`
`102`	`98`	`fn value_hint() -> uutils_args_complete::ValueHint {`
`103`	`99`	`T::value_hint()`
`104`	`100`	`}`