[java] Rename rule InvalidSlf4jLoggingFormat to InvalidLogMessageFormat

[adangel]

Follow-up on #2012 / #336

[pmd-test]

	1 Message
📖	This changeset introduces 0 new violations, 0 new errors and 0 new configuration errors, removes 0 violations, 0 errors and 0 configuration errors. Full report
✅	This changeset introduces 0 new violations, 0 new errors and 0 new configuration errors, removes 0 violations, 0 errors and 0 configuration errors. Full report

Generated by 🚫 Danger

[jsotuyod]

Should we do it this way through a deprecation? or simply rename it in the XML and use the RuleSetFactoryCompatibility to rewrite references?

[adangel]

Should we do it this way through a deprecation? or simply rename it in the XML and use the RuleSetFactoryCompatibility to rewrite references?

I'd prefer to do it via deprecation. The ruleset factory compatibility is currently handling only /rulesets/... and not the categories. I was going to say, that the deprecation method has the advantage, that we log it - but I see, we do this for the compatibility filters as well. So, the user sees in any case, that his ruleset might not work with a later version of PMD.

Looking at the old release notes, we didn't rename a single rule since we switched to categories. We only deprecated some rules, that we are going to replace with other rules.

I'd still prefer the deprecation mechanism over the rewriting of the ruleset, because

• We automatically get it documented on the rule documentation pages ✔️
• We don't need to maintain the filter - which only works on simple text search/replace on single lines and not on actual XML. Which causes some issues (e.g. [java] RuleSetFactoryCompatibility.java uses regular expressions which cause false positive warnings against rules that are commented out in the xml config file #393 and [core] RulesetFactoryCompatibility stores the whole ruleset file in memory as a string #1451). So I'd really like to get rid of this. With PMD 7, we'll remove the rulesets under "/rulesets/..." and only keep the category-rulesets. And we might have anyway a different compatibility layer to work with PMD6 rulesets in PMD7...

I'll double check, that we really get the deprecation warning and the documentation:

The documentation looks like this:

This is automatically generated by just tagging the rule as deprecated and reference the new rule.

And it is getting logged on the CLI:

Oct 26, 2019 10:16:26 AM net.sourceforge.pmd.RuleSetFactory parseRuleReferenceNode
WARNING: Use Rule name category/java/errorprone.xml/InvalidLogMessageFormat instead of the deprecated Rule name category/java/errorprone.xml/InvalidSlf4jMessageFormat. PMD 7.0.0 will remove support for this deprecated Rule name usage.
Oct 26, 2019 10:16:26 AM net.sourceforge.pmd.RuleSetFactory parseRuleReferenceNode
WARNING: Use Rule name category/java/errorprone.xml/InvalidLogMessageFormat instead of the deprecated Rule name category/java/errorprone.xml/InvalidSlf4jMessageFormat. PMD 7.0.0 will remove support for this deprecated Rule name usage.

for some reason, it is logged twice...
This is being fixed via #2086 ✔️

[adangel]

With the logging, there seem to be more issues:

• deprecation warning is logged twice, although the rule is referenced only once
• if the complete category ruleset is referenced, the deprecation warning is logged once - but I think, in that case, we should not consider renamed rules and ignore such deprecated rules
• if the complete category ruleset is referenced and the deprecated rule is excluded, we still log the deprecation warning. this looks totally wrong.

This logging is somehow related to #2059, which is just a special case.
Fixing these issues is outside of the scope of this PR -> fixed via #2086 ✔️