refactor(schemas): Pull out cargo-util-schemas crate

epage · epage · commit 90715f75b83f · 2023-12-15T13:22:25.000-06:00
Fixes #12801
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -30,6 +30,7 @@ cargo-platform = { path = "crates/cargo-platform", version = "0.1.4" }
 cargo-test-macro = { path = "crates/cargo-test-macro" }
 cargo-test-support = { path = "crates/cargo-test-support" }
 cargo-util = { version = "0.2.6", path = "crates/cargo-util" }
+cargo-util-schemas = { version = "0.1.0", path = "crates/cargo-util-schemas" }
 cargo_metadata = "0.18.1"
 clap = "4.4.10"
 color-print = "0.3.5"
@@ -144,6 +145,7 @@ base64.workspace = true
 bytesize.workspace = true
 cargo-credential.workspace = true
 cargo-platform.workspace = true
+cargo-util-schemas.workspace = true
 cargo-util.workspace = true
 clap = { workspace = true, features = ["wrap_help"] }
 color-print.workspace = true
@@ -183,7 +185,6 @@ rustfix.workspace = true
 semver.workspace = true
 serde = { workspace = true, features = ["derive"] }
 serde-untagged.workspace = true
-serde-value.workspace = true
 serde_ignored.workspace = true
 serde_json = { workspace = true, features = ["raw_value"] }
 sha1.workspace = true
@@ -199,7 +200,6 @@ tracing.workspace = true
 tracing-subscriber.workspace = true
 unicase.workspace = true
 unicode-width.workspace = true
-unicode-xid.workspace = true
 url.workspace = true
 walkdir.workspace = true
 
diff --git a/crates/cargo-util-schemas/Cargo.toml b/crates/cargo-util-schemas/Cargo.toml
@@ -0,0 +1,22 @@
+[package]
+name = "cargo-util-schemas"
+version = "0.1.0"
+rust-version.workspace = true
+edition.workspace = true
+license.workspace = true
+homepage = "https://github.com/rust-lang/cargo"
+repository = "https://github.com/rust-lang/cargo"
+description = "Deserialization schemas for Cargo"
+
+[dependencies]
+anyhow.workspace = true
+semver.workspace = true
+serde = { workspace = true, features = ["derive"] }
+serde-untagged.workspace = true
+serde-value.workspace = true
+toml.workspace = true
+unicode-xid.workspace = true
+url.workspace = true
+
+[lints]
+workspace = true
diff --git a/crates/cargo-util-schemas/LICENSE-APACHE b/crates/cargo-util-schemas/LICENSE-APACHE
@@ -0,0 +1 @@
+../../LICENSE-APACHE
diff --git a/crates/cargo-util-schemas/LICENSE-MIT b/crates/cargo-util-schemas/LICENSE-MIT
@@ -0,0 +1 @@
+../../LICENSE-MIT
diff --git a/crates/cargo-util-schemas/src/core/mod.rs b/crates/cargo-util-schemas/src/core/mod.rs
diff --git a/crates/cargo-util-schemas/src/core/package_id_spec.rs b/crates/cargo-util-schemas/src/core/package_id_spec.rs
@@ -6,10 +6,10 @@ use semver::Version;
 use serde::{de, ser};
 use url::Url;
 
-use crate::util_schemas::core::GitReference;
-use crate::util_schemas::core::PartialVersion;
-use crate::util_schemas::core::SourceKind;
-use crate::util_schemas::manifest::PackageName;
+use crate::core::GitReference;
+use crate::core::PartialVersion;
+use crate::core::SourceKind;
+use crate::manifest::PackageName;
 
 /// Some or all of the data required to identify a package:
 ///
diff --git a/crates/cargo-util-schemas/src/core/partial_version.rs b/crates/cargo-util-schemas/src/core/partial_version.rs
diff --git a/crates/cargo-util-schemas/src/core/source_kind.rs b/crates/cargo-util-schemas/src/core/source_kind.rs
diff --git a/crates/cargo-util-schemas/src/lib.rs b/crates/cargo-util-schemas/src/lib.rs
diff --git a/crates/cargo-util-schemas/src/manifest.rs b/crates/cargo-util-schemas/src/manifest.rs
@@ -16,9 +16,9 @@ use serde::ser;
 use serde::{Deserialize, Serialize};
 use serde_untagged::UntaggedEnumVisitor;
 
-use crate::util_schemas::core::PackageIdSpec;
-use crate::util_schemas::core::PartialVersion;
-use crate::util_schemas::restricted_names;
+use crate::core::PackageIdSpec;
+use crate::core::PartialVersion;
+use crate::restricted_names;
 
 /// This type is used to deserialize `Cargo.toml` files.
 #[derive(Debug, Deserialize, Serialize)]
