chore: convert to workspace

x52dev · Oct 9, 2024 · 427781e · 427781e
1 parent 152446e
commit 427781e
Show file tree

Hide file tree

Showing 51 changed files with 99 additions and 84 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,6 @@
 .toolchain
 
 # Rust
-target
+/target
+Cargo.lock
+!/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,55 +1,14 @@
-[package]
-name = "oas3"
-description = "Structures and tools to parse, navigate, and validate OpenAPI v3.1 specifications"
-version = "0.11.0"
-authors = ["softprops <[email protected]>", "Rob Ede <[email protected]>"]
-keywords = ["oas3", "openapi", "swagger", "api", "validation"]
-categories = ["data-structures", "development-tools::testing", "parsing"]
+[workspace]
+resolver = "2"
+members = ["crates/*"]
+
+[workspace.package]
 repository = "https://github.com/x52dev/oas3-rs"
 license = "MIT"
 edition = "2021"
 rust-version = "1.75"
 
-[features]
-default = ["validation"]
-validation = []
-conformance = ["validation", "reqwest", "prettytable-rs", "colored"]
-
-[dependencies]
-bytes = "1.7"
-derive_more = { version = "1", features = ["display", "error", "from"] }
-futures-util = "0.3"
-http = "1"
-log = "0.4"
-once_cell = "1"
-regex = "1.11.0"
-semver = "1"
-serde = { version = "1", features = ["derive"] }
-serde_json = "1"
-serde_yml = "0.0.12"
-url = { version = "2", features = ["serde"] }
-
-# conformance
-colored = { version = "2", optional = true }
-prettytable-rs = { version = "0.10", optional = true }
-reqwest = { version = "0.12", optional = true, features = ["json"] }
-
-[dev-dependencies]
-assert_matches = "1"
-color-eyre = "0.6"
-dotenvy = "0.15"
-eyre = "0.6.12"
-indoc = "2"
-maplit = "1"
-pretty_assertions = "1"
-pretty_env_logger = "0.5"
-tokio = { version = "1.40.0", features = ["full"] }
-
-[[example]]
-name = "conformance"
-required-features = ["conformance"]
-
-[lints.rust]
+[workspace.lints.rust]
 rust_2018_idioms = "deny"
 nonstandard_style = "deny"
 future_incompatible = "deny"

