Add min length rule for library.properties url field #176
+60
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, the permissive compliance mode only required that the library.properties url field was present. The field was allowed to be empty in this mode. Investigation revealed that the Arduino Library Manager indexer system, which Arduino Lint's permissive compliance mode is intended to match, requires the url field value to be at least one character long: https://github.com/arduino/libraries-repository-engine/blob/c395aaf14e7568f585a6a96350b584682a3c7feb/libraries/metadata/metadata.go#L110
Codecov Report
@@ Coverage Diff @@
## main #176 +/- ##
==========================================
+ Coverage 84.34% 84.36% +0.01%
==========================================
Files 43 43
Lines 2971 2986 +15
==========================================
+ Hits 2506 2519 +13
- Misses 373 374 +1
- Partials 92 93 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
silvanocerza
approved these changes
May 27, 2021
rsora
approved these changes
May 27, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, the "permissive" compliance mode only required that the library.properties
urlfield was present. The field wasallowed to be empty in this mode (in the more strict compliance modes the value is required to be a valid URI, which provides an implicit length requirement).
Investigation revealed that the Arduino Library Manager indexer system, which Arduino Lint's "permissive" compliance mode
is intended to match, requires the
urlfield value to be at least one character long:https://github.com/arduino/libraries-repository-engine/blob/c395aaf14e7568f585a6a96350b584682a3c7feb/libraries/metadata/metadata.go#L110
For this reason, a new rule (
LP056) must be added to check theurlvalue length.