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 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
use std::convert::TryInto;
use miette::Diagnostic;
use mit_commit::CommitMessage;
use quickcheck::{Arbitrary, Gen};
use strum_macros::EnumIter;
use thiserror::Error;
use crate::{
checks,
model,
model::{Lints, Problem},
};
/// The lints that are supported
#[derive(Debug, Eq, PartialEq, Copy, Clone, Hash, Ord, PartialOrd, EnumIter)]
pub enum Lint {
/// Check for duplicated trailers
///
/// # Examples
///
/// Passing
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::Lint;
///
/// let message: &str = "An example commit
///
/// This is an example commit without any duplicate trailers
/// "
/// .into();
/// let actual = Lint::DuplicatedTrailers.lint(&CommitMessage::from(message));
/// assert!(actual.is_none(), "Expected None, found {:?}", actual);
/// ```
///
/// Erring
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::{Code, Lint, Problem};
///
/// let message: &str = "An example commit
///
/// This is an example commit without any duplicate trailers
///
/// Signed-off-by: Billie Thompson <email@example.com>
/// Signed-off-by: Billie Thompson <email@example.com>
/// Co-authored-by: Billie Thompson <email@example.com>
/// Co-authored-by: Billie Thompson <email@example.com>
/// "
/// .into();
/// let expected = Some(Problem::new(
/// "Your commit message has duplicated trailers".into(),
/// "These are normally added accidentally when you\'re rebasing or amending to a \
/// commit, sometimes in the text editor, but often by git hooks.\n\nYou can fix \
/// this by deleting the duplicated \"Co-authored-by\", \"Signed-off-by\" fields"
/// .into(),
/// Code::DuplicatedTrailers,
/// &message.into(),
/// Some(vec![
/// ("Duplicated `Co-authored-by`".to_string(), 231, 51),
/// ("Duplicated `Signed-off-by`".to_string(), 128, 50),
/// ]),
/// Some(
/// "https://git-scm.com/docs/githooks#_commit_msg"
/// .parse()
/// .unwrap(),
/// ),
/// ));
/// let actual = Lint::DuplicatedTrailers.lint(&CommitMessage::from(message));
/// assert_eq!(
/// actual, expected,
/// "Expected {:?}, found {:?}",
/// expected, actual
/// );
/// ```
DuplicatedTrailers,
/// Check for a missing pivotal tracker id
///
/// # Examples
///
/// Passing
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::Lint;
///
/// let message: &str = "An example commit [fixes #12345678]
/// "
/// .into();
/// let actual = Lint::PivotalTrackerIdMissing.lint(&CommitMessage::from(message));
/// assert!(actual.is_none(), "Expected None, found {:?}", actual);
/// ```
///
/// Erring
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::{Code, Lint, Problem};
///
/// let message: &str = "An example commit
///
/// This is an example commit
/// "
///
/// .into();
/// let expected = Some(Problem::new(
/// "Your commit message is missing a Pivotal Tracker ID".into(),
/// "It's important to add the ID because it allows code to be linked back to the stories it was done for, it can provide a chain of custody for code for audit purposes, and it can give future explorers of the codebase insight into the wider organisational need behind the change. We may also use it for automation purposes, like generating changelogs or notification emails.\n\nYou can fix this by adding the Id in one of the styles below to the commit message\n[Delivers #12345678]\n[fixes #12345678]\n[finishes #12345678]\n[#12345884 #12345678]\n[#12345884,#12345678]\n[#12345678],[#12345884]\nThis will address [#12345884]"
/// .into(),
/// Code::PivotalTrackerIdMissing,
/// &message.into(),
/// Some(vec![("No Pivotal Tracker ID".to_string(), 19, 26)]),
/// Some("https://www.pivotaltracker.com/help/api?version=v5#Tracker_Updates_in_SCM_Post_Commit_Hooks".parse().unwrap()),
/// ));
/// let actual = Lint::PivotalTrackerIdMissing.lint(&CommitMessage::from(message));
/// assert_eq!(
/// actual, expected,
/// "Expected {:?}, found {:?}",
/// expected, actual
/// );
/// ```
PivotalTrackerIdMissing,
/// Check for a missing jira issue key
///
/// # Examples
///
/// Passing
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::Lint;
///
/// let message: &str = "An example commit
///
/// Relates-to: JRA-123
/// "
/// .into();
/// let actual = Lint::JiraIssueKeyMissing.lint(&CommitMessage::from(message));
/// assert!(actual.is_none(), "Expected None, found {:?}", actual);
/// ```
///
/// Erring
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::{Code, Lint, Problem};
///
/// let message: &str = "An example commit
///
/// This is an example commit
/// "
///
/// .into();
/// let expected = Some(Problem::new(
/// "Your commit message is missing a JIRA Issue Key".into(),
/// "It's important to add the issue key because it allows us to link code back to the motivations for doing it, and in some cases provide an audit trail for compliance purposes.\n\nYou can fix this by adding a key like `JRA-123` to the commit message"
/// .into(),
/// Code::JiraIssueKeyMissing,&message.into(),
/// Some(vec![("No JIRA Issue Key".to_string(), 19, 26)]),
/// Some("https://support.atlassian.com/jira-software-cloud/docs/what-is-an-issue/#Workingwithissues-Projectkeys".parse().unwrap()),
/// ));
/// let actual = Lint::JiraIssueKeyMissing.lint(&CommitMessage::from(message));
/// assert_eq!(
/// actual, expected,
/// "Expected {:?}, found {:?}",
/// expected, actual
/// );
/// ```
JiraIssueKeyMissing,
/// Check for a missing github id
///
/// # Examples
///
/// Passing
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::Lint;
///
/// let message: &str = "An example commit
///
/// Relates-to: AnOrganisation/git-mit#642
/// "
/// .into();
/// let actual = Lint::GitHubIdMissing.lint(&CommitMessage::from(message));
/// assert!(actual.is_none(), "Expected None, found {:?}", actual);
/// ```
///
/// Erring
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::{Code, Lint, Problem};
///
/// let message: &str = "An example commit
///
/// This is an example commit
/// "
///
/// .into();
/// let expected = Some(Problem::new(
/// "Your commit message is missing a GitHub ID".into(),
/// "It's important to add the issue ID because it allows us to link code back to the motivations for doing it, and because we can help people exploring the repository link their issues to specific bits of code.\n\nYou can fix this by adding a ID like the following examples:\n\n#642\nGH-642\nAnUser/git-mit#642\nAnOrganisation/git-mit#642\nfixes #642\n\nBe careful just putting '#642' on a line by itself, as '#' is the default comment character"
/// .into(),
/// Code::GitHubIdMissing,&message.into(),Some(vec![("No GitHub ID".to_string(), 19, 26)]),
/// Some("https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#issues-and-pull-requests".parse().unwrap()),
/// ));
/// let actual = Lint::GitHubIdMissing.lint(&CommitMessage::from(message));
/// assert_eq!(
/// actual, expected,
/// "Expected {:?}, found {:?}",
/// expected, actual
/// );
/// ```
GitHubIdMissing,
/// Subject being not being seperated from the body
///
/// # Examples
///
/// Passing
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::Lint;
///
/// let message: &str = "An example commit
///
/// Some Body Content
/// "
/// .into();
/// let actual = Lint::SubjectNotSeparateFromBody.lint(&CommitMessage::from(message));
/// assert!(actual.is_none(), "Expected None, found {:?}", actual);
/// ```
///
/// Erring
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::{Code, Lint, Problem};
///
/// let message: &str = "An example commit
/// This is an example commit
/// "
/// .into();
/// let expected = Some(Problem::new(
/// "Your commit message is missing a blank line between the subject and the body".into(),
/// "Most tools that render and parse commit messages, expect commit messages to be in the form of subject and body. This includes git itself in tools like git-format-patch. If you don't include this you may see strange behaviour from git and any related tools.\n\nTo fix this separate subject from body with a blank line"
/// .into(),
/// Code::SubjectNotSeparateFromBody,&message.into(),
/// Some(vec![("Missing blank line".to_string(), 18, 25)]),
/// Some("https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines".parse().unwrap()),
/// ));
/// let actual = Lint::SubjectNotSeparateFromBody.lint(&CommitMessage::from(message));
/// assert_eq!(
/// actual, expected,
/// "Expected {:?}, found {:?}",
/// expected, actual
/// );
/// ```
SubjectNotSeparateFromBody,
/// Check for a long subject line
///
/// # Examples
///
/// Passing
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::Lint;
///
/// let message: &str = "An example commit
///
/// Some Body Content
/// "
/// .into();
/// let actual = Lint::SubjectLongerThan72Characters.lint(&CommitMessage::from(message));
/// assert!(actual.is_none(), "Expected None, found {:?}", actual);
/// ```
///
/// Erring
///
/// ```
/// use mit_commit::CommitMessage;
/// use mit_lint::{Code, Lint, Problem};
///
/// let message:String = "x".repeat(73).into();
/// let expected = Some(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,&message.clone().into(),
/// Some(vec![("Too long".to_string(), 73, 1)]),
/// Some("https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines".parse().unwrap()),
/// ));
/// let actual = Lint::SubjectLongerThan72Characters.lint(&CommitMessage::from(message));
/// assert_eq!(
/// actual, expected,
/// "Expected {:?}, found {:?}",
/// expected, actual
/// );
/// ```
SubjectLongerThan72Characters,
/// Check for a non-capitalised subject
///
/// # Examples
///
/// Passing
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::Lint;
///
/// let message: &str = "An example commit\n".into();
/// let actual = Lint::SubjectNotCapitalized.lint(&CommitMessage::from(message));
/// assert!(actual.is_none(), "Expected None, found {:?}", actual);
/// ```
///
/// Erring
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::{Code, Lint, Problem};
///
/// let message: &str =
/// "an example commit\n"
/// .into();
/// let expected = Some(
/// Problem::new(
/// "Your commit message is missing a capital letter".into(),
/// "The subject line is a title, and as such should be capitalised.\n\nYou can fix this by capitalising the first character in the subject".into(),
/// Code::SubjectNotCapitalized,&message.into(),
/// Some(vec![("Not capitalised".to_string(), 0, 1)]),
/// Some("https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines".parse().unwrap()),
/// )
/// );
/// let actual = Lint::SubjectNotCapitalized.lint(&CommitMessage::from(message));
/// assert_eq!(
/// actual, expected,
/// "Expected {:?}, found {:?}",
/// expected, actual
/// );
/// ```
SubjectNotCapitalized,
/// Check for period at the end of the subject
///
/// # Examples
///
/// Passing
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::Lint;
///
/// let message: &str = "An example commit\n".into();
/// let actual = Lint::SubjectEndsWithPeriod.lint(&CommitMessage::from(message));
/// assert!(actual.is_none(), "Expected None, found {:?}", actual);
/// ```
///
/// Erring
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::{Code, Lint, Problem};
///
/// let message: &str =
/// "An example commit.\n".into();
/// let expected = Some(
/// Problem::new(
/// "Your commit message ends with a period".into(),
/// "It's important to keep your commits short, because we only have a limited number of characters to use (72) before the subject line is truncated. Full stops aren't normally in subject lines, and take up an extra character, so we shouldn't use them in commit message subjects.\n\nYou can fix this by removing the period"
/// .into(),
/// Code::SubjectEndsWithPeriod,&message.into(),
/// Some(vec![("Unneeded period".to_string(), 17, 1)]),
/// Some("https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines".parse().unwrap()),
/// )
/// );
/// let actual = Lint::SubjectEndsWithPeriod.lint(&CommitMessage::from(message));
/// assert_eq!(
/// actual, expected,
/// "Expected {:?}, found {:?}",
/// expected, actual
/// );
/// ```
SubjectEndsWithPeriod,
/// Check for a long body line
///
/// # Examples
///
/// Passing
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::Lint;
///
/// let message: &str = "An example commit\n\nSome Body Content\n".into();
/// let actual = Lint::BodyWiderThan72Characters.lint(&CommitMessage::from(message));
/// assert!(actual.is_none(), "Expected None, found {:?}", actual);
/// ```
///
/// Erring
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::{Code, Lint, Problem};
///
/// let message:String = ["Subject".to_string(), "x".repeat(73).into()].join("\n\n");
/// let expected = Some(Problem::new(
/// "Your commit has a body wider than 72 characters".into(),
/// "It's important to keep the body of the commit narrower 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\nYou can fix this by making the lines in your body no more than 72 characters"
/// .into(),
/// Code::BodyWiderThan72Characters,&message.clone().into(),
/// Some(vec![("Too long".parse().unwrap(), 81, 1)]),
/// Some("https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines".parse().unwrap())
/// ));
/// let actual = Lint::BodyWiderThan72Characters.lint(&CommitMessage::from(message));
/// assert_eq!(
/// actual, expected,
/// "Expected {:?}, found {:?}",
/// expected, actual
/// );
/// ```
BodyWiderThan72Characters,
/// Check for commits following the conventional standard
///
/// # Examples
///
/// Passing
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::Lint;
///
/// let message: &str = "refactor: An example commit\n\nSome Body Content\n".into();
/// let actual = Lint::NotConventionalCommit.lint(&CommitMessage::from(message));
/// assert!(actual.is_none(), "Expected None, found {:?}", actual);
/// ```
///
/// Erring
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::{Code, Lint, Problem};
///
/// let message: &str =
/// "An example commit\n\nSome Body Content\n"
/// .into();
/// let expected = Some(Problem::new(
/// "Your commit message isn't in conventional style".into(),
/// "It's important to follow the conventional commit style when creating your commit message. By using this style we can automatically calculate the version of software using deployment pipelines, and also generate changelogs and other useful information without human interaction.\n\nYou can fix it by following style\n\n<type>[optional scope]: <description>\n\n[optional body]\n\n[optional footer(s)]"
/// .into(),
/// Code::NotConventionalCommit,&message.into(),Some(vec![("Not conventional".to_string(), 0, 17)]),Some("https://www.conventionalcommits.org/".to_string()),
/// ));
/// let actual = Lint::NotConventionalCommit.lint(&CommitMessage::from(message));
/// assert_eq!(
/// actual, expected,
/// "Expected {:?}, found {:?}",
/// expected, actual
/// );
/// ```
NotConventionalCommit,
/// Check for commits following the emoji log standard
///
/// # Examples
///
/// Passing
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::Lint;
///
/// let message: &str = "📖 DOC: An example commit\n\nSome Body Content\n".into();
/// let actual = Lint::NotEmojiLog.lint(&CommitMessage::from(message));
/// assert!(actual.is_none(), "Expected None, found {:?}", actual);
/// ```
///
/// Erring
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::{Code, Lint, Problem};
///
/// let message: &str =
/// "An example commit\n\nSome Body Content\n"
/// .into();
/// let expected = Some(
/// Problem::new(
/// "Your commit message isn't in emoji log style".into(),
/// "It's important to follow the emoji log style when creating your commit message. By using this style we can automatically generate changelogs.\n\nYou can fix it using one of the prefixes:\n\n\n📦 NEW:\n👌 IMPROVE:\n🐛 FIX:\n📖 DOC:\n🚀 RELEASE:\n🤖 TEST:\n‼\u{fe0f} BREAKING:"
/// .into(),
/// Code::NotEmojiLog,&message.into(),Some(vec![("Not emoji log".to_string(), 0, 17)]),Some("https://github.com/ahmadawais/Emoji-Log".to_string()),
/// ));
/// let actual = Lint::NotEmojiLog.lint(&CommitMessage::from(message));
/// assert_eq!(
/// actual, expected,
/// "Expected {:?}, found {:?}",
/// expected, actual
/// );
/// ```
NotEmojiLog,
}
/// The prefix we put in front of the lint when serialising
pub const CONFIG_KEY_PREFIX: &str = "mit.lint";
impl std::convert::TryFrom<&str> for Lint {
type Error = Error;
fn try_from(from: &str) -> Result<Self, Self::Error> {
Self::all_lints()
.zip(Self::all_lints().map(|lint| format!("{}", lint)))
.filter_map(|(lint, name): (Self, String)| if name == from { Some(lint) } else { None })
.collect::<Vec<Self>>()
.first()
.copied()
.ok_or_else(|| Error::new_lint_not_found(from.into()))
}
}
impl std::convert::From<Lint> for String {
fn from(from: Lint) -> Self {
format!("{}", from)
}
}
impl From<Lint> for &str {
fn from(lint: Lint) -> Self {
lint.name()
}
}
impl Lint {
/// Get an lint's unique name
#[must_use]
pub const fn name(self) -> &'static str {
match self {
Lint::DuplicatedTrailers => checks::duplicate_trailers::CONFIG,
Lint::PivotalTrackerIdMissing => checks::missing_pivotal_tracker_id::CONFIG,
Lint::JiraIssueKeyMissing => checks::missing_jira_issue_key::CONFIG,
Lint::GitHubIdMissing => checks::missing_github_id::CONFIG,
Lint::SubjectNotSeparateFromBody => checks::subject_not_separate_from_body::CONFIG,
Lint::SubjectLongerThan72Characters => {
checks::subject_longer_than_72_characters::CONFIG
}
Lint::SubjectNotCapitalized => checks::subject_not_capitalized::CONFIG,
Lint::SubjectEndsWithPeriod => checks::subject_line_ends_with_period::CONFIG,
Lint::BodyWiderThan72Characters => checks::body_wider_than_72_characters::CONFIG,
Lint::NotConventionalCommit => checks::not_conventional_commit::CONFIG,
Lint::NotEmojiLog => checks::not_emoji_log::CONFIG,
}
}
}
lazy_static! {
/// All the available lints
static ref ALL_LINTS: [Lint; 11] = [
Lint::DuplicatedTrailers,
Lint::PivotalTrackerIdMissing,
Lint::JiraIssueKeyMissing,
Lint::SubjectNotSeparateFromBody,
Lint::GitHubIdMissing,
Lint::SubjectLongerThan72Characters,
Lint::SubjectNotCapitalized,
Lint::SubjectEndsWithPeriod,
Lint::BodyWiderThan72Characters,
Lint::NotConventionalCommit,
Lint::NotEmojiLog,
];
/// The ones that are enabled by default
static ref DEFAULT_ENABLED_LINTS: [Lint; 4] = [
Lint::DuplicatedTrailers,
Lint::SubjectNotSeparateFromBody,
Lint::SubjectLongerThan72Characters,
Lint::BodyWiderThan72Characters,
];
}
impl Lint {
/// Iterator over all the lints
///
/// # Examples
///
/// ```rust
/// use mit_lint::Lint;
/// assert!(Lint::all_lints().next().is_some())
/// ```
pub fn all_lints() -> impl Iterator<Item = Self> {
ALL_LINTS.iter().copied()
}
/// Iterator over all the lints
///
/// # Examples
///
/// ```rust
/// use mit_lint::Lint;
/// assert!(Lint::iterator().next().is_some())
/// ```
#[deprecated(since = "0.1.5", note = "iterator was an unusual name. Use all_lints")]
pub fn iterator() -> impl Iterator<Item = Self> {
Self::all_lints()
}
/// Check if a lint is enabled by default
///
/// # Examples
///
/// ```rust
/// use mit_lint::Lint;
/// assert!(Lint::SubjectNotSeparateFromBody.enabled_by_default());
/// assert!(!Lint::NotConventionalCommit.enabled_by_default());
/// ```
#[must_use]
pub fn enabled_by_default(self) -> bool {
DEFAULT_ENABLED_LINTS.contains(&self)
}
/// Get a key suitable for a configuration document
///
/// # Examples
///
/// ```rust
/// use mit_lint::Lint;
/// assert_eq!(
/// Lint::SubjectNotSeparateFromBody.config_key(),
/// "mit.lint.subject-not-separated-from-body"
/// );
/// ```
#[must_use]
pub fn config_key(self) -> String {
format!("{}.{}", CONFIG_KEY_PREFIX, self)
}
/// Run this lint on a commit message
///
/// # Examples
///
/// ```rust
/// use mit_commit::CommitMessage;
/// use mit_lint::Lint;
/// let actual =
/// Lint::NotConventionalCommit.lint(&CommitMessage::from("An example commit message"));
/// assert!(actual.is_some());
/// ```
#[must_use]
pub fn lint(self, commit_message: &CommitMessage<'_>) -> Option<Problem> {
match self {
Lint::DuplicatedTrailers => checks::duplicate_trailers::lint(commit_message),
Lint::PivotalTrackerIdMissing => {
checks::missing_pivotal_tracker_id::lint(commit_message)
}
Lint::JiraIssueKeyMissing => checks::missing_jira_issue_key::lint(commit_message),
Lint::GitHubIdMissing => checks::missing_github_id::lint(commit_message),
Lint::SubjectNotSeparateFromBody => {
checks::subject_not_separate_from_body::lint(commit_message)
}
Lint::SubjectLongerThan72Characters => {
checks::subject_longer_than_72_characters::lint(commit_message)
}
Lint::SubjectNotCapitalized => checks::subject_not_capitalized::lint(commit_message),
Lint::SubjectEndsWithPeriod => {
checks::subject_line_ends_with_period::lint(commit_message)
}
Lint::BodyWiderThan72Characters => {
checks::body_wider_than_72_characters::lint(commit_message)
}
Lint::NotConventionalCommit => checks::not_conventional_commit::lint(commit_message),
Lint::NotEmojiLog => checks::not_emoji_log::lint(commit_message),
}
}
/// Try and convert a list of names into lints
///
/// # Examples
///
/// ```rust
/// use mit_lint::Lint;
/// let actual = Lint::from_names(vec!["not-emoji-log", "body-wider-than-72-characters"]);
/// assert_eq!(
/// actual.unwrap(),
/// vec![Lint::BodyWiderThan72Characters, Lint::NotEmojiLog]
/// );
/// ```
///
/// # Errors
/// If the lint does not exist
pub fn from_names(names: Vec<&str>) -> Result<Vec<Self>, model::lints::Error> {
let lints: Lints = names.try_into()?;
Ok(lints.into_iter().collect())
}
}
impl Arbitrary for Lint {
fn arbitrary(g: &mut Gen) -> Self {
*g.choose(&ALL_LINTS.iter().copied().collect::<Vec<_>>())
.unwrap()
}
fn shrink(&self) -> Box<dyn Iterator<Item = Self>> {
let index = ALL_LINTS.iter().position(|other| self.eq(other));
match index {
None | Some(0) => quickcheck::empty_shrinker(),
Some(index) => ALL_LINTS
.get(index - 1)
.map_or(quickcheck::empty_shrinker(), |item| {
quickcheck::single_shrinker(*item)
}),
}
}
}
impl std::fmt::Display for Lint {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.name())
}
}
/// Errors
#[derive(Error, Debug, Diagnostic)]
pub enum Error {
/// Lint not found
#[error("Lint not found: {0}")]
#[diagnostic(
code(mit_lint::model::lint::error::LintNotFound),
url(docsrs),
help("check the list of available lints")
)]
LintNotFound(#[source_code] String, #[label("Not found")] (usize, usize)),
}
impl Error {
fn new_lint_not_found(missing_lint: String) -> Self {
let length = missing_lint.len();
Self::LintNotFound(missing_lint, (0, length))
}
}