This should be initially a simple csv format (with columns for rule name, ruleset, language,
description, since, deprecation, unique rule reference, properties, etc.)
for ease to use in spreadsheet software.
Additionally a more structured format using JSON should be provided, which makes it easier
to use in the browser.
The rule catalog needs to be generated during the build (e.g. in pmd-doc), as the rule
properties are only available at runtime.
This allows to use this later for: comparing the rules between two releases (which rules
are new, which are deprecated now, etc.), consuming the catalog in a ruleset builder
or editor.
Note: This depends on PMD 7.0.0 API - the ruleset schema
Related issues:
This should be initially a simple csv format (with columns for rule name, ruleset, language,
description, since, deprecation, unique rule reference, properties, etc.)
for ease to use in spreadsheet software.
Additionally a more structured format using JSON should be provided, which makes it easier
to use in the browser.
The rule catalog needs to be generated during the build (e.g. in pmd-doc), as the rule
properties are only available at runtime.
This allows to use this later for: comparing the rules between two releases (which rules
are new, which are deprecated now, etc.), consuming the catalog in a ruleset builder
or editor.
Note: This depends on PMD 7.0.0 API - the ruleset schema
Related issues: