[IGNITE-21467] Improve PMD and Checkstyle rulesets

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Component/s: build
• Labels: ignite-3
• Ignite Flags: Docs Required, Release Notes Required
• Assignee: Viacheslav Blinov
• Reporter: Mikhail Pochatkin
• Created: 06/Feb/24 12:51
• Updated: 27/Feb/24 15:29
• Resolved: 27/Feb/24 15:29

Description

1. Remove modernizer plugin and migrate all rules to PMD\Checkstyle. check-rules/modernizer-rules.xml
2. Introduce separate checkstyle ruleset for public API module (modules/api). This ruleset should be more strict than internal one:
   1. All public method must have Javadocs (currently in internal code field getters may haven't Javadocs)
   2. /** {@inheritDoc} */ is not applicable for public API

Issue Links

• fixes: IGNITE-20980 PMD - replace deprecated rules with new ones to be able to upgrade to PMD 7.x.
• fixes: IGNITE-20981 Add more PMD rules
• fixes: IGNITE-20982 Add checks to cover comments style
• is related to: IGNITE-21569 Introduce Spotbugs checks
• relates to: IGNITE-21582 Checkstyle: introduce a separate javadoc rules for public api module
• links to: GitHub Pull Request #3239