[MCHECKSTYLE-342] Support XML 1.1

Open
  • Is something wrong?
#254 7 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
build-system

Research direction

The issue names no source files, tests, or entry points. Start by locating the code that reads Checkstyle result XML, then verify how it handles an XML 1.1 declaration and non-printable characters; done means XML 1.1 Checkstyle output is accepted without the reported parsing failure.

Written by the indexing model from the issue text.

Description

enhancement priority:minor

richard opened MCHECKSTYLE-342 and commented

Checkstyle wishes to upgrade our XML logger to print out XML 1.1 documents. We need this functionality to support escaping non-printable characters as XML 1.0 doesn't allow this and considers it an invalid document.

Exception in thread "main" javax.xml.stream.XMLStreamException: ParseError at [row,col]:[45615,80]
Message: An invalid XML character (Unicode: 0x2) was found in the value of attribute "message" and element is "error".

Checkstyle cannot upgrade until maven-checkstyle does as we use it in alot of regression testing. If we try to give the plugin an XML 1.1 document, it fails with the following error:

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:2.17:check (default-cli) on project postgresql: Unable to read Checkstyle results xml: /pipeline/source/pgjdbc/pgjdbc/target/checkstyle-result.xml: only 1.0 is supported as <?xml version not '1.1' (position: START_DOCUMENT seen <?xml version="1.1"... @1:19) -> [Help 1]

Affects: 2.17

0 votes, 5 watchers

Dominant language
Java
Stars
98
Forks
72
Avg merge
8h 29m
Merged PRs (30d)
12

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/maven-checkstyle-plugin

All issues in apache/maven-checkstyle-plugin

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.