-
Notifications
You must be signed in to change notification settings - Fork 60
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for 'checkstyle' output #209
Conversation
e48f030
to
3ef25f4
Compare
3ef25f4
to
c377490
Compare
ecff65c
to
c5f6dcb
Compare
Codecov Report
@@ Coverage Diff @@
## main #209 +/- ##
==========================================
- Coverage 94.49% 93.76% -0.73%
==========================================
Files 22 23 +1
Lines 781 818 +37
==========================================
+ Hits 738 767 +29
- Misses 25 30 +5
- Partials 18 21 +3
Continue to review full report at Codecov.
|
c5f6dcb
to
e98d8e9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One last comment, otherwise LGTM
{Name: xml.Name{Local: "version"}, Value: "5.0"}, | ||
}, | ||
}); err != nil { | ||
panic(err) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not a fan of using panic as it's not the best user experience, but Start
doesn't return an error so that's more of an issue for the interface and not for what implements it. Nothing for you to do here but just felt like commenting on it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I agree. I wanted to be able to return an error and not silently ignore the problem. Maybe in a future PR the signature of the function can change to return an error.
Thanks! |
Released in |
Please check if the PR fulfills these requirements
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Add support for the
checkstyle
output format. Checkstyle is a static code analysis tool used in software development.What is the current behavior? (You can also link to an open issue here)
Currently,
woke
supports the following output formats:text
,simple
,github-actions
,json
andsonarqube
.What is the new behavior (if this is a feature change)?
Adding new output format (checkstyle).
Does this PR introduce a breaking change? (What changes might users need to make due to this PR?)
No
Other information:
Checkstyle is a static code analysis tool used in software development. While checkstyle was originally designed for Java static analysis, multiple CICD tools support the
checkstyle
XML format. The checkstyle format can be used to report generic static analysis issues, not just Java. A list of supported tools is available at https://checkstyle.org/index.html#Related_Tools_Active_ToolsFor example:
checkstyle
format.checkstyle
format.Though the
checkstyle
format is very simple, there is no formal XSD. See checkstyle/checkstyle#5166