diff --git a/README.md b/README.md
diff --git a/README.md b/README.md
@@ -0,0 +1 @@
+crates/oas3/README.md
diff --git a/crates/oas3/Cargo.toml b/crates/oas3/Cargo.toml
@@ -0,0 +1,53 @@
+[package]
+name = "oas3"
+description = "Structures and tools to parse, navigate, and validate OpenAPI v3.1 specifications"
+version = "0.11.0"
+authors = ["softprops <[email protected]>", "Rob Ede <[email protected]>"]
+keywords = ["oas3", "openapi", "swagger", "api", "validation"]
+categories = ["data-structures", "development-tools::testing", "parsing"]
+repository = { workspace = true }
+license = { workspace = true }
+edition = { workspace = true }
+rust-version = { workspace = true }
+
+[features]
+default = ["validation"]
+validation = []
+conformance = ["validation", "reqwest", "prettytable-rs", "colored"]
+
+[dependencies]
+bytes = "1.7"
+derive_more = { version = "1", features = ["display", "error", "from"] }
+futures-util = "0.3"
+http = "1"
+log = "0.4"
+once_cell = "1"
+regex = "1.11.0"
+semver = "1"
+serde = { version = "1", features = ["derive"] }
+serde_json = "1"
+serde_yml = "0.0.12"
+url = { version = "2", features = ["serde"] }
+
+# conformance
+colored = { version = "2", optional = true }
+prettytable-rs = { version = "0.10", optional = true }
+reqwest = { version = "0.12", optional = true, features = ["json"] }
+
+[dev-dependencies]
+assert_matches = "1"
+color-eyre = "0.6"
+dotenvy = "0.15"
+eyre = "0.6.12"
+indoc = "2"
+maplit = "1"
+pretty_assertions = "1"
+pretty_env_logger = "0.5"
+tokio = { version = "1.40.0", features = ["full"] }
+
+[[example]]
+name = "conformance"
+required-features = ["conformance"]
+
+[lints]
+workspace = true
diff --git a/crates/oas3/README.md b/crates/oas3/README.md
@@ -0,0 +1,35 @@
+# OAS3
+
+<!-- prettier-ignore-start -->
+
+[![crates.io](https://img.shields.io/crates/v/oas3?label=latest)](https://crates.io/crates/oas3)
+[![Documentation](https://docs.rs/oas3/badge.svg?version=0.11.0)](https://docs.rs/oas3/0.11.0)
+[![dependency status](https://deps.rs/crate/oas3/0.11.0/status.svg)](https://deps.rs/crate/oas3/0.11.0)
+![MIT or Apache 2.0 licensed](https://img.shields.io/crates/l/oas3.svg)
+<br />
+[![CI](https://github.com/x52dev/oas3/actions/workflows/ci.yml/badge.svg)](https://github.com/x52dev/oas3/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/x52dev/oas3/branch/main/graph/badge.svg)](https://codecov.io/gh/x52dev/oas3)
+![Version](https://img.shields.io/crates/msrv/oas3.svg)
+[![Download](https://img.shields.io/crates/d/oas3.svg)](https://crates.io/crates/oas3)
+
+<!-- prettier-ignore-end -->
+
+<!-- cargo-rdme start -->
+
+Structures and tools to parse, navigate and validate [OpenAPI v3.1] specifications.
+
+Note that due to v3.1 being a breaking change from v3.0, you may have trouble correctly parsing
+specs in the older format.
+
+## Example
+
+```rust
+match oas3::from_path("path/to/openapi.yml") {
+  Ok(spec) => println!("spec: {:?}", spec),
+  Err(err) => println!("error: {}", err)
+}
+```
+
+[OpenAPI v3.1]: https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md
+
+<!-- cargo-rdme end -->
diff --git a/examples/complex-validation.rs → crates/oas3/examples/complex-validation.rs b/examples/complex-validation.rs → crates/oas3/examples/complex-validation.rs
diff --git a/examples/conformance.rs → crates/oas3/examples/conformance.rs b/examples/conformance.rs → crates/oas3/examples/conformance.rs
diff --git a/examples/printer.rs → crates/oas3/examples/printer.rs b/examples/printer.rs → crates/oas3/examples/printer.rs
diff --git a/src/conformance/auth.rs → crates/oas3/src/conformance/auth.rs b/src/conformance/auth.rs → crates/oas3/src/conformance/auth.rs
diff --git a/src/conformance/mod.rs → crates/oas3/src/conformance/mod.rs b/src/conformance/mod.rs → crates/oas3/src/conformance/mod.rs
diff --git a/src/conformance/operation.rs → crates/oas3/src/conformance/operation.rs b/src/conformance/operation.rs → crates/oas3/src/conformance/operation.rs
diff --git a/src/conformance/param.rs → crates/oas3/src/conformance/param.rs b/src/conformance/param.rs → crates/oas3/src/conformance/param.rs
diff --git a/src/conformance/request.rs → crates/oas3/src/conformance/request.rs b/src/conformance/request.rs → crates/oas3/src/conformance/request.rs
diff --git a/src/conformance/response.rs → crates/oas3/src/conformance/response.rs b/src/conformance/response.rs → crates/oas3/src/conformance/response.rs
diff --git a/src/conformance/runner.rs → crates/oas3/src/conformance/runner.rs b/src/conformance/runner.rs → crates/oas3/src/conformance/runner.rs
diff --git a/src/conformance/test.rs → crates/oas3/src/conformance/test.rs b/src/conformance/test.rs → crates/oas3/src/conformance/test.rs
diff --git a/src/error.rs → crates/oas3/src/error.rs b/src/error.rs → crates/oas3/src/error.rs
diff --git a/src/lib.rs → crates/oas3/src/lib.rs b/src/lib.rs → crates/oas3/src/lib.rs
diff --git a/src/spec/components.rs → crates/oas3/src/spec/components.rs b/src/spec/components.rs → crates/oas3/src/spec/components.rs
diff --git a/src/spec/contact.rs → crates/oas3/src/spec/contact.rs b/src/spec/contact.rs → crates/oas3/src/spec/contact.rs
diff --git a/src/spec/encoding.rs → crates/oas3/src/spec/encoding.rs b/src/spec/encoding.rs → crates/oas3/src/spec/encoding.rs
diff --git a/src/spec/error.rs → crates/oas3/src/spec/error.rs b/src/spec/error.rs → crates/oas3/src/spec/error.rs
diff --git a/src/spec/example.rs → crates/oas3/src/spec/example.rs b/src/spec/example.rs → crates/oas3/src/spec/example.rs
diff --git a/src/spec/external_doc.rs → crates/oas3/src/spec/external_doc.rs b/src/spec/external_doc.rs → crates/oas3/src/spec/external_doc.rs
diff --git a/src/spec/flows.rs → crates/oas3/src/spec/flows.rs b/src/spec/flows.rs → crates/oas3/src/spec/flows.rs
diff --git a/src/spec/header.rs → crates/oas3/src/spec/header.rs b/src/spec/header.rs → crates/oas3/src/spec/header.rs
diff --git a/src/spec/info.rs → crates/oas3/src/spec/info.rs b/src/spec/info.rs → crates/oas3/src/spec/info.rs
diff --git a/src/spec/license.rs → crates/oas3/src/spec/license.rs b/src/spec/license.rs → crates/oas3/src/spec/license.rs
diff --git a/src/spec/link.rs → crates/oas3/src/spec/link.rs b/src/spec/link.rs → crates/oas3/src/spec/link.rs
diff --git a/src/spec/media_type.rs → crates/oas3/src/spec/media_type.rs b/src/spec/media_type.rs → crates/oas3/src/spec/media_type.rs
diff --git a/src/spec/media_type_examples.rs → crates/oas3/src/spec/media_type_examples.rs b/src/spec/media_type_examples.rs → crates/oas3/src/spec/media_type_examples.rs
diff --git a/src/spec/mod.rs → crates/oas3/src/spec/mod.rs b/src/spec/mod.rs → crates/oas3/src/spec/mod.rs
diff --git a/src/spec/operation.rs → crates/oas3/src/spec/operation.rs b/src/spec/operation.rs → crates/oas3/src/spec/operation.rs
diff --git a/src/spec/parameter.rs → crates/oas3/src/spec/parameter.rs b/src/spec/parameter.rs → crates/oas3/src/spec/parameter.rs
diff --git a/src/spec/path_item.rs → crates/oas3/src/spec/path_item.rs b/src/spec/path_item.rs → crates/oas3/src/spec/path_item.rs
diff --git a/src/spec/ref.rs → crates/oas3/src/spec/ref.rs b/src/spec/ref.rs → crates/oas3/src/spec/ref.rs
diff --git a/src/spec/request_body.rs → crates/oas3/src/spec/request_body.rs b/src/spec/request_body.rs → crates/oas3/src/spec/request_body.rs
diff --git a/src/spec/response.rs → crates/oas3/src/spec/response.rs b/src/spec/response.rs → crates/oas3/src/spec/response.rs
diff --git a/src/spec/schema.rs → crates/oas3/src/spec/schema.rs b/src/spec/schema.rs → crates/oas3/src/spec/schema.rs
diff --git a/src/spec/security_scheme.rs → crates/oas3/src/spec/security_scheme.rs b/src/spec/security_scheme.rs → crates/oas3/src/spec/security_scheme.rs
diff --git a/src/spec/server.rs → crates/oas3/src/spec/server.rs b/src/spec/server.rs → crates/oas3/src/spec/server.rs
diff --git a/src/spec/spec_extensions.rs → crates/oas3/src/spec/spec_extensions.rs b/src/spec/spec_extensions.rs → crates/oas3/src/spec/spec_extensions.rs
diff --git a/src/spec/tag.rs → crates/oas3/src/spec/tag.rs b/src/spec/tag.rs → crates/oas3/src/spec/tag.rs
diff --git a/src/validation/error.rs → crates/oas3/src/validation/error.rs b/src/validation/error.rs → crates/oas3/src/validation/error.rs
diff --git a/src/validation/mod.rs → crates/oas3/src/validation/mod.rs b/src/validation/mod.rs → crates/oas3/src/validation/mod.rs
diff --git a/src/validation/path.rs → crates/oas3/src/validation/path.rs b/src/validation/path.rs → crates/oas3/src/validation/path.rs
diff --git a/src/validation/required.rs → crates/oas3/src/validation/required.rs b/src/validation/required.rs → crates/oas3/src/validation/required.rs
diff --git a/src/validation/test_macros.rs → crates/oas3/src/validation/test_macros.rs b/src/validation/test_macros.rs → crates/oas3/src/validation/test_macros.rs
diff --git a/src/validation/type.rs → crates/oas3/src/validation/type.rs b/src/validation/type.rs → crates/oas3/src/validation/type.rs
diff --git a/src/validation/validator.rs → crates/oas3/src/validation/validator.rs b/src/validation/validator.rs → crates/oas3/src/validation/validator.rs
diff --git a/justfile b/justfile
@@ -28,7 +28,7 @@ fmt: update-readmes
 # Update READMEs from crate root documentation.
 [group("lint")]
 update-readmes:
-    cargo rdme --force
+    cd crates/oas3 && cargo rdme --force
 
 # Lint workspace with Clippy.
 [group("lint")]