openrewrite / openrewrite/rewrite

CheckstyleConfigLoader does not support TodoComment

Open
#3,124 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Java
Stars
3.7k
Forks
570
Avg merge
13h 12m
Merged PRs (30d)
261

Description

<module name="TodoComment">
  <property name="severity" value="${checkstyle.todocomment.severity}" default="info"/>
  <property name="format" value="${checkstyle.todocomment.format}" default="(TODO)|(todo:)|(FIXME)|(fixme)"/>
</module>

https://github.com/openrewrite/rewrite/blob/f41b0575acf959c8b47c478e7de9b4b2a4147ce7/rewrite-java/src/main/java/org/openrewrite/java/style/CheckstyleConfigLoader.java

https://checkstyle.sourceforge.io/apidocs/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheck.html

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with rewrite-java/src/main/java/org/openrewrite/java/style/CheckstyleConfigLoader.java and compare its supported modules with Checkstyle's TodoCommentCheck documentation. Trace how the shown severity and format properties are handled, then confirm that the TodoComment XML configuration is recognized with the documented defaults.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.