chore: general comment cleanup

doc.go

@@ -20,7 +20,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 */
 
-// pillager is a tool for hunting through filesystems for sensitive information.
+// Package pillager is a tool for hunting through filesystems for sensitive information.
 //
 // Installation
 //

internal/commands/hunt.go

@@ -1,6 +1,6 @@
-// Package commands contains the command line logic
+// Package commands contains the command line logic.
 //
-// The commands package is the primary consumer of all packages in the /pkg directory
+// The commands package is the primary consumer of all packages in the /pkg directory.
 package commands
 
 import (

internal/validate/path.go

@@ -6,8 +6,8 @@ import (
 	"github.com/spf13/afero"
 )
 
-// Path checks if a filepath exists and
-// returns it if so, otherwise returns a default path.
+// Path checks if a file at the given path exists and returns it if so,
+// otherwise returns a default path.
 func Path(fs afero.Fs, path string) string {
 	ok, err := afero.Exists(fs, path)
 	if err != nil {

pkg/format/report.go

@@ -11,6 +11,7 @@ import (
 	"gopkg.in/yaml.v2"
 )
 
+// Reporter is the interface that each of the canonical output formats implement.
 type Reporter interface {
 	Report(io.Writer, []report.Finding) error
 }

pkg/hunter/config.go

@@ -17,8 +17,7 @@ import (
 	"github.com/zricethezav/gitleaks/v8/config"
 )
 
-// Config takes all of the configurable
-// parameters for a Hunter.
+// Config takes all of the configurable parameters for a Hunter.
 type Config struct {
 	Filesystem afero.Fs
 	Reporter   format.Reporter
@@ -32,8 +31,10 @@ type Config struct {
 	Template string
 }
 
+// ConfigOption is a convenient type alias for func(*Config).
 type ConfigOption func(*Config)
 
+// NewConfig creates a Config instance.
 func NewConfig(opts ...ConfigOption) *Config {
 	var (
 		defaultFS       = afero.NewOsFs()

pkg/hunter/docs.go

@@ -1,2 +1,2 @@
-// Package hunter contains secret hunting and file scanning tools
+// Package hunter contains secret hunting and file scanning tools.
 package hunter

pkg/rules/rules.go

@@ -1,4 +1,4 @@
-// Package rules enables the parsing of Gitleaks rulesets
+// Package rules enables the parsing of Gitleaks rulesets.
 package rules
 
 import (
@@ -10,10 +10,11 @@ import (
 	"github.com/zricethezav/gitleaks/v8/config"
 )
 
-const (
-	ErrReadConfig = "Failed to read config"
-)
+// ErrReadConfig is the custom error message used if an error is encountered
+// reading the gitleaks config.
+const ErrReadConfig = "Failed to read gitleaks config"
 
+// These strings contain default configs. They are initialized at compile time via go:embed.
 var (
 	//go:embed rules_simple.toml
 	RulesDefault string
@@ -22,14 +23,15 @@ var (
 	RulesStrict string
 )
 
+// Loader represents a gitleaks config loader.
 type Loader struct {
 	loader config.ViperConfig
 }
 
+// LoaderOption sets a parameter for the gitleaks config loader.
 type LoaderOption func(*Loader)
 
-// NewLoader creates a configuration
-// loader.
+// NewLoader creates a Loader instance.
 func NewLoader(opts ...LoaderOption) *Loader {
 	var loader Loader
 	if _, err := toml.Decode(RulesDefault, &loader.loader); err != nil {
@@ -62,8 +64,7 @@ func (l *Loader) Load() config.Config {
 	return config
 }
 
-// FromFile decodes the configuration
-// from a local file.
+// FromFile decodes a gitleaks config from a local file.
 func FromFile(file string) LoaderOption {
 	return func(l *Loader) {
 		if _, err := toml.DecodeFile(file, &l.loader); err != nil {

pkg/templates/templates.go

@@ -1,4 +1,4 @@
-// Package templates contains a compilation of go templates for rendering secret findings
+// Package templates contains a compilation of go templates for rendering secret findings.
 package templates
 
 import (
@@ -29,8 +29,8 @@ var (
 	HTMLTable string
 )
 
-// DefaultTemplate is the base template used to
-// format a Finding into the custom output format.
+// DefaultTemplate is the base template used to format a Finding into the
+// custom output format.
 const DefaultTemplate = `{{ with . -}}
 {{ range . -}}
 Line: 	{{ quote .StartLine}}
@@ -39,8 +39,7 @@ Secret: {{ quote .Secret }}
 ---
 {{ end -}}{{- end}}`
 
-// Render renders a finding in a
-// custom go template format to the provided writer.
+// Render renders a finding in a custom go template format to the provided writer.
 func Render(w io.Writer, tpl string, findings []report.Finding) error {
 	t := template.New("custom")
 	if tpl == "" {