Merge pull request #88 from github/remove-lint

Do a bunch of linter-inspired cleanups

Author: mhagger

counts/counts.go

@@ -4,21 +4,25 @@ import (
 	"math"
 )
 
-// A count of something, capped at math.MaxUint32.
+// Count32 is a count of something, capped at math.MaxUint32.
 type Count32 uint32
 
+// NewCount32 initializes a Count32 from a uint64, capped at
+// math.MaxUint32.
 func NewCount32(n uint64) Count32 {
 	if n > math.MaxUint32 {
 		return Count32(math.MaxUint32)
 	}
 	return Count32(n)
 }
 
+// ToUint64 returns the value of `n` as a `uint64`. If the value has
+// overflowed, it returns `(math.MaxUint32, true)`.
 func (n Count32) ToUint64() (uint64, bool) {
 	return uint64(n), n == math.MaxUint32
 }
 
-// Return the sum of two Count32s, capped at math.MaxUint32.
+// Plus returns the sum of two Count32s, capped at math.MaxUint32.
 func (n1 Count32) Plus(n2 Count32) Count32 {
 	n := n1 + n2
 	if n < n1 {
@@ -28,45 +32,48 @@ func (n1 Count32) Plus(n2 Count32) Count32 {
 	return n
 }
 
-// Increment `*n1` by `n2`, capped at math.MaxUint32.
+// Increment increases `*n1` by `n2`, capped at math.MaxUint32.
 func (n1 *Count32) Increment(n2 Count32) {
 	*n1 = n1.Plus(n2)
 }
 
 // AdjustMaxIfNecessary adjusts `*n1` to be `max(*n1, n2)`. Return
 // true iff `n2` was greater than `*n1`.
 func (n1 *Count32) AdjustMaxIfNecessary(n2 Count32) bool {
-	if n2 > *n1 {
-		*n1 = n2
-		return true
-	} else {
+	if n2 <= *n1 {
 		return false
 	}
+
+	*n1 = n2
+	return true
 }
 
 // AdjustMaxIfPossible adjusts `*n1` to be `max(*n1, n2)`. Return true
 // iff `n2` was greater than or equal to `*n1`.
 func (n1 *Count32) AdjustMaxIfPossible(n2 Count32) bool {
-	if n2 >= *n1 {
-		*n1 = n2
-		return true
-	} else {
+	if n2 < *n1 {
 		return false
 	}
+
+	*n1 = n2
+	return true
 }
 
-// A count of something, capped at math.MaxUint64.
+// Count64 is a count of something, capped at math.MaxUint64.
 type Count64 uint64
 
+// NewCount64 initializes a Count64 from a uint64.
 func NewCount64(n uint64) Count64 {
 	return Count64(n)
 }
 
+// ToUint64 returns the value of `n` as a `uint64`. If the value has
+// overflowed, it returns `(math.MaxUint64, true)`.
 func (n Count64) ToUint64() (uint64, bool) {
 	return uint64(n), n == math.MaxUint64
 }
 
-// Return the sum of two Count64s, capped at math.MaxUint64.
+// Plus returns the sum of two Count64s, capped at math.MaxUint64.
 func (n1 Count64) Plus(n2 Count64) Count64 {
 	n := n1 + n2
 	if n < n1 {
@@ -76,29 +83,29 @@ func (n1 Count64) Plus(n2 Count64) Count64 {
 	return n
 }
 
-// Increment `*n1` by `n2`, capped at math.MaxUint64.
+// Increment increases `*n1` by `n2`, capped at math.MaxUint64.
 func (n1 *Count64) Increment(n2 Count64) {
 	*n1 = n1.Plus(n2)
 }
 
 // AdjustMaxIfNecessary adjusts `*n1` to be `max(*n1, n2)`. Return
 // true iff `n2` was greater than `*n1`.
 func (n1 *Count64) AdjustMaxIfNecessary(n2 Count64) bool {
-	if n2 > *n1 {
-		*n1 = n2
-		return true
-	} else {
+	if n2 <= *n1 {
 		return false
 	}
+
+	*n1 = n2
+	return true
 }
 
 // AdjustMaxIfPossible adjusts `*n1` to be `max(*n1, n2)`. Return true
 // iff `n2` was greater than or equal to `*n1`.
 func (n1 *Count64) AdjustMaxIfPossible(n2 Count64) bool {
-	if n2 > *n1 {
-		*n1 = n2
-		return true
-	} else {
+	if n2 <= *n1 {
 		return false
 	}
+
+	*n1 = n2
+	return true
 }

counts/human.go

@@ -4,24 +4,28 @@ import (
 	"fmt"
 )
 
-// A quantity that can be made human-readable using Human().
+// Humanable is a quantity that can be made human-readable using
+// `Humaner.Format()`.
 type Humanable interface {
-	// Return the value as a uint64, and a boolean telling whether it
-	// overflowed.
+	// ToUint64 returns the value as a uint64, and a boolean telling
+	// whether it overflowed.
 	ToUint64() (uint64, bool)
 }
 
-// An object that can format a Humanable in human-readable format.
+// Humaner is an object that can format a Humanable in human-readable
+// format.
 type Humaner struct {
 	name     string
 	prefixes []Prefix
 }
 
+// Prefix is a metric-like prefix that implies a scaling factor.
 type Prefix struct {
 	Name       string
 	Multiplier uint64
 }
 
+// Metric is a Humaner representing metric prefixes.
 var Metric = Humaner{
 	name: "metric",
 	prefixes: []Prefix{
@@ -34,6 +38,8 @@ var Metric = Humaner{
 	},
 }
 
+// Binary is a Humaner representing power-of-1024 based prefixes,
+// typically used for bytes.
 var Binary = Humaner{
 	name: "binary",
 	prefixes: []Prefix{
@@ -46,13 +52,15 @@ var Binary = Humaner{
 	},
 }
 
+// Name returns the name of `h` ("metric" or "binary").
 func (h *Humaner) Name() string {
 	return h.name
 }
 
-// Format n, aligned, in `len(unit) + 10` or fewer characters (except
-// for extremely large numbers).
-func (h *Humaner) FormatNumber(n uint64, unit string) (string, string) {
+// FormatNumber formats n, aligned, in `len(unit) + 10` or fewer
+// characters (except for extremely large numbers). It returns strings
+// representing the numeral and the unit string.
+func (h *Humaner) FormatNumber(n uint64, unit string) (numeral string, unitString string) {
 	prefix := h.prefixes[0]
 
 	wholePart := n
@@ -66,25 +74,28 @@ func (h *Humaner) FormatNumber(n uint64, unit string) (string, string) {
 
 	if prefix.Multiplier == 1 {
 		return fmt.Sprintf("%d", n), unit
-	} else {
-		mantissa := float64(n) / float64(prefix.Multiplier)
-		var format string
+	}
 
-		if wholePart >= 100 {
-			// `mantissa` can actually be up to 1023.999.
-			format = "%.0f"
-		} else if wholePart >= 10 {
-			format = "%.1f"
-		} else {
-			format = "%.2f"
-		}
-		return fmt.Sprintf(format, mantissa), prefix.Name + unit
+	mantissa := float64(n) / float64(prefix.Multiplier)
+	var format string
+
+	switch {
+	case wholePart >= 100:
+		// `mantissa` can actually be up to 1023.999.
+		format = "%.0f"
+	case wholePart >= 10:
+		format = "%.1f"
+	default:
+		format = "%.2f"
 	}
+
+	return fmt.Sprintf(format, mantissa), prefix.Name + unit
 }
 
-// Format values, aligned, in `len(unit) + 10` or fewer characters
-// (except for extremely large numbers).
-func (h *Humaner) Format(value Humanable, unit string) (string, string) {
+// Format formats values, aligned, in `len(unit) + 10` or fewer
+// characters (except for extremely large numbers). It returns strings
+// representing the numeral and the unit string.
+func (h *Humaner) Format(value Humanable, unit string) (numeral string, unitString string) {
 	n, overflow := value.ToUint64()
 	if overflow {
 		return "∞", unit

git-sizer.go

@@ -17,7 +17,7 @@ import (
 	"github.com/github/git-sizer/sizes"
 )
 
-const Usage = `usage: git-sizer [OPTS]
+const usage = `usage: git-sizer [OPTS]
 
       --threshold THRESHOLD    minimum level of concern (i.e., number of stars)
                                that should be reported. Default:
@@ -110,13 +110,10 @@ func mainImplementation(args []string) error {
 	// Try to open the repository, but it's not an error yet if this
 	// fails, because the user might only be asking for `--help`.
 	repo, repoErr := git.NewRepository(".")
-	if repoErr == nil {
-		defer repo.Close()
-	}
 
 	flags := pflag.NewFlagSet("git-sizer", pflag.ContinueOnError)
 	flags.Usage = func() {
-		fmt.Print(Usage)
+		fmt.Print(usage)
 	}
 
 	flags.VarP(
@@ -164,7 +161,9 @@ func mainImplementation(args []string) error {
 	flags.Lookup("no-progress").NoOptDefVal = "true"
 
 	flags.StringVar(&cpuprofile, "cpuprofile", "", "write cpu profile to file")
-	flags.MarkHidden("cpuprofile")
+	if err := flags.MarkHidden("cpuprofile"); err != nil {
+		return fmt.Errorf("marking option hidden: %w", err)
+	}
 
 	var configger refopts.Configger
 	if repo != nil {
@@ -191,9 +190,11 @@ func mainImplementation(args []string) error {
 	if cpuprofile != "" {
 		f, err := os.Create(cpuprofile)
 		if err != nil {
-			return fmt.Errorf("couldn't set up cpuprofile file: %s", err)
+			return fmt.Errorf("couldn't set up cpuprofile file: %w", err)
+		}
+		if err := pprof.StartCPUProfile(f); err != nil {
+			return fmt.Errorf("starting CPU profiling: %w", err)
 		}
-		pprof.StartCPUProfile(f)
 		defer pprof.StopCPUProfile()
 	}
 
@@ -211,7 +212,7 @@ func mainImplementation(args []string) error {
 	}
 
 	if repoErr != nil {
-		return fmt.Errorf("couldn't open Git repository: %s", repoErr)
+		return fmt.Errorf("couldn't open Git repository: %w", repoErr)
 	}
 
 	if jsonOutput {
@@ -270,7 +271,7 @@ func mainImplementation(args []string) error {
 
 	historySize, err := sizes.ScanRepositoryUsingGraph(repo, rg, nameStyle, progress)
 	if err != nil {
-		return fmt.Errorf("error scanning repository: %s", err)
+		return fmt.Errorf("error scanning repository: %w", err)
 	}
 
 	if jsonOutput {
@@ -285,14 +286,16 @@ func mainImplementation(args []string) error {
 			return fmt.Errorf("JSON version must be 1 or 2")
 		}
 		if err != nil {
-			return fmt.Errorf("could not convert %v to json: %s", historySize, err)
+			return fmt.Errorf("could not convert %v to json: %w", historySize, err)
 		}
 		fmt.Printf("%s\n", j)
 	} else {
-		io.WriteString(
+		if _, err := io.WriteString(
 			os.Stdout,
 			historySize.TableString(rg.Groups(), threshold, nameStyle),
-		)
+		); err != nil {
+			return fmt.Errorf("writing output: %w", err)
+		}
 	}
 
 	return nil