nextest_metadata/lib.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
// Copyright (c) The nextest Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0
//! This crate contains deserializers for machine-readable output generated by
//! [cargo-nextest](https://nexte.st).
//!
//! Implemented so far:
//! * ✅ Listing tests with [`TestListSummary`]
//! * ✅ Semantic exit codes with [`NextestExitCode`]
//!
//! # Examples
//!
//! Get the list of tests in the repository:
//!
//! ```rust
//! // This example requires `cargo nextest` to be installed.
//!
//! use nextest_metadata::ListCommand;
//!
//! let command = ListCommand::new();
//! let test_list = command.exec().unwrap();
//!
//! // The result is a TestListSummary.
//! println!("{:?}", test_list);
//! ```
//!
//! # Minimum supported Rust version (MSRV)
//!
//! The minimum supported Rust version is **Rust 1.73.**
//!
//! While this crate is a pre-release (0.x.x) it may have its MSRV bumped in a patch release. Once a
//! crate has reached 1.x, any MSRV bump will be accompanied with a new minor version.
//!
//! # Minimum supported cargo-nextest version
//!
//! The "minimum supported cargo-nextest version" is **cargo-nextest 0.9.15**.
//!
//! For more about nextest-metadata's stability policy, see the [Stability
//! page](https://nexte.st/docs/stability/#nextest-metadata) on the nextest site.
#![warn(missing_docs)]
mod errors;
mod exit_codes;
mod test_list;
pub use errors::*;
pub use exit_codes::*;
pub use test_list::*;