diff --git a/crates/cargo-util-schemas/src/restricted_names.rs b/crates/cargo-util-schemas/src/restricted_names.rs
diff --git a/publish.py b/publish.py
@@ -25,6 +25,7 @@
     'crates/cargo-platform',
     'crates/cargo-util',
     'crates/crates-io',
+    'crates/cargo-util-schemas',
     '.',
 ]
 
diff --git a/src/bin/cargo/main.rs b/src/bin/cargo/main.rs
@@ -4,8 +4,8 @@ use cargo::util::network::http::http_handle;
 use cargo::util::network::http::needs_custom_http_transport;
 use cargo::util::CliError;
 use cargo::util::{self, closest_msg, command_prelude, CargoResult, CliResult, Config};
-use cargo::util_schemas::manifest::StringOrVec;
 use cargo_util::{ProcessBuilder, ProcessError};
+use cargo_util_schemas::manifest::StringOrVec;
 use std::collections::BTreeMap;
 use std::env;
 use std::ffi::OsStr;
diff --git a/src/cargo/core/compiler/mod.rs b/src/cargo/core/compiler/mod.rs
@@ -94,9 +94,9 @@ use crate::util::errors::{CargoResult, VerboseError};
 use crate::util::interning::InternedString;
 use crate::util::machine_message::{self, Message};
 use crate::util::{add_path_args, internal, iter_join_onto, profile};
-use crate::util_schemas::manifest::TomlDebugInfo;
-use crate::util_schemas::manifest::TomlTrimPaths;
 use cargo_util::{paths, ProcessBuilder, ProcessError};
+use cargo_util_schemas::manifest::TomlDebugInfo;
+use cargo_util_schemas::manifest::TomlTrimPaths;
 use rustfix::diagnostics::Applicability;
 
 const RUSTDOC_CRATE_VERSION_FLAG: &str = "--crate-version";
diff --git a/src/cargo/core/manifest.rs b/src/cargo/core/manifest.rs
@@ -6,6 +6,8 @@ use std::rc::Rc;
 use std::sync::Arc;
 
 use anyhow::Context as _;
+use cargo_util_schemas::manifest::RustVersion;
+use cargo_util_schemas::manifest::{TomlManifest, TomlProfiles};
 use semver::Version;
 use serde::ser;
 use serde::Serialize;
@@ -19,8 +21,6 @@ use crate::core::{Edition, Feature, Features, WorkspaceConfig};
 use crate::util::errors::*;
 use crate::util::interning::InternedString;
 use crate::util::{short_hash, Config, Filesystem};
