Skip to content

fix: prefer description over BREAKING CHANGE #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ttd2089 wants to merge 1 commit into
base: master
Choose a base branch
from
+18 −5
Open

fix: prefer description over BREAKING CHANGE #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions src/commit.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,12 @@ impl<'a> Commit<'a> {
.parse(string)
.map_err(|err| Error::with_nom(string, err))?;

let breaking_description = footers
.iter()
.filter_map(|(k, _, v)| (k == &BREAKING_PHRASE || k == &BREAKING_ARROW).then_some(*v))
.next()
.or_else(|| breaking.then_some(description));
let breaking_description = breaking.then_some(description)
.or_else(|| footers
.iter()
.filter_map(|(k, _, v)| (k == &BREAKING_PHRASE || k == &BREAKING_ARROW).then_some(*v))
.next());

let breaking = breaking_description.is_some();
let footers: Result<Vec<_>, Error> = footers
.into_iter()
Expand Down Expand Up @@ -474,6 +475,18 @@ mod test {
assert_eq!("it's broken", commit.footers().get(0).unwrap().value());
assert!(commit.breaking());
assert_eq!(commit.breaking_description(), Some("it's broken"));

let commit = Commit::parse(indoc!(
"feat!: this is a breaking change

BREAKING-CHANGE: If ! is used, BREAKING CHANGE: MAY be omitted from
the footer section, and the commit description SHALL be used to describe
the breaking change."
))
.unwrap();
assert_eq!(Type::FEAT, commit.type_());
assert!(commit.breaking());
assert_eq!(commit.breaking_description(), Some("this is a breaking change"));
}

#[test]
Expand Down