Expand description
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§
- Check
GitContext - Git context for use in checks.
- Check
Result - The results of a check.
- Commit
- Representation of a commit with information useful for commit checks.
- Diff
Info - Information about a file that changed in a commit.
- GitCheck
Configuration - Configuration for checks to run against a repository.
- Topic
- Representation of a topic with information useful for commit checks.
Enums§
- Attribute
Error - Errors which can occur when querying an attribute.
- Attribute
State - States attributes may be in.
- Commit
Error - Errors which can occur when working with a commit for a check.
- File
Name - A representation of filenames as given by Git.
- File
Name Error - Errors which may occur dring filename parsing.
- RunError
- Errors which can occur when running checks.
- Severity
- The severity of a message.
- Status
Change - Ways a file can be changed in a commit.
Traits§
- Branch
Check - 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.
- Content
Check - Interface for checks which check the content of files.
- Topic
Check - Interface for checks which runs once for the entire branch, but with access to the content.