Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Generate a complete rule catalog in a machine-readable format #4295

Open
adangel opened this issue Jan 10, 2023 · 0 comments
Open

[doc] Generate a complete rule catalog in a machine-readable format #4295

adangel opened this issue Jan 10, 2023 · 0 comments
Labels
in:documentation Affects the documentation
Milestone

Comments

@adangel
Copy link
Member

adangel commented Jan 10, 2023

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in:documentation Affects the documentation
Projects
None yet
Development

No branches or pull requests

1 participant