Change scope with commit_parsers

[tlackemann]

Is your feature request related to a problem? Please describe.
In a monorepo, I that have a folder with the name "www", however, since I am using git-cliff to generate a public-facing changelog, I would wish for this to be displayed as "Application" when generated.

I am using template replace functions to replace "www" with "Application" but would like the ability to change this in the commit_parsers.

Describe the solution you'd like
commit_parsers should allow changing of the scope on-demand. For example:

commit_parsers = [
  { message = "(www)", scope = "Application" }
]

Describe alternatives you've considered
N/A

Additional context
Thanks for an awesome project!

[tlackemann]

I took a look through the code and have an idea of how this might be implemented. Are you interested in a PR to address this? I'm open to advice/guidance on how you might like to see this implemented.

[orhun]

Hello, thanks for the nice suggestion! It definitely makes sense to support overriding the scope of commits.

I took a look through the code and have an idea of how this might be implemented. Are you interested in a PR to address this? I'm open to advice/guidance on how you might like to see this implemented.

Sure, that'd be nice. The current workflow is:

1. If a commit parser matches a commit, it sets the group and scope (default_scope):

git-cliff/git-cliff-core/src/commit.rs

Lines 122 to 123 in 2be04f8

	self.group = parser.group.as_ref().cloned();
	self.scope = parser.default_scope.as_ref().cloned();

2. While serializing, scope is used if conventional commit parser returns an empty (None) scope:

git-cliff/git-cliff-core/src/commit.rs

Line 200 in 2be04f8

&conv.scope().map(|v| v.as_str()).or(self.scope.as_deref()),

So first, I'd rename Commit::scope to Commit::default_scope to avoid confusion in the future 😄 Then add scope: Option<String> to both Commit and CommitParser structs and set the scope in Commit::parse.

And then while serializing, you can construct a logic like this:

commit.serialize_field(
    "scope",
    &self.scope.as_deref().or_else(|| conv.scope().map(|v| v.as_str())).or(self.default_scope.as_deref())
)?;

This will first check if there is a custom scope set, then tries to get the scope from conventional parser and then uses the default scope as a last resort.

This is how I'd implement it. Unfortunately, having default_scope makes things a bit complicated since everything is handled during the serialization. Let me know if you have any other ideas and feel free to submit a PR! 🐻

[tlackemann]

Thanks for the thoughtful reply! No promises on a timeline but I'll take a crack at this soon and see if I can't get something pushed and reviewed.

Thank you again!

[orhun]

No problem! Let me know if there is something that I can help with.

[orhun]

I will be working on this for the upcoming release if no one wants to dive into it 🐻 LMK