Increase Library name length from 16 to 32 #511

Original file line number	Diff line number	Diff line change
Expand Up		@@ -91,7 +91,7 @@
		"$ref": "#/definitions/propertiesObjects/name/specification/object"
		},
		{
	"maxLength": 16
	"maxLength": 32
aliphys marked this conversation as resolved. Show resolved Hide resolved
		},
		{
		"$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsSpaces"
Expand Down

2 changes: 1 addition & 1 deletion internal/rule/ruleconfiguration/ruleconfiguration.go

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -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.",
aliphys marked this conversation as resolved. Show resolved Hide resolved
		Reference: "https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
		DisableModes: nil,
		EnableModes: []rulemode.Type{rulemode.Default},
Expand Down

2 changes: 1 addition & 1 deletion internal/rule/rulefunction/library_test.go

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -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, ""},
		}

Expand Down

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
		@@ -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>
Expand Down

Show comments View file Open in desktop

File renamed without changes.

2 changes: 1 addition & 1 deletion internal/rule/schema/schemadata/bindata.go

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -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"
Expand Down

Navigation Menu