[][src]Crate git_checks_core

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.

Modules

impl_prelude

Module for importing all types and traits for implementing checks.

Structs

CheckGitContext

Git context for use in checks.

CheckResult

The results of a check.

Commit

Representation of a commit with information useful for commit checks.

DiffInfo

Information about a file that changed in a commit.

GitCheckConfiguration

Configuration for checks to run against a repository.

Topic

Representation of a topic with information useful for commit checks.

Enums

AttributeError

Errors which can occur when querying an attribute.

AttributeState

States attributes may be in.

CommitError

Errors which can occur when working with a commit for a check.

FileName

A representation of filenames as given by Git.

FileNameError

Errors which may occur dring filename parsing.

RunError

Errors which can occur when running checks.

Severity

The severity of a message.

StatusChange

Ways a file can be changed in a commit.

Traits

BranchCheck

Interface for checks which runs once for the entire branch.

Check

Interface for checks which run for each commit.

Content

A trait for representing the content of a diff.

ContentCheck

Interface for checks which check the content of files.

TopicCheck

Interface for checks which runs once for the entire branch, but with access to the content.