Add clap feature for cargo-gpu library

Author: tuguzT

crates/cargo-gpu-cli/Cargo.toml

@@ -14,7 +14,7 @@ name = "cargo-gpu"
 path = "src/main.rs"
 
 [dependencies]
-cargo-gpu = { path = "../cargo-gpu" }
+cargo-gpu = { path = "../cargo-gpu", features = ["clap"] }
 clap.workspace = true
 log.workspace = true
 env_logger.workspace = true

crates/cargo-gpu/Cargo.toml

@@ -11,9 +11,9 @@ license.workspace = true
 [dependencies]
 cargo_metadata.workspace = true
 anyhow.workspace = true
-spirv-builder = { workspace = true, features = ["clap", "watch"] }
+spirv-builder = { workspace = true, features = ["watch"] }
 legacy_target_specs.workspace = true
-clap.workspace = true
+clap = { workspace = true, optional = true }
 directories.workspace = true
 log.workspace = true
 relative-path.workspace = true
@@ -28,5 +28,9 @@ test-log.workspace = true
 cargo_metadata = { workspace = true, features = ["builder"] }
 cargo-util-schemas.workspace = true
 
+[features]
+# Enables `clap` support for public structs
+clap = ["dep:clap", "spirv-builder/clap"]
+
 [lints]
 workspace = true

crates/cargo-gpu/src/build.rs

@@ -11,23 +11,24 @@ use std::io::Write as _;
 use std::path::PathBuf;
 
 /// Args for just a build
-#[derive(clap::Parser, Debug, Clone, serde::Deserialize, serde::Serialize)]
+#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)]
+#[cfg_attr(feature = "clap", derive(clap::Parser))]
 pub struct BuildArgs {
     /// Path to the output directory for the compiled shaders.
-    #[clap(long, short, default_value = "./")]
+    #[cfg_attr(feature = "clap", clap(long, short, default_value = "./"))]
     pub output_dir: PathBuf,
 
     /// Watch the shader crate directory and automatically recompile on changes.
-    #[clap(long, short, action)]
+    #[cfg_attr(feature = "clap", clap(long, short, action))]
     pub watch: bool,
 
     /// the flattened [`SpirvBuilder`]
-    #[clap(flatten)]
+    #[cfg_attr(feature = "clap", clap(flatten))]
     #[serde(flatten)]
     pub spirv_builder: SpirvBuilder,
 
     ///Renames the manifest.json file to the given name
-    #[clap(long, short, default_value = "manifest.json")]
+    #[cfg_attr(feature = "clap", clap(long, short, default_value = "manifest.json"))]
     pub manifest_file: String,
 }
 
@@ -44,14 +45,15 @@ impl Default for BuildArgs {
 }
 
 /// `cargo build` subcommands
-#[derive(Clone, clap::Parser, Debug, serde::Deserialize, serde::Serialize)]
+#[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
+#[cfg_attr(feature = "clap", derive(clap::Parser))]
 pub struct Build {
     /// CLI args for install the `rust-gpu` compiler and components
-    #[clap(flatten)]
+    #[cfg_attr(feature = "clap", clap(flatten))]
     pub install: Install,
 
     /// CLI args for configuring the build of the shader
-    #[clap(flatten)]
+    #[cfg_attr(feature = "clap", clap(flatten))]
     pub build: BuildArgs,
 }
 
@@ -175,6 +177,8 @@ impl Build {
 
 #[cfg(test)]
 mod test {
+    #![cfg(feature = "clap")]
+
     use clap::Parser as _;
 
     use crate::{Cli, Command};

crates/cargo-gpu/src/config.rs

@@ -1,4 +1,7 @@
 //! Manage and merge the various sources of config: shader crate's `Cargo.toml`(s) and CLI args.
+
+#![cfg(feature = "clap")]
+
 use anyhow::Context as _;
 use clap::Parser as _;
 

crates/cargo-gpu/src/dump_usage.rs

@@ -1,6 +1,8 @@
 //! Convenience function for internal use. Dumps all the CLI usage instructions. Useful for
 //! updating the README.
 
+#![cfg(feature = "clap")]
+
 use crate::{user_output, Cli};
 
 /// main dump usage function

crates/cargo-gpu/src/install.rs

@@ -61,11 +61,15 @@ impl InstalledBackend {
     clippy::struct_excessive_bools,
     reason = "cmdline args have many bools"
 )]
-#[derive(clap::Parser, Debug, Clone, serde::Deserialize, serde::Serialize)]
+#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)]
+#[cfg_attr(feature = "clap", derive(clap::Parser))]
 #[non_exhaustive]
 pub struct Install {
     /// Directory containing the shader crate to compile.
-    #[clap(long, alias("package"), short_alias('p'), default_value = "./")]
+    #[cfg_attr(
+        feature = "clap",
+        clap(long, alias("package"), short_alias('p'), default_value = "./")
+    )]
     #[serde(alias = "package")]
     pub shader_crate: PathBuf,
 
