-
Notifications
You must be signed in to change notification settings - Fork 13
/
filters.go
119 lines (98 loc) · 2.67 KB
/
filters.go
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
// Copyright 2019 George Aristy
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package issues
import (
"fmt"
"regexp"
"github.com/llorllale/go-gitlint/internal/commits"
)
// Filter identifies an issue with a commit.
// A filter returning a zero-valued Issue signals that it found no issue
// with the commit.
type Filter func(*commits.Commit) Issue
// OfSubjectRegex tests a commit's subject with the regex.
func OfSubjectRegex(regex string) Filter {
return func(c *commits.Commit) Issue {
var issue Issue
matched, err := regexp.MatchString(regex, c.Subject())
if err != nil {
panic(err)
}
if !matched {
issue = Issue{
Desc: fmt.Sprintf("subject does not match regex [%s]", regex),
Commit: *c,
}
}
return issue
}
}
// OfBodyRegex tests a commit's body with the regex.
func OfBodyRegex(regex string) Filter {
return func(c *commits.Commit) Issue {
var issue Issue
matched, err := regexp.MatchString(regex, c.Body())
if err != nil {
panic(err)
}
if !matched {
issue = Issue{
Desc: fmt.Sprintf("body does not conform to regex [%s]", regex),
Commit: *c,
}
}
return issue
}
}
// OfSubjectMaxLength checks that a commit's subject does not exceed this length.
func OfSubjectMaxLength(length int) Filter {
return func(c *commits.Commit) Issue {
var issue Issue
if len(c.Subject()) > length {
issue = Issue{
Desc: fmt.Sprintf("subject length exceeds max [%d]", length),
Commit: *c,
}
}
return issue
}
}
// OfSubjectMinLength checks that a commit's subject's length is at least
// of length min.
func OfSubjectMinLength(min int) Filter {
return func(c *commits.Commit) Issue {
var issue Issue
if len(c.Subject()) < min {
issue = Issue{
Desc: fmt.Sprintf("subject length less than min [%d]", min),
Commit: *c,
}
}
return issue
}
}
// OfBodyMaxLength checks that a commit's body's length doesn't exceed this
// max number of characters.
func OfBodyMaxLength(max int) Filter {
return func(c *commits.Commit) Issue {
var issue Issue
if len(c.Body()) > max {
issue = Issue{
Desc: fmt.Sprintf("body length exceeds max [%d]", max),
Commit: *c,
}
}
return issue
}
}