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.

Sign up for GitHub

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

Jump to bottom

[doc] Review guides for writing java/xpath rules for correctness with PMD 7 #2511

Closed
Tracked by #3898
adangel opened this issue May 20, 2020 · 0 comments · Fixed by #4762
Closed
Tracked by #3898

[doc] Review guides for writing java/xpath rules for correctness with PMD 7 #2511

adangel opened this issue May 20, 2020 · 0 comments · Fixed by #4762
Assignees
@adangel
Labels
an:enhancement An improvement on existing features / rules in:documentation Affects the documentation
Milestone
7.0.0

Comments

@adangel
Copy link
Member

adangel commented May 20, 2020 •
edited
Loading

Part of #1139

  • current page: https://pmd.github.io/latest/pmd_userdocs_extending_writing_rules_intro.html
    and the others in this section
  • How to report violations
  • variable interpolation in violation messages
    • the placeholder format {0} ...
    • and the PMD specific format ${variableName} - this refers to extra parameters in the rule violation or to rule properties
  • PMD's special XPath functions
    (matches, typeIs, typeIsExactly, getCommentOn, metric (that is actually documented))
@adangel adangel added an:enhancement An improvement on existing features / rules in:documentation Affects the documentation labels May 20, 2020
@adangel adangel added this to the 7.0.0 milestone May 20, 2020
@oowekyala oowekyala mentioned this issue May 20, 2020
Closed
13 tasks
This was referenced Jan 16, 2023
Merged
Closed
@adangel adangel self-assigned this Dec 1, 2023
adangel added a commit to adangel/pmd that referenced this issue Dec 7, 2023
@adangel
[doc] Update rule writing docs (pmd#2511)
add430b
adangel added a commit to adangel/pmd that referenced this issue Dec 7, 2023
@adangel
[doc] Update rule writing docs (pmd#2511)
fa12c0d
adangel added a commit to adangel/pmd that referenced this issue Dec 7, 2023
@adangel
[doc] Update rule writing docs (pmd#2511)
10dd8e0
adangel added a commit to adangel/pmd that referenced this issue Dec 7, 2023
@adangel
[doc] Update release notes (pmd#2511)
ad00f1f
@adangel adangel mentioned this issue Dec 7, 2023
Merged
4 tasks
adangel added a commit to adangel/pmd that referenced this issue Dec 8, 2023
@adangel
[doc] Update rule writing docs (pmd#2511)
b6df95c 
Add NodeStream
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@adangel adangel

Labels
an:enhancement An improvement on existing features / rules in:documentation Affects the documentation
Projects
None yet
Milestone
7.0.0
Development

Successfully merging a pull request may close this issue.

[doc] Review rule writing documentation for PMD 7 adangel/pmd
1 participant
@adangel