Define supported and valid library examples folder names in the library package

Author: per1234

project/library/library.go

@@ -36,3 +36,25 @@ func IsMetadataFile(filePath *paths.Path) bool {
 	}
 	return false
 }
+
+// See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples
+var examplesFolderValidNames = map[string]struct{}{
+	"examples": empty,
+}
+
+// Only "examples" is specification-compliant, but apparently "example" is also supported
+// See: https://github.com/arduino/arduino-cli/blob/0.13.0/arduino/libraries/loader.go#L153
+var examplesFolderSupportedNames = map[string]struct{}{
+	"examples": empty,
+	"example":  empty,
+}
+
+// ExamplesFolderNames returns a slice of supported examples folder names
+func ExamplesFolderSupportedNames() []string {
+	folderNames := make([]string, 0, len(examplesFolderSupportedNames))
+	for folderName := range examplesFolderSupportedNames {
+		folderNames = append(folderNames, folderName)
+	}
+
+	return folderNames
+}

project/project.go

@@ -103,12 +103,10 @@ func findSubprojects(superproject Type, apexSuperprojectType projecttype.Type) [
 		// Sketches don't have subprojects
 		return nil
 	case projecttype.Library:
-		subprojectPath := superproject.Path.Join("examples")
-		immediateSubprojects = append(immediateSubprojects, findProjectsUnderPath(subprojectPath, projecttype.Sketch, true)...)
-		// Apparently there is some level of official support for "example" in addition to the specification-compliant "examples".
-		// see: https://github.com/arduino/arduino-cli/blob/0.13.0/arduino/libraries/loader.go#L153
-		subprojectPath = superproject.Path.Join("example")
-		immediateSubprojects = append(immediateSubprojects, findProjectsUnderPath(subprojectPath, projecttype.Sketch, true)...)
+		for _, subprojectFolderName := range library.ExamplesFolderSupportedNames() {
+			subprojectPath := superproject.Path.Join(subprojectFolderName)
+			immediateSubprojects = append(immediateSubprojects, findProjectsUnderPath(subprojectPath, projecttype.Sketch, true)...)
+		}
 	case projecttype.Platform:
 		subprojectPath := superproject.Path.Join("libraries")
 		immediateSubprojects = append(immediateSubprojects, findProjectsUnderPath(subprojectPath, projecttype.Library, false)...)