mavenencodingpom.xmlcheckstylemaven-checkstyle-plugin

Is the 'encoding' element removed in checkstyle-maven-plugin 3.2.2?


When using checkstyle-maven-plugin 3.1.2 I was able to define an encoding element in a configuration like this:

  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <version>${maven-checkstyle-plugin.version}</version>
    <dependencies>
      <dependency>
        <groupId>com.puppycrawl.tools</groupId>
        <artifactId>checkstyle</artifactId>
        <version>${checkstyle.version}</version>
      </dependency>
    </dependencies>
    <configuration>
      <configLocation>checkstyle.xml</configLocation>
      <encoding>UTF-8</encoding>
      <consoleOutput>true</consoleOutput>
      <failsOnError>true</failsOnError>
      <failOnViolation>true</failOnViolation>
      <violationSeverity>warning</violationSeverity>
      <linkXRef>false</linkXRef>
    </configuration>
    <executions>
      <execution>
        <id>validate</id>
        <phase>validate</phase>
        <goals>
          <goal>check</goal>
        </goals>
      </execution>
    </executions>
  </plugin>

After updating to version 3.2.2 I get the hint 'Element encoding is not allowed here'. I tried to find out about in the documentation but couldn't find anything so far. Where do i have to define the encoding yet?

I tried with Maven 3.8.1 and 3.9.2 using spring-boot-starter-parent version 2.7.11, compiling to Java version 11.

I removed all other plugins, dependencies, ...and still IntelliJ complains about the element when using maven-checkstyle.plugin version 3.2.2, whilest version 3.1.2 works properly.

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
  https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

   <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.7.11</version>
    <relativePath/>
  </parent>

  <groupId>com.yyy.zzz</groupId>
  <artifactId>xxx</artifactId>
  <packaging>jar</packaging>

  <properties>
    <!-- Maven -->
    <java.version>11</java.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

    <!-- Checkstyle -->

    <!-- Plugins -->
    <maven-checkstyle-plugin.version>3.2.2</maven-checkstyle-plugin.version>
<!--    <maven-checkstyle-plugin.version>3.1.2</maven-checkstyle-plugin.version>-->
<!--    <checkstyle.version>10.3.2</checkstyle.version>-->
    <checkstyle.version>10.11.0</checkstyle.version>

  </properties>

  <dependencies>
  </dependencies>

  <build>
    <finalName>xxx</finalName>

    <resources>
      <resource>
        <directory>src/main/resources</directory>
        <filtering>false</filtering>
      </resource>
    </resources>

    <plugins>

    <plugin>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-maven-plugin</artifactId>
    </plugin>

    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-checkstyle-plugin</artifactId>
      <version>${maven-checkstyle-plugin.version}</version>
      <dependencies>
        <dependency>
          <groupId>com.puppycrawl.tools</groupId>
          <artifactId>checkstyle</artifactId>
          <version>${checkstyle.version}</version>
        </dependency>
      </dependencies>
      <configuration>
        <configLocation>checkstyle.xml</configLocation>
        <encoding>${project.build.sourceEncoding}</encoding>
        <consoleOutput>true</consoleOutput>
        <failsOnError>true</failsOnError>
        <failOnViolation>true</failOnViolation>
        <violationSeverity>warning</violationSeverity>
        <linkXRef>false</linkXRef>
      </configuration>
      <executions>
        <execution>
          <id>validate</id>
          <phase>validate</phase>
          <goals>
            <goal>check</goal>
          </goals>
        </execution>
      </executions>
    </plugin>

    </plugins>
  </build>

</project>

Afterwards I created a completely new Maven project in IntelliJ with this POM and still get the warning from IntelliJ:

  <?xml version="1.0" encoding="UTF-8"?>
  <project xmlns="http://maven.apache.org/POM/4.0.0"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>groupId</groupId>
  <artifactId>demo</artifactId>
  <version>1.0-SNAPSHOT</version>

  <properties>
      <maven.compiler.source>11</maven.compiler.source>
      <maven.compiler.target>11</maven.compiler.target>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <!-- Checkstyle -->

    <!-- Plugins -->
    <maven-checkstyle-plugin.version>3.2.2</maven-checkstyle-plugin.version>
    <!--    <maven-checkstyle-plugin.version>3.1.2</maven-checkstyle-plugin.version>-->
    <!--    <checkstyle.version>10.3.2</checkstyle.version>-->
    <checkstyle.version>10.11.0</checkstyle.version>
  </properties>

  <build>
    <plugins>

      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>${maven-checkstyle-plugin.version}</version>
        <dependencies>
          <dependency>
            <groupId>com.puppycrawl.tools</groupId>
            <artifactId>checkstyle</artifactId>
            <version>${checkstyle.version}</version>
          </dependency>
        </dependencies>
        <configuration>
          <configLocation>checkstyle.xml</configLocation>
          <encoding>${project.build.sourceEncoding}</encoding>
          <consoleOutput>true</consoleOutput>
          <failsOnError>true</failsOnError>
          <failOnViolation>true</failOnViolation>
          <violationSeverity>warning</violationSeverity>
          <linkXRef>false</linkXRef>
        </configuration>
        <executions>
          <execution>
            <id>validate</id>
            <phase>validate</phase>
            <goals>
              <goal>check</goal>
            </goals>
          </execution>
        </executions>
      </plugin>

    </plugins>
  </build>
  

Solution

  • I moved the `<dependency>` element from within the `<maven-checkstyle-plugin>` element to the `<dependencies>` element. Now IntelliJ doesn't complain the `<encoding>` element anymore.
    

    Furthermore, it seems as if encoding was divided now into <inputEncoding> and <outputEncoding>.