User defined commit message templates #40
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ccoVeille
reviewed
Aug 28, 2024
Comment on lines
+45
to
+54
| var messageTemplate, messageWithTicketTemplate string | ||
| if c.MessageTemplate == nil { | ||
| messageTemplate = defaultMessageTemplate | ||
| } else { | ||
| messageTemplate, err = config.ConvertTemplate(*c.MessageTemplate) | ||
| if err != nil { | ||
| log.Error("Error converting message template", "error", err) | ||
| messageTemplate = defaultMessageTemplate | ||
| } | ||
| } |
There was a problem hiding this comment.
This might ne essier to reader
Suggested change
| var messageTemplate, messageWithTicketTemplate string | |
| if c.MessageTemplate == nil { | |
| messageTemplate = defaultMessageTemplate | |
| } else { | |
| messageTemplate, err = config.ConvertTemplate(*c.MessageTemplate) | |
| if err != nil { | |
| log.Error("Error converting message template", "error", err) | |
| messageTemplate = defaultMessageTemplate | |
| } | |
| } | |
| var messageWithTicketTemplate string | |
| messageTemplate = defaultMessageTemplate | |
| if c.MessageTemplate != nil { | |
| messageTemplate, err = config.ConvertTemplate(*c.MessageTemplate) | |
| if err != nil { | |
| log.Error("Error converting message template", "error", err) | |
| messageTemplate = defaultMessageTemplate | |
| } | |
| } |
Comment on lines
+57
to
+65
| if c.MessageWithTicketTemplate == nil { | ||
| messageWithTicketTemplate = defaultMessageWithTicketTemplate | ||
| } else { | ||
| messageWithTicketTemplate, err = config.ConvertTemplate(*c.MessageWithTicketTemplate) | ||
| if err != nil { | ||
| log.Error("Error converting message with ticket template", "error", err) | ||
| messageWithTicketTemplate = defaultMessageWithTicketTemplate | ||
| } | ||
| } |
There was a problem hiding this comment.
You could apply the same pattern I described here
| @@ -85,7 +86,7 @@ func main() { | |||
| fail("Could not change directory: %s", err) | |||
| } | |||
|
|
|||
| prefixes, coauthors, boards, showIntro, commitTitleCharLimit, err := loadConfig(AFS) | |||
| prefixes, coauthors, boards, showIntro, commitTitleCharLimit, messageTemplate, messageWithTicketTemplate, err := loadConfig(AFS) | |||
There was a problem hiding this comment.
You could consider returning a struct, there are way too much returned values
| if !strings.Contains(t, "@type") || !strings.Contains(t, "@message") { | ||
| return t, fmt.Errorf("template must contain @type and @message") | ||
| } | ||
| t = strings.Replace(t, ":", "{{if .IsBreakingChange}}!{{end}}:", 1) |
There was a problem hiding this comment.
Your template system might be "hacked" if someone provide a `{{ whatever }}`` syntax
Maybe you could forbid the presence of {{ in the template
Merged
|
@ccoVeille thanks for the review! unfortunately I had already merged this code, but I've created a new PR addressing the issues raised here #41, would be great if you could have a look when you have some time! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds two new config options (
messageTemplateandmessageWithTicketTemplate), which allow the user to provide their own custom commit message templates.If no templates are provided, defaults which are the same as before are used to ensure backwards compatibility for all users.