Linting cleanup

Author: mschenk42

command/record.go

@@ -28,7 +28,7 @@ type RecordCmd struct {
 	Out *bytes.Buffer
 }
 
-func (c RecordCmd) Output(s string) {
+func (c RecordCmd) output(s string) {
 	if c.Out != nil {
 		fmt.Fprint(c.Out, s)
 	} else {
@@ -113,7 +113,7 @@ func (c RecordCmd) Run(args []string) int {
 			c.Ui.Error(err.Error())
 			return 1
 		}
-		c.Output(out)
+		c.output(out)
 	}
 
 	return 0

command/verify.go

@@ -22,7 +22,7 @@ type VerifyCmd struct {
 	Out     *bytes.Buffer
 }
 
-func (c VerifyCmd) Output(s string) {
+func (c VerifyCmd) output(s string) {
 	if c.Out != nil {
 		fmt.Fprint(c.Out, s)
 	} else {
@@ -59,7 +59,7 @@ func (c VerifyCmd) Run(args []string) int {
 		return 1
 	}
 
-	c.Output(fmt.Sprintf("%t", valid))
+	c.output(fmt.Sprintf("%t", valid))
 	return 0
 }
 

report/report.go

@@ -73,7 +73,7 @@ func Status(n note.CommitNote, options OutputOptions, projPath ...string) (strin
 
 	b := new(bytes.Buffer)
 	t := template.Must(template.New("Status").Funcs(funcMap).Parse(statusTpl))
-	cf := ColorFormater{color: options.Color}
+	cf := colorFormater{color: options.Color}
 	err := t.Execute(
 		b,
 		struct {
@@ -86,7 +86,7 @@ func Status(n note.CommitNote, options OutputOptions, projPath ...string) (strin
 			projPath,
 			projName,
 			commitNoteDetail{Note: n},
-			cf.White(true),
+			cf.white(true),
 			tags,
 		})
 
@@ -107,7 +107,7 @@ func CommitSummary(projects []ProjectCommits, options OutputOptions) (string, er
 
 	b := new(bytes.Buffer)
 	t := template.Must(template.New("Commits").Funcs(funcMap).Parse(commitSummaryTpl))
-	cf := ColorFormater{color: options.Color}
+	cf := colorFormater{color: options.Color}
 	err := t.Execute(
 		b,
 		struct {
@@ -116,8 +116,8 @@ func CommitSummary(projects []ProjectCommits, options OutputOptions) (string, er
 			GreenFormat string
 		}{
 			lines,
-			cf.White(true),
-			cf.Green(false),
+			cf.white(true),
+			cf.green(false),
 		})
 	if err != nil {
 		return "", err
@@ -134,7 +134,7 @@ func Commits(projects []ProjectCommits, options OutputOptions) (string, error) {
 
 	b := new(bytes.Buffer)
 	t := template.Must(template.New("CommitSummary").Funcs(funcMap).Parse(commitsTpl))
-	cf := ColorFormater{color: options.Color}
+	cf := colorFormater{color: options.Color}
 	err := t.Execute(
 		b,
 		struct {
@@ -145,8 +145,8 @@ func Commits(projects []ProjectCommits, options OutputOptions) (string, error) {
 		}{
 			options.FullMessage,
 			notes,
-			cf.White(true),
-			cf.Green(false),
+			cf.white(true),
+			cf.green(false),
 		})
 	if err != nil {
 		return "", err
@@ -169,7 +169,7 @@ func Timeline(projects []ProjectCommits, options OutputOptions) (string, error)
 
 	b := new(bytes.Buffer)
 	t := template.Must(template.New("Timeline").Funcs(funcMap).Parse(timelineTpl))
-	cf := ColorFormater{color: options.Color}
+	cf := colorFormater{color: options.Color}
 	err = t.Execute(
 		b,
 		struct {
@@ -178,8 +178,8 @@ func Timeline(projects []ProjectCommits, options OutputOptions) (string, error)
 			GreenFormat string
 		}{
 			timeline,
-			cf.White(true),
-			cf.Green(false),
+			cf.white(true),
+			cf.green(false),
 		})
 	if err != nil {
 		return "", err
@@ -202,7 +202,7 @@ func TimelineCommits(projects []ProjectCommits, options OutputOptions) (string,
 
 	b := new(bytes.Buffer)
 	t := template.Must(template.New("Timeline").Funcs(funcMap).Parse(timelineCommitTpl))
-	cf := ColorFormater{color: options.Color}
+	cf := colorFormater{color: options.Color}
 	err = t.Execute(
 		b,
 		struct {
@@ -211,8 +211,8 @@ func TimelineCommits(projects []ProjectCommits, options OutputOptions) (string,
 			GreenFormat string
 		}{
 			timeline,
-			cf.White(true),
-			cf.Green(false),
+			cf.white(true),
+			cf.green(false),
 		})
 	if err != nil {
 		return "", err
@@ -244,31 +244,31 @@ func Files(projects []ProjectCommits, options OutputOptions) (string, error) {
 
 }
 
-type ColorFormater struct {
+type colorFormater struct {
 	color bool
 }
 
-func (c ColorFormater) HasColor() bool {
+func (c colorFormater) hasColor() bool {
 	return (c.color || isatty.IsTerminal(os.Stdout.Fd())) && runtime.GOOS != "windows"
 }
 
-func (c ColorFormater) White(bold bool) string {
+func (c colorFormater) white(bold bool) string {
 	var attrBold int
 	if bold {
 		attrBold = 1
 	}
-	if c.HasColor() {
+	if c.hasColor() {
 		return fmt.Sprintf("\033[%d;%dm%%s\033[0m", attrBold, 97)
 	}
 	return "%s"
 }
 
-func (c ColorFormater) Green(bold bool) string {
+func (c colorFormater) green(bold bool) string {
 	var attrBold int
 	if bold {
 		attrBold = 1
 	}
-	if c.HasColor() {
+	if c.hasColor() {
 		return fmt.Sprintf("\033[%d;%dm%%s\033[0m", attrBold, 32)
 	}
 	return "%s"

util/date.go

@@ -15,19 +15,23 @@ import (
 // This allows for manipulating system time during testing
 var Now = func() time.Time { return time.Now() }
 
+// DataRange creates predefined date ranges and validates if dates are within the range
 type DateRange struct {
 	Start time.Time
 	End   time.Time
 }
 
+// IsSet returns true if the date range has a starting and/or ending date
 func (d DateRange) IsSet() bool {
 	return !d.Start.IsZero() || !d.End.IsZero()
 }
 
+// String returns a date range as a string
 func (d DateRange) String() string {
 	return fmt.Sprintf("%s - %s", d.Start.Format(time.UnixDate), d.End.Format(time.UnixDate))
 }
 
+// Within determines if a date is within the date range
 func (r DateRange) Within(t time.Time) bool {
 	switch {
 	case !r.Start.IsZero() && !r.End.IsZero():
@@ -42,11 +46,13 @@ func (r DateRange) Within(t time.Time) bool {
 
 }
 
+// AfterNow returns a date range ending n days in the past
 func AfterNow(n int) DateRange {
 	end := now.New(Now()).EndOfDay().AddDate(0, 0, -n)
 	return DateRange{End: end}
 }
 
+// TodayRange returns a date range for today
 func TodayRange() DateRange {
 	now := now.New(Now())
 
@@ -56,6 +62,7 @@ func TodayRange() DateRange {
 	return DateRange{Start: start, End: end}
 }
 
+// YesterdayRange returns a date range for yesterday
 func YesterdayRange() DateRange {
 	now := now.New(Now())
 
@@ -65,6 +72,7 @@ func YesterdayRange() DateRange {
 	return DateRange{Start: start, End: end}
 }
 
+// ThisWeekRange returns a date range for this week
 func ThisWeekRange() DateRange {
 	now := now.New(Now())
 
@@ -74,6 +82,7 @@ func ThisWeekRange() DateRange {
 	return DateRange{End: end, Start: start}
 }
 
+// LastWeekRange returns a date for last week
 func LastWeekRange() DateRange {
 	now := now.New(Now())
 
@@ -83,6 +92,7 @@ func LastWeekRange() DateRange {
 	return DateRange{End: end, Start: start}
 }
 
+// ThisMonthRange returns a date range for this month
 func ThisMonthRange() DateRange {
 	now := now.New(Now())
 
@@ -92,6 +102,7 @@ func ThisMonthRange() DateRange {
 	return DateRange{End: end, Start: start}
 }
 
+// LastMonthRange returns a date range for last month
 func LastMonthRange() DateRange {
 	now := now.New(Now())
 
@@ -101,6 +112,7 @@ func LastMonthRange() DateRange {
 	return DateRange{End: end, Start: start}
 }
 
+// ThisYearRange returns a date range for this year
 func ThisYearRange() DateRange {
 	now := now.New(Now())
 
@@ -110,6 +122,7 @@ func ThisYearRange() DateRange {
 	return DateRange{End: end, Start: start}
 }
 
+// LastYearRange returns a date range for last year
 func LastYearRange() DateRange {
 	now := now.New(Now())