new: Add version_spec types. (#67)

CHANGELOG.md

@@ -5,6 +5,7 @@
 #### 🚀 Updates
 
 - Added support for `f32` and `f64` types.
+- Added `type_version_spec` feature, that implements schematic types for the `version_spec` crate.
 
 #### ⚙️ Internal
 

Cargo.toml

@@ -10,4 +10,5 @@ relative-path = "1.9.0"
 semver = "1.0.19"
 serde = { version = "1.0.188", features = ["derive"] }
 url = "2.4.1"
+version_spec = "0.1.0"
 warpgate = "0.5.7"

README.md

@@ -691,4 +691,5 @@ The following Cargo features are available:
 - `type_relative_path` - Implements schematic for the `relative-path` crate.
 - `type_semver` - Implements schematic for the `semver` crate.
 - `type_url` - Implements schematic for the `url` crate.
+- `type_version_spec` - Implements schematic for the `version_spec` crate.
 - `type_warpgate` - Implements schematic for the `warpgate` crate.

crates/config/Cargo.toml

@@ -3,7 +3,7 @@ name = "schematic"
 version = "0.11.7"
 edition = "2021"
 license = "MIT"
-description = "A light-weight, macro-based, layered serde configuration and schema library."
+description = "A light-weight, macro-based, and layered serde configuration and schema library."
 repository = "https://github.com/moonrepo/schematic"
 readme = "../../README.md"
 
@@ -54,9 +54,10 @@ yaml = ["dep:serde_yaml"]
 
 type_chrono = ["schematic_types/chrono"]
 type_regex = ["schematic_types/regex"]
-type_relative_path = ["schematic_types/relative-path"]
+type_relative_path = ["schematic_types/relative_path"]
 type_semver = ["schematic_types/semver"]
 type_url = ["schematic_types/url"]
+type_version_spec = ["schematic_types/version_spec"]
 type_warpgate = ["schematic_types/warpgate"]
 
 valid_email = ["garde/email"]
@@ -74,6 +75,7 @@ schematic = { path = ".", features = [
 	"type_relative_path",
 	"type_semver",
 	"type_url",
+	"type_version_spec",
 	"type_warpgate",
 	"url",
 	"valid_email",
@@ -89,4 +91,5 @@ regex = { workspace = true }
 relative-path = { workspace = true, features = ["serde"] }
 semver = { workspace = true, features = ["serde"] }
 url = { workspace = true, features = ["serde"] }
+version_spec = { workspace = true }
 warpgate = { workspace = true }

crates/config/tests/generator_test.rs

@@ -45,6 +45,8 @@ struct GenConfig {
     url: Option<url::Url>,
     version: Option<semver::Version>,
     version_req: semver::VersionReq,
+    spec: version_spec::VersionSpec,
+    spec_unresolved: version_spec::UnresolvedVersionSpec,
     id: warpgate::Id,
     locator: Option<warpgate::PluginLocator>,
 }

crates/config/tests/snapshots/generator_test__json_schema__defaults.snap

@@ -20,6 +20,8 @@ expression: "fs::read_to_string(file).unwrap()"
     "number",
     "path",
     "relPath",
+    "spec",
+    "specUnresolved",
     "string",
     "time",
     "url",
@@ -92,6 +94,12 @@ expression: "fs::read_to_string(file).unwrap()"
       "type": "string",
       "format": "path"
     },
+    "spec": {
+      "type": "string"
+    },
+    "specUnresolved": {
+      "type": "string"
+    },
     "string": {
       "type": "string"
     },

crates/config/tests/snapshots/generator_test__typescript__const_enums.snap

@@ -31,6 +31,8 @@ export interface GenConfig {
 	number: number;
 	path: string;
 	relPath: string;
+	spec: string;
+	specUnresolved: string;
 	string: string;
 	time: string;
 	url: string | null;

crates/config/tests/snapshots/generator_test__typescript__defaults.snap

@@ -27,6 +27,8 @@ export interface GenConfig {
 	number: number;
 	path: string;
 	relPath: string;
+	spec: string;
+	specUnresolved: string;
 	string: string;
 	time: string;
 	url: string | null;

crates/config/tests/snapshots/generator_test__typescript__enums.snap

@@ -31,6 +31,8 @@ export interface GenConfig {
 	number: number;
 	path: string;
 	relPath: string;
+	spec: string;
+	specUnresolved: string;
 	string: string;
 	time: string;
 	url: string | null;

crates/config/tests/snapshots/generator_test__typescript__exclude_refs.snap

@@ -25,6 +25,8 @@ export interface GenConfig {
 	number: number;
 	path: string;
 	relPath: string;
+	spec: string;
+	specUnresolved: string;
 	string: string;
 	time: string;
 	url: string | null;

crates/config/tests/snapshots/generator_test__typescript__external_types.snap

@@ -29,6 +29,8 @@ export interface GenConfig {
 	number: number;
 	path: string;
 	relPath: string;
+	spec: string;
+	specUnresolved: string;
 	string: string;
 	time: string;
 	url: string | null;

crates/config/tests/snapshots/generator_test__typescript__no_refs.snap

@@ -30,6 +30,8 @@ export interface GenConfig {
   number: number;
   path: string;
   relPath: string;
+  spec: string;
+  specUnresolved: string;
   string: string;
   time: string;
   url: string | null;

crates/config/tests/snapshots/generator_test__typescript__object_aliases.snap

@@ -27,6 +27,8 @@ export type GenConfig = {
 	number: number,
 	path: string,
 	relPath: string,
+	spec: string,
+	specUnresolved: string,
 	string: string,
 	time: string,
 	url: string | null,

crates/config/tests/snapshots/generator_test__typescript__value_enums.snap

@@ -31,6 +31,8 @@ export interface GenConfig {
 	number: number;
 	path: string;
 	relPath: string;
+	spec: string;
+	specUnresolved: string;
 	string: string;
 	time: string;
 	url: string | null;

crates/types/Cargo.toml

@@ -12,23 +12,26 @@ regex = { workspace = true, optional = true }
 relative-path = { workspace = true, optional = true }
 semver = { workspace = true, optional = true }
 url = { workspace = true, optional = true }
+version_spec = { workspace = true, optional = true }
 warpgate = { workspace = true, optional = true }
 
 [dev-dependencies]
 schematic_types = { path = ".", features = [
 	"chrono",
 	"regex",
-	"relative-path",
+	"relative_path",
 	"semver",
 	"url",
+	"version_spec",
 	"warpgate",
 ] }
 
 [features]
 default = []
 chrono = ["dep:chrono"]
 regex = ["dep:regex"]
-relative-path = ["dep:relative-path"]
+relative_path = ["dep:relative-path"]
 semver = ["dep:semver"]
 url = ["dep:url"]
+version_spec = ["dep:version_spec"]
 warpgate = ["dep:warpgate"]

crates/types/src/externals.rs

@@ -61,7 +61,7 @@ mod regex_feature {
     impl_string_format!(regex::Regex, "regex");
 }
 
-#[cfg(feature = "relative-path")]
+#[cfg(feature = "relative_path")]
 mod relative_path_feature {
     use super::*;
 
@@ -85,6 +85,14 @@ mod url_feature {
     impl_string_format!(url::Url, "uri");
 }
 
+#[cfg(feature = "version_spec")]
+mod version_spec_feature {
+    use super::*;
+
+    impl_string!(version_spec::UnresolvedVersionSpec);
+    impl_string!(version_spec::VersionSpec);
+}
+
 #[cfg(feature = "warpgate")]
 mod warpgate_feature {
     use super::*;