@@ -75,30 +79,30 @@ pub struct Install {
     )]
     /// Source of `spirv-builder` dependency
     /// Eg: "https://github.com/Rust-GPU/rust-gpu"
-    #[clap(long)]
+    #[cfg_attr(feature = "clap", clap(long))]
     pub spirv_builder_source: Option<String>,
 
     /// Version of `spirv-builder` dependency.
     /// * If `--spirv-builder-source` is not set, then this is assumed to be a crates.io semantic
     ///   version such as "0.9.0".
     /// * If `--spirv-builder-source` is set, then this is assumed to be a Git "commitsh", such
     ///   as a Git commit hash or a Git tag, therefore anything that `git checkout` can resolve.
-    #[clap(long, verbatim_doc_comment)]
+    #[cfg_attr(feature = "clap", clap(long, verbatim_doc_comment))]
     pub spirv_builder_version: Option<String>,
 
     /// Force `rustc_codegen_spirv` to be rebuilt.
-    #[clap(long)]
+    #[cfg_attr(feature = "clap", clap(long))]
     pub rebuild_codegen: bool,
 
     /// Assume "yes" to "Install Rust toolchain: [y/n]" prompt.
     ///
     /// Defaults to `false` in cli, `true` in [`Default`]
-    #[clap(long, action)]
+    #[cfg_attr(feature = "clap", clap(long, action))]
     pub auto_install_rust_toolchain: bool,
 
     /// Clear target dir of `rustc_codegen_spirv` build after a successful build, saves about
     /// 200MiB of disk space.
-    #[clap(long = "no-clear-target", default_value = "true", action = clap::ArgAction::SetFalse)]
+    #[cfg_attr(feature = "clap", clap(long = "no-clear-target", default_value = "true", action = clap::ArgAction::SetFalse))]
     pub clear_target: bool,
 
     /// There is a tricky situation where a shader crate that depends on workspace config can have
@@ -122,7 +126,7 @@ pub struct Install {
     /// way source URLs are encoded. See these PRs for more details:
     ///   * <https://github.com/rust-lang/cargo/pull/12280>
     ///   * <https://github.com/rust-lang/cargo/pull/14595>
-    #[clap(long, action, verbatim_doc_comment)]
+    #[cfg_attr(feature = "clap", clap(long, action, verbatim_doc_comment))]
     pub force_overwrite_lockfiles_v4_to_v3: bool,
 }
 

crates/cargo-gpu/src/lib.rs

@@ -52,10 +52,12 @@
 
 use anyhow::Context as _;
 
-use crate::dump_usage::dump_full_usage_for_readme;
 use build::Build;
 use show::Show;
 
+#[cfg(feature = "clap")]
+use crate::dump_usage::dump_full_usage_for_readme;
+
 mod build;
 mod config;
 mod dump_usage;
@@ -97,7 +99,7 @@ macro_rules! user_output {
 }
 
 /// All of the available subcommands for `cargo gpu`
