[core] Analysis listeners #3692
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Remove some stuff with parser options Get rid of SourceCodeProcessor Seal processor hierarchy
Big cleanup of RuleContext, RuleViolationFactory API Somewhat depends on text documents (FileLocation actually)
Fix tests
Not useful outside of unit tests
Checkstyle + pmd
7 tasks
This was referenced Feb 13, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe the PR
This is a pretty old PR of mine which refactors the high-level execution logic of PMD. The new abstraction GlobalAnalysisListener (and its helper FileAnalysisListener) implements the listener pattern for an analysis. Violations and errors are the kinds of events that are forwarded to this listener. Renderers now use this API to receive these events and produce a report or output it it. With this design analysis does not necessarily produce a Report object, if that's not needed. I expect this is might be useful for IDE integrations.
SourceCodeProcessor is removed and its functionality merged into PmdRunnable. RuleContext is not analysis-global anymore, instead it provides API for rules to report violations on. Eventually I want rule implementations to have type-safe access to a RuleContext object, eg by making them implement
AstVisitor<RuleContext, Void>.This is part of a pretty long chain of local branches (first PR was #3085), which aim to
These branches currently culminate with the implementation of a Javadoc parser using these new APIs. Using TextDocuments we can also eventually support #693, and I actually have an ugly prototype in my branches. Another cool thing I've been working on is copy-paste detection based not on tokens but on ASTs, which gives much more precise results as CPD and could possibly be part of pmd 7 as a new PMD rule.
Related issues
Ready?
./mvnw clean verifypasses (checked automatically by github actions)