Increase Library name length from 16 to 32

[aliphys]

As reported in #508 , the current linter rules limit the max number of characters for a library name to 16.

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

Line 94 in c2c82d6

"maxLength": 16

arduino-lint/internal/rule/ruleconfiguration/ruleconfiguration.go

Line 427 in c2c82d6

MessageTemplate: "library.properties name value {{.}} is longer than the recommended length of 16 characters.",

As noted by @aentinger , since Arduino libraries start with Arduino_, this leaves only 8 characters to describe the library according to the linter rules. This PR increases the maximum length of a library name to 64 32 characters. For official libraries with the leading Arduino_, this provides 56 24 characters which should be sufficent to describe the library in a UX-friendly manner.

[aliphys]

@per1234 , I saw you self assigned on #508 .
I increased the character length to 64 in this PR. Could you review it? Thanks :)

[aentinger]

Honestly, I feel 64 is a bit too much 😉 .

After all we do not want to encourage ThisIsMyFancyArduinoLibraryWhichHasATotalLongAndIncromprehensib(le Name).

I believe 32 would be enough by far.

Secondly, we could add an "exception" for official Arduino libraries, insofar that the "Arduino_" prefix is not counting towards the limit of 16 characters.

@per1234 @aliphys what is your feedback to this?

[aliphys]

You bring a very compelling example @aentinger . Changed it to 32 characters. 👍

[per1234]

@aliphys please update the value here as well:

arduino-lint/internal/rule/schema/schemadata/bindata.go

Line 1512 in 629e774

"maxLength": 16

---

Please update the test data here:

arduino-lint/internal/rule/rulefunction/testdata/libraries/NameGTRecommendedLength/library.properties

Line 1 in 629e774

name=NameGTRecommendedLength

[per1234]

@91volt @cmaglie @ubidefeo please discuss the recommended maximum library name length here as requested by @aentinger.

[91volt]

32 is fine 👍

[cmaglie]

Secondly, we could add an "exception" for official Arduino libraries, insofar that the "Arduino_" prefix is not counting towards the limit of 16 characters.

I agree, but that should be valid also for other vendors, like Adafruit_, SparkFun_, ????_... which have a lot of libraries.

Anyway, I guess that just increasing the limit to 32 should already alleviate it.

[aentinger]

Don't get me wrong, "36" is fine too. I was just baffled to be presented with this number out of the blue. If 36 makes sense because its the max amount of chars that can be sensibly displayed by the IDE then this is a reasonable criteria imho.

I agree, but that should be valid also for other vendors, like Adafruit_, SparkFun_, ????_... which have a lot of libraries.

Fair enough 😁 . It was just a thought. Given that it is "just" a warning leaving it at 16 is also fine, but I think you all know about the dangers of ignoring warnings and normalization of deviance. Both 36 or 32 would alleviate that pain point for all involved. I'd be fine with going ahead with 36.

[cmaglie]

LOL, ok, let's not get this longer than needed...

I decide: let's go with 32 :-)

[codecov-commenter]

Codecov Report

Patch and project coverage have no change.

Comparison is base (c2c82d6) 90.05% compared to head (b0f7c8a) 90.05%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #511   +/-   ##
=======================================
  Coverage   90.05%   90.05%           
=======================================
  Files          44       44           
  Lines        6800     6800           
=======================================
  Hits         6124     6124           
  Misses        553      553           
  Partials      123      123           

Flag	Coverage Δ
unit	90.05% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...ternal/rule/ruleconfiguration/ruleconfiguration.go	100.00% <ø> (ø)
internal/rule/schema/schemadata/bindata.go	49.67% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[aliphys]

Since we decided together on 32 characters as the max library length 🎉 , I changed NameGTRecommendedLength (23 characters) to NameIsBiggerThanRecommendedLength (33 characters).

[aliphys]

For the record, Codecov is really useful for the CI/CD testing pipeline. When I changed the schema file (b0f7c8a) to 32 it reported a loss in code coverage.

This was then resolved immediately after b0f7c8a

😄