Add schema provided checks for library.properties maintainer/email field

Author: per1234

check/checkconfigurations/checkconfigurations.go

@@ -326,6 +326,96 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.All},
 		CheckFunction:   checkfunctions.LibraryPropertiesAuthorFieldLTMinLength,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "maintainer field",
+		ID:              "",
+		Brief:           "missing maintainer field",
+		Description:     "",
+		MessageTemplate: "missing required maintainer field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    nil,
+		ErrorModes:      []checkmode.Type{checkmode.All},
+		CheckFunction:   checkfunctions.LibraryPropertiesMaintainerFieldMissing,
+	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "maintainer field",
+		ID:              "",
+		Brief:           "maintainer < min length",
+		Description:     "",
+		MessageTemplate: "library.properties maintainer value is less than minimum length",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    nil,
+		ErrorModes:      []checkmode.Type{checkmode.All},
+		CheckFunction:   checkfunctions.LibraryPropertiesMaintainerFieldLTMinLength,
+	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "maintainer field",
+		ID:              "",
+		Brief:           `starts with "Arduino"`,
+		Description:     "Case insensitive.",
+		MessageTemplate: `library.properties maintainer value {{.}} starts with "Arduino". 3rd party libraries are not maintained by Arduino.`,
+		DisableModes:    []checkmode.Type{checkmode.Official},
+		EnableModes:     []checkmode.Type{checkmode.Default},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.All},
+		ErrorModes:      nil,
+		CheckFunction:   checkfunctions.LibraryPropertiesMaintainerFieldStartsWithArduino,
+	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "email field",
+		ID:              "",
+		Brief:           `"email" field used as alias for "maintainer"`,
+		Description:     "This was in an early draft of the beta 1.5 library specification.",
+		MessageTemplate: `library.properties "email" field used as alias for "maintainer". This is deprecated.`,
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Permissive},
+		ErrorModes:      []checkmode.Type{checkmode.Default},
+		CheckFunction:   checkfunctions.LibraryPropertiesEmailFieldAsMaintainerAlias,
+	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "email field",
+		ID:              "",
+		Brief:           "email < min length",
+		Description:     "",
+		MessageTemplate: "library.properties email value is less than minimum length",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    nil,
+		ErrorModes:      []checkmode.Type{checkmode.All},
+		CheckFunction:   checkfunctions.LibraryPropertiesEmailFieldLTMinLength,
+	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "email field",
+		ID:              "",
+		Brief:           `starts with "Arduino"`,
+		Description:     "Case insensitive.",
+		MessageTemplate: `library.properties email value {{.}} starts with "Arduino". 3rd party libraries are not maintained by Arduino.`,
+		DisableModes:    []checkmode.Type{checkmode.Official},
+		EnableModes:     []checkmode.Type{checkmode.Default},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.All},
+		ErrorModes:      nil,
+		CheckFunction:   checkfunctions.LibraryPropertiesEmailFieldStartsWithArduino,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "library.properties",

check/checkfunctions/library.go

@@ -317,6 +317,109 @@ func LibraryPropertiesAuthorFieldLTMinLength() (result checkresult.Type, output
 	return checkresult.Pass, ""
 }
 
+// LibraryPropertiesMaintainerFieldMissing checks for missing library.properties "maintainer" field.
+func LibraryPropertiesMaintainerFieldMissing() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, ""
+	}
+
+	if schema.RequiredPropertyMissing("maintainer", checkdata.LibraryPropertiesSchemaValidationResult()[compliancelevel.Specification], configuration.SchemasPath()) {
+		return checkresult.Fail, ""
+	}
+	return checkresult.Pass, ""
+}
+
+// LibraryPropertiesMaintainerFieldLTMinLength checks if the library.properties "maintainer" value is less than the minimum length.
+func LibraryPropertiesMaintainerFieldLTMinLength() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, ""
+	}
+
+	if !checkdata.LibraryProperties().ContainsKey("maintainer") {
+		return checkresult.NotRun, ""
+	}
+
+	if schema.PropertyLessThanMinLength("maintainer", checkdata.LibraryPropertiesSchemaValidationResult()[compliancelevel.Specification], configuration.SchemasPath()) {
+		return checkresult.Fail, ""
+	}
+
+	return checkresult.Pass, ""
+}
+
+// LibraryPropertiesMaintainerFieldStartsWithArduino checks if the library.properties "maintainer" value starts with "Arduino".
+func LibraryPropertiesMaintainerFieldStartsWithArduino() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, ""
+	}
+
+	maintainer, ok := checkdata.LibraryProperties().GetOk("maintainer")
+	if !ok {
+		return checkresult.NotRun, ""
+	}
+
+	if schema.ValidationErrorMatch("^#/maintainer$", "/patternObjects/notStartsWithArduino", "", "", checkdata.LibraryPropertiesSchemaValidationResult()[compliancelevel.Specification], configuration.SchemasPath()) {
+		return checkresult.Fail, maintainer
+	}
+
+	return checkresult.Pass, ""
+}
+
+// LibraryPropertiesEmailFieldAsMaintainerAlias checks whether the library.properties "email" field is being used as an alias for the "maintainer" field.
+func LibraryPropertiesEmailFieldAsMaintainerAlias() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, ""
+	}
+
+	if !checkdata.LibraryProperties().ContainsKey("email") {
+		return checkresult.NotRun, ""
+	}
+
+	if !checkdata.LibraryProperties().ContainsKey("maintainer") {
+		return checkresult.Fail, ""
+	}
+
+	return checkresult.Pass, ""
+}
+
+// LibraryPropertiesNameFieldLTMinLength checks if the library.properties "email" value is less than the minimum length.
+func LibraryPropertiesEmailFieldLTMinLength() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, ""
+	}
+
+	if checkdata.LibraryProperties().ContainsKey("maintainer") || !checkdata.LibraryProperties().ContainsKey("email") {
+		return checkresult.NotRun, ""
+	}
+
+	if schema.PropertyLessThanMinLength("email", checkdata.LibraryPropertiesSchemaValidationResult()[compliancelevel.Specification], configuration.SchemasPath()) {
+		return checkresult.Fail, ""
+	}
+
+	return checkresult.Pass, ""
+}
+
+// LibraryPropertiesMaintainerFieldStartsWithArduino checks if the library.properties "email" value starts with "Arduino".
+func LibraryPropertiesEmailFieldStartsWithArduino() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, ""
+	}
+
+	if checkdata.LibraryProperties().ContainsKey("maintainer") {
+		return checkresult.NotRun, ""
+	}
+
+	email, ok := checkdata.LibraryProperties().GetOk("email")
+	if !ok {
+		return checkresult.NotRun, ""
+	}
+
+	if schema.ValidationErrorMatch("^#/email$", "/patternObjects/notStartsWithArduino", "", "", checkdata.LibraryPropertiesSchemaValidationResult()[compliancelevel.Specification], configuration.SchemasPath()) {
+		return checkresult.Fail, email
+	}
+
+	return checkresult.Pass, ""
+}
+
 // LibraryPropertiesSentenceFieldMissing checks for missing library.properties "sentence" field.
 func LibraryPropertiesSentenceFieldMissing() (result checkresult.Type, output string) {
 	if checkdata.LibraryPropertiesLoadError() != nil {