Increase recommended library name length to 32 (#511)

The previous maximum recommend library name length, according to rule LP010, was 16 characters. This limit was determined to be unrealistic. For example, once Arduino library authors have added the required "Arduino_" prefix, half the available characters are used up.

Even though it is only a recommendation, resulting in a warning when Arduino Lint is ran in "permissive" or "specification" compliance modes, it is an error in "strict" mode. This impossibility of complying with LP010 is the sole reason for the strict compliance level being used in the CI systems of several of Arduino's libraries.

Author: aliphys

etc/schemas/arduino-library-properties-definitions-schema.json

@@ -91,7 +91,7 @@
                 "$ref": "#/definitions/propertiesObjects/name/specification/object"
               },
               {
-                "maxLength": 16
+                "maxLength": 32
               },
               {
                 "$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsSpaces"

internal/rule/ruleconfiguration/ruleconfiguration.go

@@ -424,7 +424,7 @@ var configurations = []Type{
 		ID:               "LP010",
 		Brief:            "name > recommended length",
 		Description:      "The `name` field in the library's `library.properties` metadata file is longer than the recommended length. As the unique identifier for the library, the name will be typed by the users of command line tools (e.g., `arduino-cli lib install Servo`). For this reason, it is best practices to avoid unnecessary name length.",
-		MessageTemplate:  "library.properties name value {{.}} is longer than the recommended length of 16 characters.",
+		MessageTemplate:  "library.properties name value {{.}} is longer than the recommended length of 32 characters.",
 		Reference:        "https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
 		DisableModes:     nil,
 		EnableModes:      []rulemode.Type{rulemode.Default},

internal/rule/rulefunction/library_test.go

@@ -297,7 +297,7 @@ func TestLibraryPropertiesNameFieldGTRecommendedLength(t *testing.T) {
 	testTables := []libraryRuleFunctionTestTable{
 		{"Invalid", "InvalidLibraryProperties", ruleresult.NotRun, ""},
 		{"Legacy", "Legacy", ruleresult.NotRun, ""},
-		{"Name field longer than recommended", "NameGTRecommendedLength", ruleresult.Fail, ""},
+		{"Name field longer than recommended", "NameIsBiggerThanRecommendedLength", ruleresult.Fail, ""},
 		{"Valid", "Recursive", ruleresult.Pass, ""},
 	}
 

internal/rule/rulefunction/testdata/libraries/NameGTRecommendedLength/library.properties renamed to internal/rule/rulefunction/testdata/libraries/NameIsBiggerThanRecommendedLength/library.properties

@@ -1,4 +1,4 @@
-name=NameGTRecommendedLength
+name=NameIsBiggerThanRecommendedLength
 version=1.0.0
 author=Cristian Maglie <c.maglie@example.com>, Pippo Pluto <pippo@example.com>
 maintainer=Cristian Maglie <c.maglie@example.com>

internal/rule/rulefunction/testdata/libraries/NameGTRecommendedLength/src/NameGTRecommendedLength.h renamed to internal/rule/rulefunction/testdata/libraries/NameIsBiggerThanRecommendedLength/src/NameIsBiggerThanRecommendedLength.h

@@ -1509,7 +1509,7 @@ var _arduinoLibraryPropertiesDefinitionsSchemaJson = []byte(`{
                 "$ref": "#/definitions/propertiesObjects/name/specification/object"
               },
               {
-                "maxLength": 16
+                "maxLength": 32
               },
               {
                 "$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsSpaces"