Skip to content

Allow suppression of TODO checkstyle check #727

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.

Sign up for GitHub

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

Merged
bulldozer-bot merged 3 commits into from
Aug 2, 2019
Merged

Allow suppression of TODO checkstyle check #727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1388fbe
Eliminate unhelpful, widely disobeyed TODO check
jdm2212 Aug 1, 2019
49dacf7
add id, clarify comment
jdm2212 Aug 2, 2019
16cdfc4
Create pr-727.v2.yml
jdm2212 Aug 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .baseline/checkstyle/checkstyle.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,8 +374,9 @@
<property name="message" value="Redundant ''static'' modifier."/>
</module>
<module name="RegexpSinglelineJava">
<property name="id" value="TodoFormat"/>
<property name="format" value="\/\/TODO|\/\/ TODO(?!\([^()\s]+\): )"/>
<property name="message" value="TODO format: // TODO(#issue): explanation"/>
<property name="message" value="TODO format: '// TODO(#issue): explanation' or '// TODO(username): explanation'"/>
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="(void setUp\(\))|(void setup\(\))|(void setupStatic\(\))|(void setUpStatic\(\))|(void beforeTest\(\))|(void teardown\(\))|(void tearDown\(\))|(void beforeStatic\(\))|(void afterStatic\(\))"/>
Expand Down
5 changes: 5 additions & 0 deletions changelog/@unreleased/pr-727.v2.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
type: improvement
improvement:
description: "Allow suppression of the TODO checkstyle check by giving it an ID. Clarify its comment to allow // TODO(username): ..."
links:
- https://github.com/palantir/gradle-baseline/pull/727