Enable checkstyle to detect incorrect package header #594
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
QubitPi
force-pushed
the
enhance-checkstyle
branch
from
d002340 to
1a40ae5
Compare
QubitPi
commented
Dec 2, 2017
checkstyle-style.xml
Outdated
| @@ -16,8 +16,6 @@ | |||
| <!-- Make the @SuppressWarnings annotations available to Checkstyle --> | |||
| <module name="SuppressWarningsHolder" /> | |||
|
|
|||
| <module name="FileContentsHolder" /> | |||
There was a problem hiding this comment.
This is removed in new release. FileContentsHolder is not required any more and just need to be removed from clients configurations.
| @@ -263,6 +266,8 @@ | |||
| <property name="tokens" value="VARIABLE_DEF"/> | |||
| </module> | |||
|
|
|||
| <module name="SuppressionCommentFilter"/> | |||
There was a problem hiding this comment.
SuppressionCommentFilter is moved and now becomes a child of TreeWalker in new release
| @@ -46,8 +46,6 @@ public PaginationMapper( | |||
| * @param resultSet The result set to be cut down. | |||
| * | |||
| * @return The page of results desired. | |||
| * | |||
| * @throws com.yahoo.bard.webservice.web.PageNotFoundException if the page requested is past the last page of data. | |||
There was a problem hiding this comment.
Updated checkstyle detected that this method is actually not throwing exception, thus removing it:
JavadocMethod: Unused @throws tag for 'com.yahoo.bard.webservice.web.PageNotFoundException'.
| @@ -29,8 +29,8 @@ | |||
| */ | |||
| boolean handleRequest( | |||
| RequestContext context, | |||
| final DataApiRequest request, | |||
| final DruidAggregationQuery<?> druidQuery, | |||
| final ResponseProcessor response | |||
There was a problem hiding this comment.
| @@ -366,6 +366,5 @@ public void setDeleted(int deleted) { | |||
| public void setAdditionalProperty(String name, String value) { | |||
| this.additionalProperties.put(name, value); | |||
| } | |||
|
|
|||
There was a problem hiding this comment.
(regexp) RegexpMultiline: Extra lines between braces
QubitPi
commented
Dec 3, 2017
|
|
||
| <module name="FileContentsHolder" /> | ||
| <!-- Make the @SuppressWarnings annotations available to Checkstyle --> | ||
| <module name="SuppressWarningsHolder" /> |
| <!-- Make the @SuppressWarnings annotations available to Checkstyle --> | ||
| <module name="SuppressWarningsHolder" /> | ||
|
|
||
| <module name="FileContentsHolder" /> |
There was a problem hiding this comment.
FileContentsHolder is removed from new release. It is not required any more and just need to be removed from clients configurations.
michael-mclawhorn
approved these changes
Dec 5, 2017
QubitPi
force-pushed
the
enhance-checkstyle
branch
from
2fb0439 to
0ff70f9
Compare
QubitPi
force-pushed
the
enhance-checkstyle
branch
from
0ff70f9 to
5fd89a5
Compare
efronbs
approved these changes
Dec 7, 2017
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.
@michael-mclawhorn and I noticed a while ago that Fili was able to pass the build with wrong package headers in some source files. This needs to be fixed, and it's fixed in this PR by adding
PackageDeclarationcheckstyle rule.In addition, checkstyle version has been bumped to the latest one(Nov, 2017), which is now able to detect more styling errors.