Linter

cmd/root.go

@@ -46,10 +46,13 @@ var (
 	debug            bool
 	stdin            bool
 
-	// Populated by goreleaser during build
+	// Version is populated by goreleaser during build
+	// Version...
 	Version = "main"
-	Commit  = "000000"
-	Date    = "today"
+	// Commit ...
+	Commit = "000000"
+	// Date ...
+	Date = "today"
 )
 
 // rootCmd represents the base command when called without any subcommands

pkg/config/config.go

@@ -14,6 +14,7 @@ type Config struct {
 	IgnoreFiles []string     `yaml:"ignore_files"`
 }
 
+// NewConfig returns a new Config
 func NewConfig(filename string) (*Config, error) {
 	var c Config
 	c.AddDefaultRules()

pkg/ignore/ignore.go

@@ -15,6 +15,7 @@ var DefaultIgnores = []string{
 	".git",
 }
 
+// Ignore is a gitignore-style object to ignore files/directories
 type Ignore struct {
 	compiled *gitignore.GitIgnore
 }

pkg/parser/files.go

@@ -5,7 +5,7 @@ import (
 	"github.com/caitlinelfring/woke/pkg/util"
 )
 
-const defaultGlob = "**"
+const defaultPath = "."
 
 // Parsable contains the list of files that can be parsed
 type Parsable struct {
@@ -16,7 +16,7 @@ type Parsable struct {
 // excluded files that should be ignored
 func ParsableFiles(fileGlobs []string, ignorer *ignore.Ignore) *Parsable {
 	if len(fileGlobs) == 0 {
-		fileGlobs = []string{defaultGlob}
+		fileGlobs = []string{defaultPath}
 	}
 
 	var p Parsable

pkg/util/contenttype.go

@@ -29,6 +29,7 @@ func isTextFile(file *os.File) bool {
 	return strings.HasPrefix(contentType, "text/plain")
 }
 
+// IsTextFile returns an error if the file is not of content-type 'text/plain'
 func IsTextFile(file *os.File) error {
 	if !isTextFile(file) {
 		return fmt.Errorf("%s is not a text file", file.Name())