Improve output #99
Merged
Improve output #99
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
Dec 11, 2020
The log output is not of interest to the ordinary users, so it should only be enabled when one of the logging configuration environment variables is set.
The error must always be printed with a newline, otherwise the log will be appended to the output. This follows the convention set by the Arduino CLI feedback package.
Even though not currently needed, this brings consistency with the standard fmt API.
The previous approach of adding trailing newlines when the report text was generated made it difficult to keep track of how the output was formatted.
It's better for this function to be exclusively for the running of checks. It is more sensible for the project related output to be handled at a higher level.
These uses of `feedback.Error()` in the event of internal failures was a departure from the convention established in the rest of the code of using `feedback.Error()` only for failures resulting from external issues, and panic() for those resulting from internal issues (in which case the traceback is useful).
This log output is only meaningful if there wasn't an error.
per1234
force-pushed
the
per1234/improve-output
branch
from
8dfc5f2 to
23d32fd
Compare
per1234
added
topic: code
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.
No description provided.