golint: minor fixes (#36)

deplist.go

@@ -43,6 +43,7 @@ func init() {
 	}
 }
 
+// GetLanguageStr returns from a bitmask return the ecosystem name
 func GetLanguageStr(bm Bitmask) string {
 	if bm&LangGolang != 0 {
 		return "go"

internal/scan/golang.go

@@ -14,6 +14,8 @@ import (
 	"golang.org/x/mod/semver"
 )
 
+// GoListDeps holds the import path, version and gofiles for a given go
+// dependency
 type GoListDeps struct {
 	ImportPath string `json:"ImportPath"`
 	Module     struct {
@@ -25,14 +27,15 @@ type GoListDeps struct {
 	GoFiles []string `json:"GoFiles"`
 }
 
+// GoPkg holds the version and go paths/files for a given dep
 type GoPkg struct {
 	Version string
 	Gofiles []string
 }
 
 func getVersion(deps GoListDeps) string {
 	/* if replace is specified, then use that version
-	* not seen when version and replace.version are differnt
+	* not seen when version and replace.version are different
 	* but just in case
 	 */
 	if deps.Module.Replace.Version != "" {
@@ -75,10 +78,10 @@ func runCmd(path string, mod bool) ([]byte, error) {
 		if !mod {
 			// assume some retrival error, we have to redo the cmd with mod=vendor
 			return nil, err
-		} else {
-			if len(out) == 0 {
-				return nil, err
-			}
+		}
+
+		if len(out) == 0 {
+			return nil, err
 		}
 	}
 
@@ -102,6 +105,8 @@ func runGoList(path string) ([]byte, error) {
 	return out, nil
 }
 
+// GetGolangDeps uses `go list` gather a list of dependencies located at `path`
+// returning an array of `GoPkg` structs
 func GetGolangDeps(path string) (map[string]GoPkg, error) {
 	// need to use a map as we'll get lots of duplicate entries
 	gathered := make(map[string]GoPkg)

internal/scan/jar.go

@@ -6,6 +6,7 @@ import (
 	"github.com/mcoops/jargo"
 )
 
+// GetJarDeps uses github.com/mcoops/jargo retrieve the java dependencies
 func GetJarDeps(path string) (map[string]string, error) {
 	gathered := make(map[string]string)
 

internal/scan/maven.go

@@ -6,6 +6,8 @@ import (
 	"strings"
 )
 
+// GetMvnDeps uses the mvn command to attempt to list the dependencies for a
+// given project located at `path`
 func GetMvnDeps(path string) (map[string]string, error) {
 	var gathered map[string]string
 	var found map[string]bool
@@ -27,7 +29,7 @@ func GetMvnDeps(path string) (map[string]string, error) {
 		"-DincludeScope=runtime")
 	cmd.Dir = dirPath
 
-	// supress error, it always returns errors
+	// suppress error, it always returns errors
 	data, _ := cmd.Output()
 
 	res := strings.Split(string(data), "\n")

internal/scan/nodejs.go

@@ -31,6 +31,7 @@ type npmListOutput struct {
 	Dependencies map[string]npmDependency `json:"dependencies"`
 }
 
+// NodeJSGather dependencies found, name and version
 type NodeJSGather struct {
 	Name    string
 	Version string
@@ -86,6 +87,9 @@ func gatherNPMNode(name string, dependency npmDependency) {
 	}
 }
 
+// GetNodeJSDeps scans the path for either `yarn.lock` or `package-lock.json`,
+// then use the appropriate pkg managers to produce depencies lists of type
+// `NodeJSGather`
 func GetNodeJSDeps(path string) (map[string]NodeJSGather, error) {
 	switch filepath.Base(path) {
 	case "yarn.lock":

internal/scan/python.go

@@ -10,6 +10,7 @@ import (
 // Account for >, <, >=, <=, ==, !=, ~= and *
 var /* const */ re = regexp.MustCompile(`[<>!~*]+`)
 
+// GetPythonDeps scans path for python deps using the `requirements.txt` file
 func GetPythonDeps(path string) (map[string]string, error) {
 	gathered := make(map[string]string)
 
@@ -40,7 +41,7 @@ func GetPythonDeps(path string) (map[string]string, error) {
 		}
 
 		// every other permitation just use the name as we can't guarantee
-		// the version, just grab the name using first occurance
+		// the version, just grab the name using first occurrence
 		match := re.FindStringIndex(line)
 
 		if match != nil {

internal/scan/ruby.go

@@ -8,25 +8,27 @@ import (
 	"strings"
 )
 
+// GetRubyDeps uses `bundle update --bundler` to list ruby dependencies when a
+// Gemfile.lock file exists
 func GetRubyDeps(path string) (map[string]string, error) {
 	gathered := make(map[string]string)
 
 	dirPath := filepath.Dir(path)
 
 	// override the gem path otherwise might hit perm issues and it's annoying
-	gem_path, err := os.MkdirTemp("", "gem_vendor")
+	gemPath, err := os.MkdirTemp("", "gem_vendor")
 	if err != nil {
 		return nil, err
 	}
 
 	// cleanup after ourselves
-	defer os.RemoveAll(gem_path)
+	defer os.RemoveAll(gemPath)
 
 	//Make sure that the Gemfile we are loading is supported by the version of bundle currently installed.
 	cmd := exec.Command("bundle", "update", "--bundler")
 	cmd.Dir = dirPath
 	cmd.Env = os.Environ()
-	cmd.Env = append(cmd.Env, "BUNDLE_PATH="+gem_path)
+	cmd.Env = append(cmd.Env, "BUNDLE_PATH="+gemPath)
 	_, err = cmd.Output()
 	if err != nil {
 		return nil, err
@@ -36,11 +38,11 @@ func GetRubyDeps(path string) (map[string]string, error) {
 
 	cmd.Dir = dirPath
 	cmd.Env = os.Environ()
-	cmd.Env = append(cmd.Env, "BUNDLE_PATH="+gem_path)
+	cmd.Env = append(cmd.Env, "BUNDLE_PATH="+gemPath)
 
 	data, err := cmd.Output()
 	if err != nil {
-		return nil, errors.New(gem_path + " " + err.Error())
+		return nil, errors.New(gemPath + " " + err.Error())
 	}
 
 	splitOutput := strings.Split(string(data), "\n")

internal/utils/utils.go

@@ -1,6 +1,6 @@
 package utils
 
-// fastest way we can do a string compare on a list
+// BelongsToIgnoreList is fastest way we can do a string compare on a list
 func BelongsToIgnoreList(needle string) bool {
 	switch needle {
 	case