git_checks_core/
lib.rs

1// Copyright Kitware, Inc.
2//
3// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
4// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
5// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
6// option. This file may not be copied, modified, or distributed
7// except according to those terms.
8
9#![warn(missing_docs)]
10// XXX(rust-1.66)
11#![allow(clippy::uninlined_format_args)]
12
13//! Git checks
14//!
15//! There are many things in git repositories which can be checked mechanically such as whitespace
16//! errors, submodule availability, eligibility for a branch, and more. This crate provides traits
17//! for these checks and a set of common checks which operate with minimal file inspection.
18
19mod check;
20mod commit;
21mod context;
22pub mod impl_prelude;
23mod run;
24mod utils;
25
26pub use check::BranchCheck;
27pub use check::Check;
28pub use check::CheckResult;
29pub use check::ContentCheck;
30pub use check::Severity;
31pub use check::TopicCheck;
32pub use commit::Commit;
33pub use commit::CommitError;
34pub use commit::Content;
35pub use commit::DiffInfo;
36pub use commit::FileName;
37pub use commit::FileNameError;
38pub use commit::StatusChange;
39pub use commit::Topic;
40pub use context::AttributeError;
41pub use context::AttributeState;
42pub use context::CheckGitContext;
43pub use run::GitCheckConfiguration;
44pub use run::RunError;
45
46#[cfg(test)]
47mod test;