Skip to content

[doc] Mention test-pmd-tool as alternative for testing#6396

Merged
adangel merged 5 commits intopmd:mainfrom
metalshark:patch-2
Feb 17, 2026
Merged

[doc] Mention test-pmd-tool as alternative for testing#6396
adangel merged 5 commits intopmd:mainfrom
metalshark:patch-2

Conversation

@metalshark
Copy link
Contributor

Describe the PR

Adds a new entry to the list of third-party PMD rulesets in the documentation. It introduces the test-pmd-rule project, which provides unit test coverage for PMD XPath rules using its own examples.

Documentation update:

  • Added test-pmd-rule to the list of third-party PMD rulesets in docs/pages/pmd/userdocs/3rdpartyrulesets.md, including a link to its repository.

Ready?

  • Added unit tests for fixed bug/feature
  • Passing all unit tests
  • Complete build ./mvnw clean verify passes (checked automatically by github actions)
  • Added (in-code) documentation (if needed)

@pmd-actions-helper
Copy link
Contributor

pmd-actions-helper bot commented Jan 13, 2026

Documentation Preview

No regression tested rules have been changed.

(comment created at 2026-02-17 19:15:50+00:00 for f2286a8)

@metalshark
Copy link
Contributor Author

If you’re happy with the code/direction I am open to donating the code to the PMD project.

@goto-dev-null
Copy link
Contributor

I am just a passerby so apologies if it's severe ignorance but the link does not work. Looking at the profile I think you meant https://github.com/starch-uk/test-pmd-tool ?

@metalshark
Copy link
Contributor Author

I am just a passerby so apologies if it's severe ignorance but the link does not work. Looking at the profile I think you meant https://github.com/starch-uk/test-pmd-tool ?

Thank you @goto-dev-null

Copy link
Member

@adangel adangel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!

While your project is interesting, I don't think it fits into the page "3rd party rulesets", as it doesn't provide rules. It's an alternative way to https://docs.pmd-code.org/latest/pmd_userdocs_extending_testing.html . Maybe it's better to mention this on that page?

@adangel adangel changed the title [apex] Add new 3rd party rulesets for Apex testing [doc] Mention test-pmd-tool as alternative for testing Feb 17, 2026
@adangel adangel added the in:documentation Affects the documentation [doc] label Feb 17, 2026
@adangel adangel added this to the 7.22.0 milestone Feb 17, 2026
Copy link
Member

@adangel adangel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I've moved your tool to the other page, were we explain how to test rules.

@metalshark
Copy link
Contributor Author

So sorry, forgot to come back to this. Thank you.

@adangel adangel merged commit 37c1604 into pmd:main Feb 17, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in:documentation Affects the documentation [doc]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants