openrewrite / openrewrite/rewrite

CheckstyleConfigLoader does not support JavadocStyle - checkFirstSentence

Open
#3,134 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

While not all of JavadocStyle can be fixed checkFirstSentence can be

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

        <module name="JavadocStyle">
            <property name="severity" value="${checkstyle.javadocstyle.severity}" default="warning"/>
            <property name="scope" value="${checkstyle.javadocstyle.scope}" default="public"/>
            <property name="checkFirstSentence" value="${checkstyle.javadocstyle.checkfirstsentence}" default="true"/>
            <property name="checkEmptyJavadoc" value="${checkstyle.javadocstyle.checkemptyjavadoc}" default="true"/>
            <property name="checkHtml" value="${checkstyle.javadocstyle.checkhtml}" default="true"/>
            <property name="tokens" value="${checkstyle.javadocstyle.tokens}" default="ANNOTATION_DEF, ANNOTATION_FIELD_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF, INTERFACE_DEF, METHOD_DEF, PACKAGE_DEF, VARIABLE_DEF"/>
        </module>

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 at CheckstyleConfigLoader, the entry point named in the issue, and compare its JavadocStyle handling with the Checkstyle JavadocStyleCheck documentation linked above. Verify the loader accepts the checkFirstSentence property and add or update coverage for that configuration; done means the property is supported without breaking existing JavadocStyle options.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Feature
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.