version_control_clean_check/
lib.rs

1#![deny(missing_docs)]
2#![deny(missing_debug_implementations)]
3#![cfg_attr(test, deny(warnings))]
4#![forbid(unsafe_code)]
5#![doc = include_str!("../README.md")]
6
7//! # Sample Code
8//!
9//! ```rust
10//! use version_control_clean_check::{CheckOptions, check_version_control};
11//! let mut opts = CheckOptions::new();
12//! opts.allow_no_vcs = true; // Disable actual checks for example
13//! let actual = check_version_control("path_here", &opts);
14//! assert!(actual.is_ok());
15//! ```
16
17mod check;
18mod error;
19
20/// Type alias for Result<T, [`VCSError`]>
21pub type VCSResult<T> = Result<T, VCSError>;
22pub use check::{check_version_control, CheckOptions};
23pub use error::VCSError;