Merge pull request #195 from matiaskorhonen/cli-feature

CLI feature

Author: matiaskorhonen

Cargo.toml

@@ -22,16 +22,25 @@ pre-release-replacements = [
   {file="CHANGELOG.md", search="<!-- next-url -->", replace="<!-- next-url -->\n[Unreleased]: https://github.com/matiaskorhonen/paper-age/compare/{{tag_name}}...HEAD", exactly=1},
 ]
 
+[features]
+default = ["cli"]
+cli = ["dep:clap", "dep:clap-verbosity-flag", "dep:exitcode", "dep:rpassword", "dep:env_logger"]
+
+[[bin]]
+name = "paper-age"
+path = "src/main.rs"
+required-features = ["cli"]
+
 [dependencies]
 age = { version = "0.11.2", features = ["armor"] }
-clap = { version = "4.5", features = ["derive"] }
-clap-verbosity-flag = "3.0"
-exitcode = "1.1.2"
+clap = { version = "4.5", features = ["derive"], optional = true }
+clap-verbosity-flag = { version = "3.0", optional = true }
+exitcode = { version = "1.1.2", optional = true }
 printpdf = { version = "0.9.1", features = ["text_layout"], default-features = false }
 qrcode = { version = "0.14.1", default-features = false }
-rpassword = "7"
+rpassword = { version = "7", optional = true }
 log = "0.4"
-env_logger = "0.11"
+env_logger = { version = "0.11", optional = true }
 
 [dev-dependencies]
 assert_cmd = "2.1"

build.rs

@@ -1,46 +1,55 @@
+#[cfg(feature = "cli")]
 use clap::CommandFactory;
+#[cfg(feature = "cli")]
 use clap_complete::{generate_to, shells::Shell};
+#[cfg(feature = "cli")]
 use path_absolutize::*;
 
+#[cfg(feature = "cli")]
 #[path = "src/cli.rs"]
 mod cli;
 
+#[cfg(feature = "cli")]
 #[path = "src/page.rs"]
 pub mod page;
 
 fn main() -> std::io::Result<()> {
-    let out_dir =
-        std::path::PathBuf::from(std::env::var_os("OUT_DIR").ok_or(std::io::ErrorKind::NotFound)?);
-    let mut cmd = cli::Args::command();
-
-    let man = clap_mangen::Man::new(cmd.clone());
-    let mut buffer: Vec<u8> = Default::default();
-    man.render(&mut buffer)?;
-
-    // Create a man directory at the same level as the binary, even though build
-    // scripts shouldn't
-    let man_dir = &out_dir.join("../../../man");
-    let absolute_man_dir = man_dir.absolutize()?;
-    std::fs::create_dir_all(&absolute_man_dir)?;
-    let man_path = absolute_man_dir.join("paper-age.1");
-    std::fs::write(man_path, buffer)?;
-
-    // Create a completion directory the same level as the binary
-    let completion_dir = out_dir.join("../../../completion");
-    let absolute_completion_dir = completion_dir.absolutize()?;
-    std::fs::create_dir_all(absolute_completion_dir.clone())?;
-    for shell in [Shell::Bash, Shell::Fish, Shell::Zsh] {
-        generate_to(
-            shell,
-            &mut cmd,
-            "paper-age",
-            absolute_completion_dir.as_ref(),
-        )?;
+    #[cfg(feature = "cli")]
+    {
+        let out_dir = std::path::PathBuf::from(
+            std::env::var_os("OUT_DIR").ok_or(std::io::ErrorKind::NotFound)?,
+        );
+        let mut cmd = cli::Args::command();
+
+        let man = clap_mangen::Man::new(cmd.clone());
+        let mut buffer: Vec<u8> = Default::default();
+        man.render(&mut buffer)?;
+
+        // Create a man directory at the same level as the binary, even though build
+        // scripts shouldn't
+        let man_dir = &out_dir.join("../../../man");
+        let absolute_man_dir = man_dir.absolutize()?;
+        std::fs::create_dir_all(&absolute_man_dir)?;
+        let man_path = absolute_man_dir.join("paper-age.1");
+        std::fs::write(man_path, buffer)?;
+
+        // Create a completion directory the same level as the binary
+        let completion_dir = out_dir.join("../../../completion");
+        let absolute_completion_dir = completion_dir.absolutize()?;
+        std::fs::create_dir_all(absolute_completion_dir.clone())?;
+        for shell in [Shell::Bash, Shell::Fish, Shell::Zsh] {
+            generate_to(
+                shell,
+                &mut cmd,
+                "paper-age",
+                absolute_completion_dir.as_ref(),
+            )?;
+        }
+
+        // Re-run if the cli or page files change
+        println!("cargo:rerun-if-changed=src/cli.rs");
+        println!("cargo:rerun-if-changed=src/page.rs");
     }
 
-    // Re-run if the cli or page files change
-    println!("cargo:rerun-if-changed=src/cli.rs");
-    println!("cargo:rerun-if-changed=src/page.rs");
-
     Ok(())
 }

src/lib.rs

@@ -1,4 +1,5 @@
 pub mod builder;
+#[cfg(feature = "cli")]
 pub mod cli;
 pub mod convenience;
 pub mod encryption;

src/main.rs

@@ -13,14 +13,10 @@ use std::{
 
 use age::secrecy::{ExposeSecret, SecretString};
 use clap::Parser;
+use paper_age::{builder, cli, encryption};
 use qrcode::types::QrError;
 use rpassword::prompt_password;
 
-pub mod builder;
-pub mod cli;
-pub mod encryption;
-pub mod page;
-
 #[macro_use]
 extern crate log;
 

src/page.rs

@@ -75,7 +75,8 @@ impl Default for PageDimensions {
     }
 }
 
-#[derive(clap::ValueEnum, Clone, Debug, PartialEq, Eq)]
+#[derive(Clone, Debug, PartialEq, Eq)]
+#[cfg_attr(feature = "cli", derive(clap::ValueEnum))]
 pub enum PageSize {
     A4,
     Letter,

tests/cli.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "cli")]
+
 use assert_cmd::cargo::cargo_bin_cmd;
 use assert_fs::prelude::*;
 use predicates::prelude::*;