Increase recommended library name length to 32 (#511)

aliphys · web-flow · commit 36204a022c01 · 2023-03-17T16:30:06.000-07:00
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.
diff --git a/etc/schemas/arduino-library-properties-definitions-schema.json b/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"
diff --git a/internal/rule/ruleconfiguration/ruleconfiguration.go b/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},
diff --git a/internal/rule/rulefunction/library_test.go b/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, ""},
 	}
 
diff --git a/internal/rule/rulefunction/testdata/libraries/NameIsBiggerThanRecommendedLength/library.properties b/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>
diff --git a/internal/rule/rulefunction/testdata/libraries/NameIsBiggerThanRecommendedLength/src/NameIsBiggerThanRecommendedLength.h b/internal/rule/rulefunction/testdata/libraries/NameIsBiggerThanRecommendedLength/src/NameIsBiggerThanRecommendedLength.h
diff --git a/internal/rule/schema/schemadata/bindata.go b/internal/rule/schema/schemadata/bindata.go
@@ -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"

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@`
`91`	`91`	`"$ref": "#/definitions/propertiesObjects/name/specification/object"`
`92`	`92`	`},`
`93`	`93`	`{`
`94`		`- "maxLength": 16`
	`94`	`+ "maxLength": 32`
`95`	`95`	`},`
`96`	`96`	`{`
`97`	`97`	`"$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsSpaces"`
Original file line number	Diff line number	Diff line change
`@@ -297,7 +297,7 @@ func TestLibraryPropertiesNameFieldGTRecommendedLength(t *testing.T) {`
`297`	`297`	`testTables := []libraryRuleFunctionTestTable{`
`298`	`298`	`{"Invalid", "InvalidLibraryProperties", ruleresult.NotRun, ""},`
`299`	`299`	`{"Legacy", "Legacy", ruleresult.NotRun, ""},`
`300`		`- {"Name field longer than recommended", "NameGTRecommendedLength", ruleresult.Fail, ""},`
	`300`	`+ {"Name field longer than recommended", "NameIsBiggerThanRecommendedLength", ruleresult.Fail, ""},`
`301`	`301`	`{"Valid", "Recursive", ruleresult.Pass, ""},`
`302`	`302`	`}`
`303`	`303`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name=NameGTRecommendedLength`
	`1`	`+name=NameIsBiggerThanRecommendedLength`
`2`	`2`	`version=1.0.0`
`3`	`3`	`author=Cristian Maglie <c.maglie@example.com>, Pippo Pluto <pippo@example.com>`
`4`	`4`	`maintainer=Cristian Maglie <c.maglie@example.com>`
Original file line number	Diff line number	Diff line change
@@ -1509,7 +1509,7 @@ var _arduinoLibraryPropertiesDefinitionsSchemaJson = []byte(`{
`1509`	`1509`	`"$ref": "#/definitions/propertiesObjects/name/specification/object"`
`1510`	`1510`	`},`
`1511`	`1511`	`{`
`1512`		`- "maxLength": 16`
	`1512`	`+ "maxLength": 32`
`1513`	`1513`	`},`
`1514`	`1514`	`{`
`1515`	`1515`	`"$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsSpaces"`