Skip to content

Increase Library name length from 16 to 32 #511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 17, 2023
Merged

Increase Library name length from 16 to 32 #511

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ea63a33
Change "maxLength" value from 16 to 64
aliphys Mar 13, 2023
e850295
Update LP010 message
aliphys Mar 13, 2023
629e774
32 characters is enough for library name
aliphys Mar 16, 2023
4ea2ce2
Change schema maxLength to 32
aliphys Mar 17, 2023
b0f7c8a
Change test name to NameGTRecommendedLength
aliphys Mar 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion etc/schemas/arduino-library-properties-definitions-schema.json
View file
Open in desktop
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
},
{
"$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsSpaces"
Expand Down
2 changes: 1 addition & 1 deletion internal/rule/ruleconfiguration/ruleconfiguration.go
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.",
Reference: "https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []rulemode.Type{rulemode.Default},
Expand Down