Merge pull request #38 from arduino/per1234/version-schema-checks

Add schema provided checks for library.properties version field

Author: per1234

check/checkconfigurations/checkconfigurations.go

@@ -146,6 +146,36 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.All},
 		CheckFunction:   checkfunctions.LibraryPropertiesVersionFieldMissing,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "version field",
+		ID:              "",
+		Brief:           "invalid",
+		Description:     `Must be compliant with "relaxed semver".`,
+		MessageTemplate: "library.properties version value {{.}} is invalid. 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.LibraryPropertiesVersionFieldNonRelaxedSemver,
+	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "version field",
+		ID:              "",
+		Brief:           "non-semver",
+		Description:     "",
+		MessageTemplate: "library.properties version value {{.}} is not compliant with the semver specification. See https://semver.org/",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.All},
+		ErrorModes:      nil,
+		CheckFunction:   checkfunctions.LibraryPropertiesVersionFieldNonSemver,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "library.properties",

check/checkfunctions/library.go

@@ -110,6 +110,42 @@ func LibraryPropertiesVersionFieldMissing() (result checkresult.Type, output str
 	return checkresult.Pass, ""
 }
 
+// LibraryPropertiesVersionFieldNonRelaxedSemver checks whether the library.properties "version" value is "relaxed semver" compliant.
+func LibraryPropertiesVersionFieldNonRelaxedSemver() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, ""
+	}
+
+	version, ok := checkdata.LibraryProperties().GetOk("version")
+	if !ok {
+		return checkresult.NotRun, ""
+	}
+
+	if schema.PropertyPatternMismatch("version", checkdata.LibraryPropertiesSchemaValidationResult()[compliancelevel.Specification], configuration.SchemasPath()) {
+		return checkresult.Fail, version
+	}
+
+	return checkresult.Pass, ""
+}
+
+// LibraryPropertiesVersionFieldNonSemver checks whether the library.properties "version" value is semver compliant.
+func LibraryPropertiesVersionFieldNonSemver() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, ""
+	}
+
+	version, ok := checkdata.LibraryProperties().GetOk("version")
+	if !ok {
+		return checkresult.NotRun, ""
+	}
+
+	if schema.PropertyPatternMismatch("version", checkdata.LibraryPropertiesSchemaValidationResult()[compliancelevel.Strict], configuration.SchemasPath()) {
+		return checkresult.Fail, version
+	}
+
+	return checkresult.Pass, ""
+}
+
 // LibraryPropertiesDependsFieldNotInIndex checks whether the libraries listed in the library.properties `depends` field are in the Library Manager index.
 func LibraryPropertiesDependsFieldNotInIndex() (result checkresult.Type, output string) {
 	if checkdata.LibraryPropertiesLoadError() != nil {