Crate mit_lint[−][src]
Expand description
A set of lints to use with mit-commit
Examples
use mit_commit::CommitMessage;
use mit_lint::{Code, lint, Problem, Lints, Lint};
let message:String = "x".repeat(73).into();
let expected = vec![Problem::new(
"Your subject is longer than 72 characters".into(),
"It's important to keep the subject of the commit less than 72 characters because when you look at the git log, that's where it truncates the message. This means that people won't get the entirety of the information in your commit.\n\nPlease keep the subject line 72 characters or under"
.into(),
Code::SubjectLongerThan72Characters,
)];
let actual = lint(&CommitMessage::from(message), Lints::new(vec![Lint::SubjectLongerThan72Characters].into_iter().collect()));
assert_eq!(
actual, expected,
"Expected {:?}, found {:?}",
expected, actual
);
Structs
Enums
Constants
The prefix we put in front of the lint when serialising
Functions
Lint a commit message