Rename configuration.SuperprojectType() to configuration.SuperprojectTypeFilter()

The name "SuperprojectType" is too vague and used as a project.Type field name to mean a completely different thing.

Author: per1234

configuration/configuration.go

@@ -28,9 +28,9 @@ func Initialize() {
 	logrus.SetLevel(logrus.PanicLevel)
 
 	logrus.WithFields(logrus.Fields{
-		"superproject type": SuperprojectType().String(),
-		"recursive":         Recursive(),
-		"projects path":     TargetPath().String(),
+		"superproject type filter": SuperprojectTypeFilter().String(),
+		"recursive":                Recursive(),
+		"projects path":            TargetPath().String(),
 	}).Debug("Configuration initialized")
 }
 
@@ -41,11 +41,11 @@ func CheckModes(superprojectType projecttype.Type) map[checkmode.Type]bool {
 	return checkmode.Modes(defaultCheckModes, customCheckModes, superprojectType)
 }
 
-var superprojectType projecttype.Type
+var superprojectTypeFilter projecttype.Type
 
 // SuperprojectType returns the superproject type filter configuration.
-func SuperprojectType() projecttype.Type {
-	return superprojectType
+func SuperprojectTypeFilter() projecttype.Type {
+	return superprojectTypeFilter
 }
 
 var recursive bool

configuration/defaults.go

@@ -8,7 +8,7 @@ import (
 )
 
 func setDefaults() {
-	superprojectType = projecttype.All
+	superprojectTypeFilter = projecttype.All
 	recursive = true
 	// TODO: targetPath defaults to current path
 }

project/project.go

@@ -25,7 +25,7 @@ type Type struct {
 // It returns a slice containing the definitions of each found project.
 func FindProjects() ([]Type, error) {
 	targetPath := configuration.TargetPath()
-	superprojectTypeConfiguration := configuration.SuperprojectType()
+	superprojectTypeFilter := configuration.SuperprojectTypeFilter()
 	recursive := configuration.Recursive()
 
 	var foundProjects []Type
@@ -34,7 +34,7 @@ func FindProjects() ([]Type, error) {
 	if targetPath.IsNotDir() {
 		logrus.Debug("Projects path is file")
 		// The filename provides additional information about the project type. So rather than using isProject(), which doesn't make use this information, use a specialized function that does.
-		isProject, projectType := isProjectIndicatorFile(targetPath, superprojectTypeConfiguration)
+		isProject, projectType := isProjectIndicatorFile(targetPath, superprojectTypeFilter)
 		if isProject {
 			foundProject := Type{
 				Path:             targetPath.Parent(),
@@ -51,7 +51,7 @@ func FindProjects() ([]Type, error) {
 		return nil, fmt.Errorf("specified path %s is not an Arduino project", targetPath.String())
 	}
 
-	foundProjects = append(foundProjects, findProjects(targetPath, superprojectTypeConfiguration, recursive)...)
+	foundProjects = append(foundProjects, findProjects(targetPath, superprojectTypeFilter, recursive)...)
 
 	if foundProjects == nil {
 		return nil, fmt.Errorf("no projects found under %s", targetPath.String())