Add a Library Manager configuration for linting while indexing releases #170
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
Some of Arduino Lint's rules are based on the data in the published Arduino Library Manager index. These allow library maintainers to check compliance with the Library Manager submission or update requirements. Work is now in progress to use Arduino Lint to validate library releases during the generation of the index. In this usage, data from the published index is not relevant, meaning the results from those rules are inaccurate and so downloading the index for the sake of them is a waste. So another configuration mode is needed to to allow the index-based rules to be disabled. Since this mode is of no use to normal users of Arduino Lint, it is enabled via an environment variable so that no unnecessary complexity is added to the standard UI of the tool. The environment variable name is `ARDUINO_LINT_LIBRARY_MANAGER_INDEXING`.
per1234
added
type: enhancement
Codecov Report
@@ Coverage Diff @@
## main #170 +/- ##
==========================================
+ Coverage 84.27% 84.32% +0.04%
==========================================
Files 43 43
Lines 2957 2966 +9
==========================================
+ Hits 2492 2501 +9
Misses 373 373
Partials 92 92
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 12, 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.
Some of Arduino Lint's rules are based on the data in the published Arduino Library Manager index. These allow library maintainers to check compliance with the Library Manager submission or update requirements.
Work is now in progress to use Arduino Lint to validate library releases during the generation of the index. In this usage, data from the published index is not relevant, meaning the results from those rules are inaccurate and so downloading the index for the sake of them is a waste. So another configuration mode is needed to to allow the index-based rules to be disabled.
Since this mode is of no use to normal users of Arduino Lint, it is enabled via an environment variable so that no unnecessary complexity is added to the standard UI of the tool. The environment variable name is
ARDUINO_LINT_LIBRARY_MANAGER_INDEXING.