Restore normalization of library metadata #34
Merged
Conversation
This file contains hidden or 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
silvanocerza
approved these changes
May 24, 2021
When the code was switched to using Arduino Lint for release validation, the `metadata.Validate()` function was removed. At a closer look, it turns out that this function did normalization in addition to validation of the metadata. One such normalization was to convert the "relaxed semver" version format which is allowed to be used in Arduino Library metadata to be compliant with the standardized "semver" version specification, which is used in the Library Manager index. Here, the version normalization is restored. Rather than using bespoke code for this purpose as before, the `go.bug.st/relaxed-semver` package is used, as in Arduino CLI and Arduino Lint. This will provide consistency and reduce maintenance burden.
When the code was switched to using Arduino Lint for release validation, the `metadata.Validate()` function was removed. At a closer look, it turns out that this function did normalization in addition to validation of the metadata. One such normalization was to restrict the `category` field value in the library metadata to the allowed values listed in the Arduino Library Specification, falling back to "Uncategorized" in the event the library has an unsupported value. Here, the category normalization is restored. Rather than using bespoke code to define the valid categories as before, the `github.com/arduino/arduino-cli/arduino/libraries` package is used, as in Arduino CLI. This will provide consistency and reduce maintenance burden.
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.
When the code was switched to using Arduino Lint for release validation (#18), the
metadata.Validate()function was removed.At a closer look, it turns out that this function did normalization in addition to validation of the metadata:
Make
versionsemver-compliantArduino Lint's rule
LP021encourages semver compliance. However, violation of this rule in the mode used by the engine only results in a warning, so normalization is still needed.Arduino Lint's rule
LP020enforces compliance with "relaxed semver", so it's only the normalization aspect that need be restored.Populate
maintainerfield withauthorvalue if emptyArduino Lint's rule
LP026requires themaintainerfield to be defined and non-empty, and will cause any library release in violation of this rule to be rejected by the engine, so there is no need to restore the normalization code for this field.Change invalid
categoryvalue to "uncategorized"Arduino Lint's rule
LP038encourages the use of valid categories. However, violation of this rule in the mode used by the engine only results in a warning, so normalization is still needed.Rather than using bespoke code for normalization as was done before, I have utilized the same code as in Arduino CLI:
go.bug.st/relaxed-semverpackagegithub.com/arduino/arduino-cli/arduino/librariespackageThis introduces some new dependencies to the tool.