Add JSON schema support

.cargo/config.toml

@@ -0,0 +1,2 @@
+[alias]
+dev = "run --package uv-dev"

.gitattributes

@@ -1 +1,3 @@
 * text=auto eol=lf
+
+uv.schema.json linguist-generated=true text=auto eol=lf

crates/distribution-types/Cargo.toml

@@ -18,17 +18,18 @@ distribution-filename = { workspace = true, features = ["serde"] }
 pep440_rs = { workspace = true }
 pep508_rs = { workspace = true }
 platform-tags = { workspace = true }
+pypi-types = { workspace = true }
 uv-fs = { workspace = true }
 uv-git = { workspace = true, features = ["vendored-openssl"] }
 uv-normalize = { workspace = true }
-pypi-types = { workspace = true }
 
 anyhow = { workspace = true }
 fs-err = { workspace = true }
 itertools = { workspace = true }
 once_cell = { workspace = true }
 rkyv = { workspace = true }
 rustc-hash = { workspace = true }
+schemars = { workspace = true, optional = true }
 serde = { workspace = true, features = ["derive"] }
 serde_json = { workspace = true }
 thiserror = { workspace = true }

crates/distribution-types/src/index_url.rs

@@ -27,6 +27,22 @@ pub enum IndexUrl {
     Path(VerbatimUrl),
 }
 
+#[cfg(feature = "schemars")]
+impl schemars::JsonSchema for IndexUrl {
+    fn schema_name() -> String {
+        "IndexUrl".to_string()
+    }
+
+    fn json_schema(_gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema {
+        schemars::schema::SchemaObject {
+            instance_type: Some(schemars::schema::InstanceType::String.into()),
+            format: Some("index url".to_string()),
+            ..Default::default()
+        }
+        .into()
+    }
+}
+
 impl IndexUrl {
     /// Return the raw URL for the index.
     pub fn url(&self) -> &Url {
@@ -113,6 +129,22 @@ pub enum FlatIndexLocation {
     Url(Url),
 }
 
+#[cfg(feature = "schemars")]
+impl schemars::JsonSchema for FlatIndexLocation {
+    fn schema_name() -> String {
+        "FlatIndexLocation".to_string()
+    }
+
+    fn json_schema(_gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema {
+        schemars::schema::SchemaObject {
+            instance_type: Some(schemars::schema::InstanceType::String.into()),
+            format: Some("`--find-links` location".to_string()),
+            ..Default::default()
+        }
+        .into()
+    }
+}
+
 impl FromStr for FlatIndexLocation {
     type Err = url::ParseError;
 

crates/install-wheel-rs/Cargo.toml

@@ -39,6 +39,7 @@ platform-info = { workspace = true }
 reflink-copy = { workspace = true }
 regex = { workspace = true }
 rustc-hash = { workspace = true }
+schemars = { workspace = true, optional = true }
 serde = { workspace = true, features = ["derive"] }
 serde_json = { workspace = true }
 sha2 = { workspace = true }

crates/install-wheel-rs/src/linker.rs

@@ -204,6 +204,7 @@ fn parse_scripts(
 
 #[derive(Debug, Clone, Copy, Serialize, Deserialize)]
 #[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 pub enum LinkMode {
     /// Clone (i.e., copy-on-write) packages from the wheel into the site packages.
     Clone,

crates/uv-auth/Cargo.toml

@@ -11,6 +11,7 @@ once_cell = { workspace = true }
 reqwest = { workspace = true }
 reqwest-middleware = { workspace = true }
 rust-netrc = { workspace = true }
+schemars = { workspace = true, optional = true }
 serde = { workspace = true, optional = true }
 thiserror = { workspace = true }
 tracing = { workspace = true }

crates/uv-configuration/Cargo.toml

@@ -22,6 +22,7 @@ anyhow = { workspace = true }
 clap = { workspace = true, features = ["derive"], optional = true }
 itertools = { workspace = true }
 rustc-hash = { workspace = true }
+schemars = { workspace = true, optional = true }
 serde = { workspace = true, optional = true }
 serde_json = { workspace = true, optional = true }
 

crates/uv-configuration/src/authentication.rs

@@ -4,6 +4,7 @@ use uv_auth::{self, KeyringProvider};
 #[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
 #[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize))]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 pub enum KeyringProviderType {
     /// Do not use keyring for credential lookup.
     #[default]

crates/uv-configuration/src/build_options.rs

@@ -199,6 +199,7 @@ impl NoBuild {
 #[derive(Debug, Default, Clone, Hash, Eq, PartialEq)]
 #[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize))]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 pub enum IndexStrategy {
     /// Only use results from the first index that returns a match for a given package name.
     ///

crates/uv-configuration/src/config_settings.rs

@@ -29,6 +29,7 @@ impl FromStr for ConfigSettingEntry {
 }
 
 #[derive(Debug, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 enum ConfigSettingValue {
     /// The value consists of a single string.
     String(String),
@@ -83,6 +84,7 @@ impl<'de> serde::Deserialize<'de> for ConfigSettingValue {
 ///
 /// See: <https://peps.python.org/pep-0517/#config-settings>
 #[derive(Debug, Default, Clone)]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 pub struct ConfigSettings(BTreeMap<String, ConfigSettingValue>);
 
 impl FromIterator<ConfigSettingEntry> for ConfigSettings {

crates/uv-configuration/src/name_specifiers.rs

@@ -59,6 +59,22 @@ impl<'de> serde::Deserialize<'de> for PackageNameSpecifier {
     }
 }
 
+#[cfg(feature = "schemars")]
+impl schemars::JsonSchema for PackageNameSpecifier {
+    fn schema_name() -> String {
+        "PackageNameSpecifier".to_string()
+    }
+
+    fn json_schema(_gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema {
+        schemars::schema::SchemaObject {
+            instance_type: Some(schemars::schema::InstanceType::String.into()),
+            format: Some("package name or `:all:` or `:none:`".to_string()),
+            ..Default::default()
+        }
+        .into()
+    }
+}
+
 /// Package name specification.
 ///
 /// Consumes both package names and selection directives for compatibility with pip flags

crates/uv-dev/Cargo.toml

@@ -33,6 +33,7 @@ uv-normalize = { workspace = true }
 uv-resolver = { workspace = true }
 uv-toolchain = { workspace = true }
 uv-types = { workspace = true }
+uv-workspace = { workspace = true, features = ["schemars"] }
 
 # Any dependencies that are exclusively used in `uv-dev` should be listed as non-workspace
 # dependencies, to ensure that we're forced to think twice before including them in other crates.
@@ -47,8 +48,10 @@ itertools = { workspace = true }
 owo-colors = { workspace = true }
 petgraph = { workspace = true }
 poloto = { version = "19.1.2" }
+pretty_assertions = { version = "1.4.0" }
 resvg = { version = "0.29.0" }
 rustc-hash = { workspace = true }
+schemars = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
 tagu = { version = "0.1.6" }