Deal bool and string separately in TomlPackageBuild

Author: namanlp

crates/cargo-util-schemas/src/manifest/mod.rs

@@ -168,9 +168,14 @@ pub struct InheritablePackage {
 #[derive(Deserialize, Serialize, Clone, Debug)]
 #[serde(untagged, rename_all = "kebab-case")]
 pub enum TomlPackageBuild {
-    /// If there's just one script or boolean value
-    SingleScript(StringOrBool),
-    /// If multiple build script are there
+    /// If build scripts are disabled or enabled.
+    /// If true, `build.rs` in the root folder will be the build script.
+    Auto(bool),
+
+    /// Path of Build Script if there's just one script.
+    SingleScript(String),
+
+    /// Vector of paths if multiple build script are to be used.
     MultipleScripts(Vec<String>),
 }
 
@@ -266,9 +271,9 @@ impl TomlPackage {
     pub fn normalized_build(&self) -> Result<Option<&String>, UnresolvedError> {
         let build = self.build.as_ref().ok_or(UnresolvedError)?;
         match build {
-            TomlPackageBuild::SingleScript(StringOrBool::Bool(false)) => Ok(None),
-            TomlPackageBuild::SingleScript(StringOrBool::Bool(true)) => Err(UnresolvedError),
-            TomlPackageBuild::SingleScript(StringOrBool::String(value)) => Ok(Some(value)),
+            TomlPackageBuild::Auto(false) => Ok(None),
+            TomlPackageBuild::Auto(true) => Err(UnresolvedError),
+            TomlPackageBuild::SingleScript(value) => Ok(Some(value)),
             TomlPackageBuild::MultipleScripts(_scripts) => {
                 unimplemented!("Multiple Build Scripts feature is not implemented yet!")
             }

src/cargo/ops/vendor.rs

@@ -12,7 +12,7 @@ use crate::util::{try_canonicalize, CargoResult, GlobalContext};
 use anyhow::{bail, Context as _};
 use cargo_util::{paths, Sha256};
 use cargo_util_schemas::core::SourceKind;
-use cargo_util_schemas::manifest::{StringOrBool, TomlManifest, TomlPackageBuild};
+use cargo_util_schemas::manifest::{TomlManifest, TomlPackageBuild};
 use serde::Serialize;
 use walkdir::WalkDir;
 
@@ -514,7 +514,8 @@ fn prepare_toml_for_vendor(
         .package
         .as_mut()
         .expect("venedored manifests must have packages");
-    if let Some(TomlPackageBuild::SingleScript(StringOrBool::String(path))) = &package.build {
+    // Validates if build script file exists. If not, warn and ignore.
+    if let Some(TomlPackageBuild::SingleScript(path)) = &package.build {
         let path = paths::normalize_path(Path::new(path));
         let included = packaged_files.contains(&path);
         let build = if included {
@@ -523,15 +524,15 @@ fn prepare_toml_for_vendor(
                 .into_string()
                 .map_err(|_err| anyhow::format_err!("non-UTF8 `package.build`"))?;
             let path = crate::util::toml::normalize_path_string_sep(path);
-            StringOrBool::String(path)
+            TomlPackageBuild::SingleScript(path)
         } else {
             gctx.shell().warn(format!(
                 "ignoring `package.build` as `{}` is not included in the published package",
                 path.display()
             ))?;
-            StringOrBool::Bool(false)
+            TomlPackageBuild::Auto(false)
         };
-        package.build = Some(TomlPackageBuild::SingleScript(build));
+        package.build = Some(build);
     }
 
     let lib = if let Some(target) = &me.lib {

src/cargo/util/toml/mod.rs

@@ -670,7 +670,7 @@ fn normalize_package_toml<'a>(
         .transpose()?
         .map(manifest::InheritableField::Value);
     let build = if is_embedded {
-        Some(TomlPackageBuild::SingleScript(StringOrBool::Bool(false)))
+        Some(TomlPackageBuild::Auto(false))
     } else {
         targets::normalize_build(original_package.build.as_ref(), package_root)
     };
@@ -2885,7 +2885,9 @@ fn prepare_toml_for_publish(
 
     let mut package = me.package().unwrap().clone();
     package.workspace = None;
-    if let Some(TomlPackageBuild::SingleScript(StringOrBool::String(path))) = &package.build {
+
+    // Validates if build script file exists. If not, warn and ignore.
+    if let Some(TomlPackageBuild::SingleScript(path)) = &package.build {
         let path = Path::new(path).to_path_buf();
         let included = packaged_files.map(|i| i.contains(&path)).unwrap_or(true);
         let build = if included {
@@ -2894,15 +2896,15 @@ fn prepare_toml_for_publish(
                 .into_string()
                 .map_err(|_err| anyhow::format_err!("non-UTF8 `package.build`"))?;
             let path = normalize_path_string_sep(path);
-            StringOrBool::String(path)
+            TomlPackageBuild::SingleScript(path)
         } else {
             ws.gctx().shell().warn(format!(
                 "ignoring `package.build` as `{}` is not included in the published package",
                 path.display()
             ))?;
-            StringOrBool::Bool(false)
+            TomlPackageBuild::Auto(false)
         };
-        package.build = Some(TomlPackageBuild::SingleScript(build));
+        package.build = Some(build);
     }
     let current_resolver = package
         .resolver

src/cargo/util/toml/targets.rs

@@ -17,8 +17,8 @@ use std::path::{Path, PathBuf};
 use anyhow::Context as _;
 use cargo_util::paths;
 use cargo_util_schemas::manifest::{
-    PathValue, StringOrBool, StringOrVec, TomlBenchTarget, TomlBinTarget, TomlExampleTarget,
-    TomlLibTarget, TomlManifest, TomlPackageBuild, TomlTarget, TomlTestTarget,
+    PathValue, StringOrVec, TomlBenchTarget, TomlBinTarget, TomlExampleTarget, TomlLibTarget,
+    TomlManifest, TomlPackageBuild, TomlTarget, TomlTestTarget,
 };
 
 use crate::core::compiler::rustdoc::RustdocScrapeExamples;
@@ -1087,28 +1087,26 @@ pub fn normalize_build(
             // a build script.
             let build_rs = package_root.join(BUILD_RS);
             if build_rs.is_file() {
-                Some(TomlPackageBuild::SingleScript(StringOrBool::String(
-                    BUILD_RS.to_owned(),
-                )))
+                Some(TomlPackageBuild::SingleScript(BUILD_RS.to_owned()))
             } else {
-                Some(TomlPackageBuild::SingleScript(StringOrBool::Bool(false)))
+                Some(TomlPackageBuild::Auto(false))
             }
         }
         // Explicitly no build script.
-        Some(TomlPackageBuild::SingleScript(StringOrBool::Bool(false))) => build.cloned(),
+        Some(TomlPackageBuild::Auto(false)) => build.cloned(),
 
         // Build file's path is given
-        Some(TomlPackageBuild::SingleScript(StringOrBool::String(build_file))) => {
+        Some(TomlPackageBuild::SingleScript(build_file)) => {
             let build_file = paths::normalize_path(Path::new(build_file));
             let build = build_file.into_os_string().into_string().expect(
                 "`build_file` started as a String and `normalize_path` shouldn't have changed that",
             );
-            Some(TomlPackageBuild::SingleScript(StringOrBool::String(build)))
+            Some(TomlPackageBuild::SingleScript(build))
         }
 
-        Some(TomlPackageBuild::SingleScript(StringOrBool::Bool(true))) => Some(
-            TomlPackageBuild::SingleScript(StringOrBool::String(BUILD_RS.to_owned())),
-        ),
+        Some(TomlPackageBuild::Auto(true)) => {
+            Some(TomlPackageBuild::SingleScript(BUILD_RS.to_owned()))
+        }
 
         // If multiple build scripts are there
         Some(TomlPackageBuild::MultipleScripts(_scripts)) => {