-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #18 from NeowayLabs/add-commit-lint-option
type: [feat], message: Add commit lint option.
- Loading branch information
Showing
16 changed files
with
997 additions
and
273 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -123,4 +123,4 @@ githooks: | |
| @echo "git hooks copied" | ||
|
|
||
| shell: modcache imagedev | ||
| $(run) sh | ||
| $(run) sh | ||
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| package commitmessage | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
| ) | ||
|
|
||
| type Logger interface { | ||
| Info(s string, args ...interface{}) | ||
| Error(s string, args ...interface{}) | ||
| Warn(s string, args ...interface{}) | ||
| } | ||
|
|
||
| type CommitType interface { | ||
| GetAll() []string | ||
| GetMajorUpgrade() []string | ||
| GetMinorUpgrade() []string | ||
| GetPatchUpgrade() []string | ||
| GetSkipVersioning() []string | ||
| GetCommitChangeType(commitMessage string) (string, error) | ||
| IndexNotFound(index int) bool | ||
| } | ||
|
|
||
| type CommitMessage struct { | ||
| log Logger | ||
| commitType CommitType | ||
| } | ||
|
|
||
| func (f *CommitMessage) isMessageLongerThanLimit(message string) bool { | ||
| return len(message) >= 150 | ||
| } | ||
|
|
||
| func (f *CommitMessage) upperFirstLetterOfSentence(text string) string { | ||
| return fmt.Sprintf("%s%s", strings.ToUpper(text[:1]), text[1:]) | ||
| } | ||
|
|
||
| // prettifyCommitMessage aims to keep a short message based on the commit message, removing extra information such as commit type. | ||
| // Args: | ||
| // | ||
| // commitMessage (string): Full commit message. | ||
| // | ||
| // Returns: | ||
| // | ||
| // string: Returns a commit message with limmited number of characters. | ||
| // err: Error whenever unexpected issues happen. | ||
| func (f *CommitMessage) PrettifyCommitMessage(commitMessage string) (string, error) { | ||
| splitedMessage := strings.Split(commitMessage, "\n") | ||
|
|
||
| message := "" | ||
| for _, row := range splitedMessage { | ||
| index := strings.Index(row, ":") | ||
|
|
||
| if f.commitType.IndexNotFound(index) || row == "" { | ||
| continue | ||
| } | ||
|
|
||
| commitTypeScope := strings.ToLower(row[:index]) | ||
|
|
||
| for _, changeType := range f.commitType.GetAll() { | ||
| if strings.Contains(commitTypeScope, changeType) { | ||
| message = strings.TrimSpace(strings.Replace(row[index:], ":", "", 1)) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if message == "" { | ||
| return "", errors.New("commit message is empty") | ||
| } | ||
|
|
||
| if f.isMessageLongerThanLimit(message) { | ||
| message = fmt.Sprintf("%s...", message[:150]) | ||
| } | ||
|
|
||
| return f.upperFirstLetterOfSentence(message), nil | ||
| } | ||
|
|
||
| func (f *CommitMessage) IsValidMessage(message string) bool { | ||
| index := strings.Index(message, ":") | ||
|
|
||
| if f.commitType.IndexNotFound(index) { | ||
| f.log.Error("commit message out of pattern") | ||
| return false | ||
| } | ||
|
|
||
| if message == "" || message[index:] == ":" { | ||
| f.log.Error("commit message cannot be empty") | ||
| return false | ||
| } | ||
|
|
||
| _, err := f.commitType.GetCommitChangeType(message) | ||
| if err != nil { | ||
| if err.Error() == "change type not found" { | ||
| f.log.Error("change type not found") | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| return true | ||
| } | ||
|
|
||
| func New(log Logger, commitType CommitType) *CommitMessage { | ||
| return &CommitMessage{ | ||
| log: log, | ||
| commitType: commitType, | ||
| } | ||
| } |
Oops, something went wrong.