[xml] Add MissingEncoding rule #4592
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
- Enforce XML files have an encoding set in the XML Declaration
4 tasks
Generated by 🚫 Danger |
oowekyala
reviewed
Jun 24, 2023
| <property name="xpath"> | ||
| <value> | ||
| <![CDATA[ | ||
| //document[@XmlEncoding = ""] |
There was a problem hiding this comment.
Suggested change
| //document[@XmlEncoding = ""] | |
| /document[@XmlEncoding = ""] |
This otherwise looks ok to me, but I think ideally we would expose this through an XPath function, no an attribute. Otherwise it is only accessible through XPathRule, while DomXPathRule is supposed to be preferred for the XML module. /*[pmd-xml:fileEncoding() = ""] would be available in both.
There was a problem hiding this comment.
I'll update this PR and merge it. Once this is in a released version, we can update our dogfood ruleset.
ideally we would expose this through an XPath function, no an attribute. Otherwise it is only accessible through XPathRule, while DomXPathRule is supposed to be preferred
I think, that's ok for now. We can improve it, once someone needs it.
3 tasks
adangel
added a commit
that referenced
this pull request
Oct 19, 2023
adangel
added a commit
that referenced
this pull request
Oct 19, 2023
[xml] Add MissingEncoding rule #4592
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 implementation has a few constraints:
Related issues
This would allow us to remove the test from #4586 and instead add this rule to the dogfooding ruleset.
Ready?
./mvnw clean verifypasses (checked automatically by github actions)