git-checks-core 1.0.1

Checks to run against a topic in git to enforce coding standards.
Documentation 
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

// Copyright Kitware, Inc.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#![warn(missing_docs)]

//! Git checks
//!
//! There are many things in git repositories which can be checked mechanically such as whitespace
//! errors, submodule availability, eligibility for a branch, and more. This crate provides traits
//! for these checks and a set of common checks which operate with minimal file inspection.

#[macro_use]
extern crate lazy_static;

#[macro_use]
extern crate log;

mod crates {
    // public
    pub extern crate git_workarea;

    // private
    pub extern crate itertools;
    pub extern crate rayon;
    pub extern crate regex;
    pub extern crate thiserror;

    #[cfg(test)]
    pub extern crate tempdir;
}

mod check;
mod commit;
mod context;
pub mod impl_prelude;
mod run;
mod utils;

pub use check::BranchCheck;
pub use check::Check;
pub use check::CheckResult;
pub use check::ContentCheck;
pub use check::Severity;
pub use check::TopicCheck;
pub use commit::Commit;
pub use commit::CommitError;
pub use commit::Content;
pub use commit::DiffInfo;
pub use commit::FileName;
pub use commit::FileNameError;
pub use commit::StatusChange;
pub use commit::Topic;
pub use context::AttributeError;
pub use context::AttributeState;
pub use context::CheckGitContext;
pub use run::GitCheckConfiguration;
pub use run::RunError;

#[cfg(test)]
mod test;