Make linting failure message more clear #34497
Merged
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
|
Then maybe remove "Formatted foo.json" line? It only confuses, as for me. |
anothersimulacrum
force-pushed
the
lint-clearer
branch
from
53d026a
to
4c1a279
Compare
Right now when a json file is not linted, the program just says 'Formatted $FILENAME' and exits - this doesn't make it particularly clear what is wrong when a file is not linted. This aims to make it more clear for new contributors.
|
Done. |
Davi-DeGanne
reviewed
Oct 6, 2019
| @@ -203,7 +203,7 @@ int main( int argc, char *argv[] ) | |||
| std::ofstream fout( filename, std::ios::binary | std::ios::trunc ); | |||
| fout << out.str(); | |||
| fout.close(); | |||
| std::cout << "Formatted " << filename << std::endl; | |||
| std::cout << filename << " needs to be linted" << std::endl; | |||
There was a problem hiding this comment.
Regarding
Not doing this, as it can indicate that the contributor hasn't read the JSON style guide.
Might I suggest explicitly mentioning this in the failure text? Some users may not even know the style guide exists.
Suggested change
| std::cout << filename << " needs to be linted" << std::endl; | |
| std::cout << filename << " needs to be linted" | |
| "\nPlease read doc/JSON_STYLE.md" << std::endl; |
There was a problem hiding this comment.
Oh, I didn't see this, sorry.
I don't have any problems doing it
Though I would have done
Suggested change
| std::cout << filename << " needs to be linted" << std::endl; | |
| std::cout << filename << " needs to be linted" << std::endl; | |
| std::cout << "Please read doc/JSON_STYLE.md" << std::endl; |
If you'd like to PR it, feel free.
There was a problem hiding this comment.
No worries. And fair enough, that is way cleaner.
ZhilkinSerg
added
Code: Build
Davi-DeGanne
pushed a commit
to Davi-DeGanne/Cataclysm-DDA
that referenced
this pull request
Oct 9, 2019
To inform new contributors of the existance of the style guide expands on CleverRaven#34497
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.
Summary
SUMMARY: None
Purpose of change
Make it more clear what is wrong when a file is not linted.
Describe the solution
Add a line that says '$FILENAME needs to be linted' to the output when a file is not linted.
Describe alternatives you've considered
Not doing this, as it can indicate that the contributor hasn't read the JSON style guide.