-#[derive(clap::Subcommand)]
+#[cfg_attr(feature = "clap", derive(clap::Subcommand))]
 #[non_exhaustive]
 pub enum Command {
     /// Install rust-gpu compiler artifacts.
@@ -112,6 +114,7 @@ pub enum Command {
     /// A hidden command that can be used to recursively print out all the subcommand help messages:
     ///   `cargo gpu dump-usage`
     /// Useful for updating the README.
+    #[cfg(feature = "clap")]
     #[clap(hide(true))]
     DumpUsage,
 }
@@ -122,6 +125,7 @@ impl Command {
     /// # Errors
     /// Any errors during execution, usually printed to the user
     #[inline]
+    #[cfg(feature = "clap")]
     pub fn run(&self, env_args: Vec<String>) -> anyhow::Result<()> {
         match &self {
             Self::Install(install) => {
@@ -149,6 +153,7 @@ impl Command {
                 command.run()?;
             }
             Self::Show(show) => show.run()?,
+            #[cfg(feature = "clap")]
             Self::DumpUsage => dump_full_usage_for_readme()?,
         }
 
@@ -157,12 +162,15 @@ impl Command {
 }
 
 /// the Cli struct representing the main cli
-#[derive(clap::Parser)]
-#[clap(author, version, about, subcommand_required = true)]
+#[cfg_attr(feature = "clap", derive(clap::Parser))]
+#[cfg_attr(
+    feature = "clap",
+    clap(author, version, about, subcommand_required = true)
+)]
 #[non_exhaustive]
 pub struct Cli {
     /// The command to run.
-    #[clap(subcommand)]
+    #[cfg_attr(feature = "clap", clap(subcommand))]
     pub command: Command,
 }
 

crates/cargo-gpu/src/metadata.rs

@@ -1,5 +1,7 @@
 //! Get config from the shader crate's `Cargo.toml` `[*.metadata.rust-gpu.*]`
 
+#![cfg(feature = "clap")]
+
 use cargo_metadata::MetadataCommand;
 use serde_json::Value;
 

crates/cargo-gpu/src/show.rs

@@ -8,15 +8,18 @@ use std::fs;
 use std::path::Path;
 
 /// Show the computed source of the spirv-std dependency.
-#[derive(Clone, Debug, clap::Parser)]
+#[derive(Clone, Debug)]
+#[cfg_attr(feature = "clap", derive(clap::Parser))]
 pub struct SpirvSourceDep {
     /// The location of the shader-crate to inspect to determine its spirv-std dependency.
-    #[clap(long, default_value = "./")]
+    #[cfg_attr(feature = "clap", clap(long, default_value = "./"))]
     pub shader_crate: std::path::PathBuf,
 }
 
 /// Different tidbits of information that can be queried at the command line.
-#[derive(Clone, Debug, clap::Subcommand)]
+#[derive(Clone, Debug)]
+#[cfg_attr(feature = "clap", derive(clap::Subcommand))]
+#[cfg_attr(not(feature = "clap"), allow(dead_code))]
 pub enum Info {
     /// Displays the location of the cache directory
     CacheDirectory,
@@ -32,10 +35,10 @@ pub enum Info {
 }
 
 /// `cargo gpu show`
-#[derive(clap::Parser)]
+#[cfg_attr(feature = "clap", derive(clap::Parser))]
 pub struct Show {
     /// Display information about rust-gpu
-    #[clap(subcommand)]
+    #[cfg_attr(feature = "clap", clap(subcommand))]
     command: Info,
 }
 

crates/cargo-gpu/src/test.rs

@@ -4,6 +4,7 @@
 use crate::cache_dir;
 use std::io::Write as _;
 
+#[cfg_attr(not(feature = "clap"), allow(dead_code))]
 fn copy_dir_all(
     src: impl AsRef<std::path::Path>,
     dst: impl AsRef<std::path::Path>,
@@ -26,12 +27,14 @@ pub fn shader_crate_template_path() -> std::path::PathBuf {
     project_base.join("../shader-crate-template")
 }
 
+#[cfg_attr(not(feature = "clap"), allow(dead_code))]
 pub fn shader_crate_test_path() -> std::path::PathBuf {
     let shader_crate_path = crate::cache_dir().unwrap().join("shader_crate");
     copy_dir_all(shader_crate_template_path(), shader_crate_path.clone()).unwrap();
     shader_crate_path
 }
 
+#[cfg_attr(not(feature = "clap"), allow(dead_code))]
 pub fn overwrite_shader_cargo_toml(shader_crate_path: &std::path::Path) -> std::fs::File {
     let cargo_toml = shader_crate_path.join("Cargo.toml");
     let mut file = std::fs::OpenOptions::new()
@@ -44,6 +47,7 @@ pub fn overwrite_shader_cargo_toml(shader_crate_path: &std::path::Path) -> std::
     file
 }
 
+#[cfg_attr(not(feature = "clap"), allow(dead_code))]
 pub fn tests_teardown() {
     let cache_dir = cache_dir().unwrap();
     if !cache_dir.exists() {