Use check configuration superproject type field to skip subprojects

The newly added field allows moving the implementation of this filter out of the check function and into the check
configuration. It also allows some simplification of the check function tests.

Author: per1234

internal/rule/ruleconfiguration/ruleconfiguration.go

@@ -587,7 +587,7 @@ var configurations = []Type{
 	},
 	{
 		ProjectType:      projecttype.Library,
-		SuperprojectType: projecttype.All,
+		SuperprojectType: projecttype.Library,
 		Category:         "library.properties",
 		Subcategory:      "version field",
 		ID:               "LP022",
@@ -1147,7 +1147,7 @@ var configurations = []Type{
 	},
 	{
 		ProjectType:      projecttype.Library,
-		SuperprojectType: projecttype.All,
+		SuperprojectType: projecttype.Library,
 		Category:         "documentation",
 		Subcategory:      "miscellaneous",
 		ID:               "LD001",
@@ -1163,7 +1163,7 @@ var configurations = []Type{
 	},
 	{
 		ProjectType:      projecttype.Library,
-		SuperprojectType: projecttype.All,
+		SuperprojectType: projecttype.Library,
 		Category:         "documentation",
 		Subcategory:      "miscellaneous",
 		ID:               "LD002",
@@ -1339,7 +1339,7 @@ var configurations = []Type{
 	},
 	{
 		ProjectType:      projecttype.Sketch,
-		SuperprojectType: projecttype.All,
+		SuperprojectType: projecttype.Sketch,
 		Category:         "documentation",
 		Subcategory:      "miscellaneous",
 		ID:               "SD001",
@@ -1355,7 +1355,7 @@ var configurations = []Type{
 	},
 	{
 		ProjectType:      projecttype.Sketch,
-		SuperprojectType: projecttype.All,
+		SuperprojectType: projecttype.Sketch,
 		Category:         "documentation",
 		Subcategory:      "miscellaneous",
 		ID:               "SD002",
@@ -1403,7 +1403,7 @@ var configurations = []Type{
 	},
 	{
 		ProjectType:      projecttype.Platform,
-		SuperprojectType: projecttype.All,
+		SuperprojectType: projecttype.Platform,
 		Category:         "documentation",
 		Subcategory:      "miscellaneous",
 		ID:               "PD001",
@@ -1419,7 +1419,7 @@ var configurations = []Type{
 	},
 	{
 		ProjectType:      projecttype.Platform,
-		SuperprojectType: projecttype.All,
+		SuperprojectType: projecttype.Platform,
 		Category:         "documentation",
 		Subcategory:      "miscellaneous",
 		ID:               "PD002",

internal/rule/rulefunction/library.go

@@ -571,10 +571,6 @@ func LibraryPropertiesVersionFieldNonSemver() (result ruleresult.Type, output st
 
 // LibraryPropertiesVersionFieldBehindTag checks whether a release tag was made without first bumping the library.properties version value.
 func LibraryPropertiesVersionFieldBehindTag() (result ruleresult.Type, output string) {
-	if projectdata.ProjectType() != projectdata.SuperProjectType() {
-		return ruleresult.Skip, "Not relevant for subprojects"
-	}
-
 	if projectdata.LibraryPropertiesLoadError() != nil {
 		return ruleresult.NotRun, "Couldn't load library.properties"
 	}

internal/rule/rulefunction/library_test.go

@@ -494,7 +494,6 @@ func TestLibraryPropertiesVersionFieldBehindTag(t *testing.T) {
 	}
 
 	testTables := []libraryRuleFunctionTestTable{
-		// TODO: Test Skip if subproject
 		{"Unable to load", "InvalidLibraryProperties", ruleresult.NotRun, ""},
 		{"Legacy", "Legacy", ruleresult.NotRun, ""},
 		{"Unparsable version", "VersionFormatInvalid", ruleresult.NotRun, ""},

internal/rule/rulefunction/rulefunction.go

@@ -34,10 +34,6 @@ type Type func() (result ruleresult.Type, output string)
 
 // MissingReadme checks if the project has a readme that will be recognized by GitHub.
 func MissingReadme() (result ruleresult.Type, output string) {
-	if projectdata.ProjectType() != projectdata.SuperProjectType() {
-		return ruleresult.Skip, "Readme not required for subprojects"
-	}
-
 	// https://github.com/github/markup/blob/master/README.md
 	readmeRegexp := regexp.MustCompile(`(?i)^readme\.(markdown)|(mdown)|(mkdn)|(md)|(textile)|(rdoc)|(org)|(creole)|(mediawiki)|(wiki)|(rst)|(asciidoc)|(adoc)|(asc)|(pod)|(txt)$`)
 
@@ -53,10 +49,6 @@ func MissingReadme() (result ruleresult.Type, output string) {
 
 // MissingLicenseFile checks if the project has a license file that will be recognized by GitHub.
 func MissingLicenseFile() (result ruleresult.Type, output string) {
-	if projectdata.ProjectType() != projectdata.SuperProjectType() {
-		return ruleresult.Skip, "License file not required for subprojects"
-	}
-
 	// https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/licensing-a-repository#detecting-a-license
 	// https://github.com/licensee/licensee/blob/master/docs/what-we-look-at.md#detecting-the-license-file
 	// Should be `(?i)^(((un)?licen[sc]e)|(copy(ing|right))|(ofl)|(patents))(\.(?!spdx|header|gemspec).+)?$` but regexp package doesn't support negative lookahead, so only using "preferred extensions".

internal/rule/rulefunction/rulefunction_test.go

@@ -38,8 +38,6 @@ func init() {
 type ruleFunctionTestTable struct {
 	testName            string
 	projectFolderName   string
-	projectType         projecttype.Type
-	superProjectType    projecttype.Type
 	expectedRuleResult  ruleresult.Type
 	expectedOutputQuery string
 }
@@ -50,8 +48,8 @@ func checkRuleFunction(ruleFunction Type, testTables []ruleFunctionTestTable, t
 
 		testProject := project.Type{
 			Path:             testDataPath.Join(testTable.projectFolderName),
-			ProjectType:      testTable.projectType,
-			SuperprojectType: testTable.superProjectType,
+			ProjectType:      projecttype.Library,
+			SuperprojectType: projecttype.Library,
 		}
 
 		projectdata.Initialize(testProject)
@@ -64,30 +62,28 @@ func checkRuleFunction(ruleFunction Type, testTables []ruleFunctionTestTable, t
 
 func TestMissingReadme(t *testing.T) {
 	testTables := []ruleFunctionTestTable{
-		{"Subproject", "readme", projecttype.Sketch, projecttype.Library, ruleresult.Skip, ""},
-		{"Readme", "readme", projecttype.Sketch, projecttype.Sketch, ruleresult.Pass, ""},
-		{"No readme", "no-readme", projecttype.Sketch, projecttype.Sketch, ruleresult.Fail, ""},
+		{"Readme", "readme", ruleresult.Pass, ""},
+		{"No readme", "no-readme", ruleresult.Fail, ""},
 	}
 
 	checkRuleFunction(MissingReadme, testTables, t)
 }
 
 func TestMissingLicenseFile(t *testing.T) {
 	testTables := []ruleFunctionTestTable{
-		{"Subproject", "no-license-file", projecttype.Sketch, projecttype.Library, ruleresult.Skip, ""},
-		{"Has license", "license-file", projecttype.Sketch, projecttype.Sketch, ruleresult.Pass, ""},
-		{"Has license in subfolder", "license-file-in-subfolder", projecttype.Sketch, projecttype.Sketch, ruleresult.Fail, ""},
-		{"No license", "no-license-file", projecttype.Sketch, projecttype.Sketch, ruleresult.Fail, ""},
+		{"Has license", "license-file", ruleresult.Pass, ""},
+		{"Has license in subfolder", "license-file-in-subfolder", ruleresult.Fail, ""},
+		{"No license", "no-license-file", ruleresult.Fail, ""},
 	}
 
 	checkRuleFunction(MissingLicenseFile, testTables, t)
 }
 
 func TestIncorrectArduinoDotHFileNameCase(t *testing.T) {
 	testTables := []ruleFunctionTestTable{
-		{"Incorrect, angle brackets", "arduino.h-angle", projecttype.Sketch, projecttype.Sketch, ruleresult.Fail, ""},
-		{"Incorrect, quotes", "arduino.h-quote", projecttype.Sketch, projecttype.Sketch, ruleresult.Fail, ""},
-		{"Correct case", "Arduino.h", projecttype.Sketch, projecttype.Sketch, ruleresult.Pass, ""},
+		{"Incorrect, angle brackets", "arduino.h-angle", ruleresult.Fail, ""},
+		{"Incorrect, quotes", "arduino.h-quote", ruleresult.Fail, ""},
+		{"Correct case", "Arduino.h", ruleresult.Pass, ""},
 	}
 
 	checkRuleFunction(IncorrectArduinoDotHFileNameCase, testTables, t)