Provide natively loaded package index project data #187
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
Each possible problem with the project is handled by a dedicated rule. One such problem is that the project was not found. Each rule must be configured so that unrelated problems with the project will not cause them to break or provide incorrect results. This can result in a lot of redundant boilerplate code. Before running a rule against the package index data, it is always necessary to check whether the data is available. If not, running the rule is abandoned with a "NotRun" result. This which results in just such boilerplate, but is likely to be unavoidable without breaking from the modular architecture of the rules system. If the package index file itself was not found, then the loading of the data can not be accomplished, and thus a missing package index should also be cause for abandoning the run of data rules. The check for data can serve as an implicit check for the existence of the data source, meaning additional rule function boilerplate for file existence check can be avoided.
Arduino CLI's package index loading function can can be useful in its current capacity as a general check on the validity of the package index as far as Arduino CLI is concerned, used for that purpose by a single dedicated rule. However, it can not be used as a data source for other rules because Arduino CLI should attempt to be resilient to bad data when possible, while Arduino Lint needs to detect the very bad data that Arduino CLI might correct. So the data from the native loading code must be used in all rules, while the value from Arduino CLI's load is solely in whether or not it returned an error.
per1234
added
type: enhancement
Codecov Report
@@ Coverage Diff @@
## main #187 +/- ##
=======================================
Coverage 84.45% 84.45%
=======================================
Files 43 43
Lines 3017 3082 +65
=======================================
+ Hits 2548 2603 +55
- Misses 375 380 +5
- Partials 94 99 +5
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
per1234
changed the title
umbynos
approved these changes
Jun 11, 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.
Arduino CLI's package index loading function can can be useful in its current capacity as a general check on the validity of the package index as far as Arduino CLI is concerned, used for that purpose by a single dedicated rule (
ID002.However, it can not be used as a data source for other rules because Arduino CLI should attempt to be resilient to bad data when possible, while Arduino Lint needs to detect the very bad data that Arduino CLI might correct.
So the data from the native loading code must be used in all rules, while the value from Arduino CLI's load is solely in whether or not it returned an error.