-use crate::util_schemas::manifest::RustVersion;
-use crate::util_schemas::manifest::{TomlManifest, TomlProfiles};
 
 pub enum EitherManifest {
     Real(Manifest),
diff --git a/src/cargo/core/mod.rs b/src/cargo/core/mod.rs
@@ -14,7 +14,7 @@ pub use self::workspace::{
     find_workspace_root, resolve_relative_path, MaybePackage, Workspace, WorkspaceConfig,
     WorkspaceRootConfig,
 };
-pub use crate::util_schemas::core::{GitReference, PackageIdSpec, SourceKind};
+pub use cargo_util_schemas::core::{GitReference, PackageIdSpec, SourceKind};
 
 pub mod compiler;
 pub mod dependency;
diff --git a/src/cargo/core/package.rs b/src/cargo/core/package.rs
@@ -10,6 +10,7 @@ use std::time::{Duration, Instant};
 
 use anyhow::Context;
 use bytesize::ByteSize;
+use cargo_util_schemas::manifest::RustVersion;
 use curl::easy::Easy;
 use curl::multi::{EasyHandle, Multi};
 use lazycell::LazyCell;
@@ -33,7 +34,6 @@ use crate::util::network::retry::{Retry, RetryResult};
 use crate::util::network::sleep::SleepTracker;
 use crate::util::toml::prepare_for_publish;
 use crate::util::{self, internal, Config, Progress, ProgressStyle};
-use crate::util_schemas::manifest::RustVersion;
 
 pub const MANIFEST_PREAMBLE: &str = "\
 # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
diff --git a/src/cargo/core/profiles.rs b/src/cargo/core/profiles.rs
@@ -31,12 +31,12 @@ use crate::core::{
 use crate::util::interning::InternedString;
 use crate::util::toml::validate_profile;
 use crate::util::{closest_msg, config, CargoResult, Config};
-use crate::util_schemas::manifest::TomlTrimPaths;
-use crate::util_schemas::manifest::TomlTrimPathsValue;
-use crate::util_schemas::manifest::{
+use anyhow::{bail, Context as _};
+use cargo_util_schemas::manifest::TomlTrimPaths;
+use cargo_util_schemas::manifest::TomlTrimPathsValue;
+use cargo_util_schemas::manifest::{
     ProfilePackageSpec, StringOrBool, TomlDebugInfo, TomlProfile, TomlProfiles,
 };
-use anyhow::{bail, Context as _};
 use std::collections::{BTreeMap, HashMap, HashSet};
 use std::hash::Hash;
 use std::{cmp, fmt, hash};
diff --git a/src/cargo/core/resolver/version_prefs.rs b/src/cargo/core/resolver/version_prefs.rs
@@ -4,9 +4,10 @@
 use std::cmp::Ordering;
 use std::collections::{HashMap, HashSet};
 
+use cargo_util_schemas::manifest::RustVersion;
+
 use crate::core::{Dependency, PackageId, Summary};
 use crate::util::interning::InternedString;
-use crate::util_schemas::manifest::RustVersion;
 
 /// A collection of preferences for particular package versions.
 ///
diff --git a/src/cargo/core/summary.rs b/src/cargo/core/summary.rs
@@ -1,9 +1,9 @@
 use crate::core::{Dependency, PackageId, SourceId};
 use crate::util::interning::InternedString;
 use crate::util::CargoResult;
-use crate::util_schemas::manifest::FeatureName;
-use crate::util_schemas::manifest::RustVersion;
 use anyhow::bail;
+use cargo_util_schemas::manifest::FeatureName;
+use cargo_util_schemas::manifest::RustVersion;
 use semver::Version;
 use std::collections::{BTreeMap, HashMap, HashSet};
 use std::fmt;
diff --git a/src/cargo/core/workspace.rs b/src/cargo/core/workspace.rs
@@ -26,10 +26,10 @@ use crate::util::errors::{CargoResult, ManifestError};
 use crate::util::interning::InternedString;
 use crate::util::toml::{read_manifest, InheritableFields};
 use crate::util::{config::ConfigRelativePath, Config, Filesystem, IntoUrl};
-use crate::util_schemas::manifest::RustVersion;
-use crate::util_schemas::manifest::{TomlDependency, TomlProfiles};
 use cargo_util::paths;
 use cargo_util::paths::normalize_path;
+use cargo_util_schemas::manifest::RustVersion;
+use cargo_util_schemas::manifest::{TomlDependency, TomlProfiles};
 use pathdiff::diff_paths;
 
 /// The core abstraction in Cargo for working with a workspace of crates.
diff --git a/src/cargo/lib.rs b/src/cargo/lib.rs
@@ -62,6 +62,9 @@
 //! - [`cargo-util`](https://crates.io/crates/cargo-util)
 //!   ([nightly docs](https://doc.rust-lang.org/nightly/nightly-rustc/cargo_util)):
 //!   This contains general utility code that is shared between cargo and the testsuite
+//! - [`cargo-util-schemas`](https://crates.io/crates/cargo-util-schemas)
+//!   ([nightly docs](https://doc.rust-lang.org/nightly/nightly-rustc/cargo_util-schemas)):
+//!   This contains the serde schemas for cargo
 //! - [`crates-io`](https://crates.io/crates/crates-io)
 //!   ([nightly docs](https://doc.rust-lang.org/nightly/nightly-rustc/crates_io)):
 //!   This contains code for accessing the crates.io API.
@@ -98,7 +101,7 @@
 //! Files that interact with cargo include
 //!
 //! - Package
-//!   - `Cargo.toml`: User-written project manifest, loaded with [`util_schemas::manifest::TomlManifest`] and then
+//!   - `Cargo.toml`: User-written project manifest, loaded with [`util::toml::read_manifest`] and then
 //!     translated to [`core::manifest::Manifest`] which maybe stored in a [`core::Package`].
 //!     - This is editable with [`util::toml_mut::manifest::LocalManifest`]
 //!   - `Cargo.lock`: Generally loaded with [`ops::resolve_ws`] or a variant of it into a [`core::resolver::Resolve`]
@@ -152,7 +155,6 @@ pub mod core;
 pub mod ops;
 pub mod sources;
 pub mod util;
-pub mod util_schemas;
 mod version;
 
 pub fn exit_with_error(err: CliError, shell: &mut Shell) -> ! {
diff --git a/src/cargo/ops/cargo_add/crate_spec.rs b/src/cargo/ops/cargo_add/crate_spec.rs
@@ -4,8 +4,8 @@ use anyhow::Context as _;
 
 use super::Dependency;
 use crate::util::toml_mut::dependency::RegistrySource;
-use crate::util_schemas::manifest::PackageName;
 use crate::CargoResult;
+use cargo_util_schemas::manifest::PackageName;
 
 /// User-specified crate
 ///
diff --git a/src/cargo/ops/cargo_add/mod.rs b/src/cargo/ops/cargo_add/mod.rs
@@ -11,6 +11,7 @@ use std::str::FromStr;
 
 use anyhow::Context as _;
 use cargo_util::paths;
+use cargo_util_schemas::manifest::RustVersion;
 use indexmap::IndexSet;
 use itertools::Itertools;
 use toml_edit::Item as TomlItem;
@@ -35,7 +36,6 @@ use crate::util::toml_mut::dependency::WorkspaceSource;
 use crate::util::toml_mut::is_sorted;
 use crate::util::toml_mut::manifest::DepTable;
 use crate::util::toml_mut::manifest::LocalManifest;
-use crate::util_schemas::manifest::RustVersion;
 use crate::CargoResult;
 use crate::Config;
 use crate_spec::CrateSpec;
diff --git a/src/cargo/ops/cargo_new.rs b/src/cargo/ops/cargo_new.rs
@@ -4,9 +4,9 @@ use crate::util::important_paths::find_root_manifest_for_wd;
 use crate::util::toml_mut::is_sorted;
 use crate::util::{existing_vcs_repo, FossilRepo, GitRepo, HgRepo, PijulRepo};
 use crate::util::{restricted_names, Config};
-use crate::util_schemas::manifest::PackageName;
 use anyhow::{anyhow, Context};
 use cargo_util::paths::{self, write_atomic};
+use cargo_util_schemas::manifest::PackageName;
 use serde::de;
 use serde::Deserialize;
 use std::collections::BTreeMap;
diff --git a/src/cargo/ops/resolve.rs b/src/cargo/ops/resolve.rs
@@ -72,8 +72,8 @@ use crate::sources::PathSource;
 use crate::util::cache_lock::CacheLockMode;
 use crate::util::errors::CargoResult;
 use crate::util::{profile, CanonicalUrl};
-use crate::util_schemas::manifest::RustVersion;
 use anyhow::Context as _;
+use cargo_util_schemas::manifest::RustVersion;
 use std::collections::{HashMap, HashSet};
 use tracing::{debug, trace};
 
diff --git a/src/cargo/sources/registry/index.rs b/src/cargo/sources/registry/index.rs
@@ -93,9 +93,9 @@ use crate::util::cache_lock::CacheLockMode;
 use crate::util::interning::InternedString;
 use crate::util::IntoUrl;
 use crate::util::{internal, CargoResult, Config, Filesystem, OptVersionReq};
-use crate::util_schemas::manifest::RustVersion;
 use anyhow::bail;
 use cargo_util::{paths, registry::make_dep_path};
+use cargo_util_schemas::manifest::RustVersion;
 use semver::Version;
 use serde::Deserialize;
 use std::borrow::Cow;
diff --git a/src/cargo/util/command_prelude.rs b/src/cargo/util/command_prelude.rs
@@ -11,12 +11,12 @@ use crate::util::{
     print_available_benches, print_available_binaries, print_available_examples,
     print_available_packages, print_available_tests,
 };
-use crate::util_schemas::manifest::ProfileName;
-use crate::util_schemas::manifest::RegistryName;
-use crate::util_schemas::manifest::StringOrVec;
 use crate::CargoResult;
 use anyhow::bail;
 use cargo_util::paths;
+use cargo_util_schemas::manifest::ProfileName;
+use cargo_util_schemas::manifest::RegistryName;
+use cargo_util_schemas::manifest::StringOrVec;
 use clap::builder::UnknownArgumentValueParser;
 use std::ffi::{OsStr, OsString};
 use std::path::Path;
diff --git a/src/cargo/util/config/mod.rs b/src/cargo/util/config/mod.rs
@@ -80,10 +80,10 @@ use crate::util::network::http::http_handle;
 use crate::util::try_canonicalize;
 use crate::util::{internal, CanonicalUrl};
 use crate::util::{Filesystem, IntoUrl, IntoUrlWithBase, Rustc};
-use crate::util_schemas::manifest::RegistryName;
 use anyhow::{anyhow, bail, format_err, Context as _};
 use cargo_credential::Secret;
 use cargo_util::paths;
+use cargo_util_schemas::manifest::RegistryName;
 use curl::easy::Easy;
 use lazycell::LazyCell;
 use serde::de::IntoDeserializer as _;
diff --git a/src/cargo/util/toml/embedded.rs b/src/cargo/util/toml/embedded.rs
@@ -1,7 +1,8 @@
 use anyhow::Context as _;
 
+use cargo_util_schemas::manifest::PackageName;
+
 use crate::util::restricted_names;
-use crate::util_schemas::manifest::PackageName;
 use crate::CargoResult;
 use crate::Config;
 
diff --git a/src/cargo/util/toml/mod.rs b/src/cargo/util/toml/mod.rs
diff --git a/src/cargo/util/toml/targets.rs b/src/cargo/util/toml/targets.rs
