Move lockfile manifest version mismatch handling out of CLI

Author: tuguzT

Cargo.lock

@@ -1,6 +1,7 @@
 [workspace]
 members = [
 	"crates/rustc_codegen_spirv-cache",
+	"crates/cargo-gpu-build",
 	"crates/cargo-gpu",
 	"crates/xtask",
 ]

Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "cargo-gpu-build"
+description = "Builder of `rust-gpu` shader crates"
+version.workspace = true
+edition.workspace = true
+repository.workspace = true
+keywords.workspace = true
+license.workspace = true
+
+[dependencies]
+rustc_codegen_spirv-cache = { path = "../rustc_codegen_spirv-cache" }
+anyhow.workspace = true
+semver.workspace = true
+log.workspace = true
+
+[lints]
+workspace = true

crates/cargo-gpu-build/Cargo.toml

@@ -0,0 +1,21 @@
+//! Rust GPU shader crate builder.
+//!
+//! This library allows you to easily compile your `rust-gpu` shaders,
+//! without requiring you to fix your entire project to a specific toolchain.
+//!
+//! # How it works
+//!
+//! This library manages installations of `rustc_codegen_spirv`
+//! using [`rustc_codegen_spirv-cache`](spirv_cache) crate.
+//!
+//! Then is uses [`spirv-builder`](spirv_builder) crate
+//! to pass the many additional parameters required to configure rustc and our codegen backend,
+//! but provide you with a toolchain-agnostic version that you may use from stable rustc.
+
+#![expect(clippy::missing_errors_doc, reason = "temporary allow this")] // TODO: remove this & fix documentation
+#![expect(clippy::pub_use, reason = "part of public API")]
+
+pub use rustc_codegen_spirv_cache as spirv_cache;
+pub use rustc_codegen_spirv_cache::spirv_builder;
+
+pub mod lockfile;

crates/cargo-gpu-build/src/lib.rs

@@ -1,26 +1,32 @@
-//! Handles lockfile version conflicts and downgrades. Stable uses lockfile v4, but rust-gpu
-//! v0.9.0 uses an old toolchain requiring v3 and will refuse to build with a v4 lockfile being
-//! present. This module takes care of warning the user and potentially downgrading the lockfile.
+//! Handles lockfile version conflicts and downgrades.
+//!
+//! Stable uses lockfile v4, but rust-gpu v0.9.0 uses an old toolchain requiring v3
+//! and will refuse to build with a v4 lockfile being present.
+//! This module takes care of warning the user and potentially downgrading the lockfile.
+
+use std::io::Write as _;
 
 use anyhow::Context as _;
-use rustc_codegen_spirv_cache::user_output;
 use semver::Version;
-use spirv_builder::query_rustc_version;
-use std::io::Write as _;
+
+use crate::{spirv_builder::query_rustc_version, spirv_cache::user_output};
 
 /// `Cargo.lock` manifest version 4 became the default in Rust 1.83.0. Conflicting manifest
 /// versions between the workspace and the shader crate, can cause problems.
 const RUST_VERSION_THAT_USES_V4_CARGO_LOCKS: Version = Version::new(1, 83, 0);
 
 /// Cargo dependency for `spirv-builder` and the rust toolchain channel.
 #[derive(Debug, Clone)]
+#[expect(clippy::module_name_repetitions, reason = "such naming is intentional")]
+#[non_exhaustive]
 pub struct LockfileMismatchHandler {
     /// `Cargo.lock`s that have had their manifest versions changed by us and need changing back.
     pub cargo_lock_files_with_changed_manifest_versions: Vec<std::path::PathBuf>,
 }
 
 impl LockfileMismatchHandler {
     /// Create instance
+    #[inline]
     pub fn new(
         shader_crate_path: &std::path::Path,
         toolchain_channel: &str,
@@ -198,9 +204,10 @@ impl LockfileMismatchHandler {
         Ok(())
     }
 
-    /// Once all install and builds have completed put their manifest versions back to how they
-    /// were.
-    pub fn revert_cargo_lock_manifest_versions(&self) -> anyhow::Result<()> {
+    /// Once all install and builds have completed put their manifest versions back
+    /// to how they were.
+    #[inline]
+    pub fn revert_cargo_lock_manifest_versions(&mut self) -> anyhow::Result<()> {
         for offending_cargo_lock in &self.cargo_lock_files_with_changed_manifest_versions {
             log::debug!("Reverting: {}", offending_cargo_lock.display());
             Self::replace_cargo_lock_manifest_version(offending_cargo_lock, "3", "4")
@@ -266,6 +273,7 @@ impl LockfileMismatchHandler {
 }
 
 impl Drop for LockfileMismatchHandler {
+    #[inline]
     fn drop(&mut self) {
         let result = self.revert_cargo_lock_manifest_versions();
         if let Err(error) = result {

crates/cargo-gpu/src/lockfile.rs renamed to crates/cargo-gpu-build/src/lockfile.rs

@@ -10,7 +10,7 @@ license.workspace = true
 default-run = "cargo-gpu"
 
 [dependencies]
-rustc_codegen_spirv-cache = { path = "../rustc_codegen_spirv-cache", default-features = false }
+cargo-gpu-build = { path = "../cargo-gpu-build", default-features = false }
 cargo_metadata.workspace = true
 anyhow.workspace = true
 spirv-builder = { workspace = true, features = ["clap", "watch"] }

crates/cargo-gpu/Cargo.toml

@@ -6,10 +6,10 @@
 use std::{io::Write as _, path::PathBuf};
 
 use anyhow::Context as _;
-use rustc_codegen_spirv_cache::user_output;
+use cargo_gpu_build::{lockfile::LockfileMismatchHandler, spirv_cache::user_output};
 use spirv_builder::{CompileResult, ModuleResult, SpirvBuilder};
 
-use crate::{linkage::Linkage, lockfile::LockfileMismatchHandler, Install};
+use crate::{linkage::Linkage, Install};
 
 /// Args for just a build
 #[derive(clap::Parser, Debug, Clone, serde::Deserialize, serde::Serialize)]

crates/cargo-gpu/src/build.rs

@@ -1,7 +1,7 @@
 //! Convenience function for internal use. Dumps all the CLI usage instructions. Useful for
 //! updating the README.
 
-use rustc_codegen_spirv_cache::user_output;
+use cargo_gpu_build::spirv_cache::user_output;
 
 use crate::Cli;
 

crates/cargo-gpu/src/dump_usage.rs

@@ -56,12 +56,11 @@ mod build;
 mod config;
 mod dump_usage;
 mod linkage;
-mod lockfile;
 mod metadata;
 mod show;
 mod test;
 
-pub use rustc_codegen_spirv_cache::backend::*;
+pub use cargo_gpu_build::spirv_cache::backend::*;
 pub use spirv_builder;
 
 /// All of the available subcommands for `cargo gpu`

crates/cargo-gpu/src/lib.rs

@@ -3,7 +3,7 @@
 use std::{fs, path::Path};
 
 use anyhow::bail;
-use rustc_codegen_spirv_cache::{
+use cargo_gpu_build::spirv_cache::{
     cache::cache_dir,
     spirv_source::{query_metadata, SpirvSource},
     target_specs::update_target_specs_files,