Disable maven checkstyle

Question

I want to execute a maven target but checkstyle errors forbids that. I have no time right now to correct checkstyle error (my checkstyle rules have been recently updated and I can't handle all of them right now).

Is there a way to disable checkstyle operation and execute my goal anyway ?

score 316 · Answer 1 · answered Aug 31 '15 at 09:38

316

Solution is : mvn [target] -Dcheckstyle.skip.

I like this solution as it is temporary and do not require editing of pom files, or anything that can be versioned.

answered Aug 31 '15 at 09:38

RandomCoder

6,606
6
22
28

22

mvn [target] -D"checkstyle.skip"=true (if you are using Powershell) – Pierluigi Vernetto Mar 24 '18 at 01:26
8

Even this, the maven checkstyle still executes, How can I disable it so I can speed up compile without edit pom – chaokunyang Jul 07 '20 at 11:59

score 30 · Answer 2 · answered Feb 05 '19 at 11:28

RandomCoders answer is the preferred one.

If you want to disable checkstyle from your pom, you can add the checkstyle plugin to the pom and set the skip flag to prevent the check.

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <configuration>
        <skip>true</skip>
    </configuration>
</plugin>

score 21 · Answer 3 · answered Jun 13 '19 at 12:36

21

In one line:

    <properties>
        <checkstyle.skip>true</checkstyle.skip>
    </properties>

answered Jun 13 '19 at 12:36

Constantin Konstantinidis

1,307
12
15

1

It's `` for my project. – Jack Cole Jul 31 '19 at 22:25
Can you indicate maven and plugin versions ? – Constantin Konstantinidis Aug 01 '19 at 06:46

score 10 · Answer 4 · answered Sep 14 '18 at 11:52

If you want to disable checkstyle from pom, you can add checkstyle plugin to your pom and set execution phase to none. Important thing for me was that I have to set id exactly the same as in parent pom. In othercase it doesn't works.

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <executions>
                <execution>
                    <id>checkstyle-validation</id>
                    <phase>none</phase>
                </execution>
            </executions>
        </plugin>

score 1 · Answer 5 · answered Jun 24 '21 at 12:27

The presented solutions are for the whole project/module, however I needed to have checkstyle skipped only for a certain class.
So I just want to share the solution I've found.
If you dont want to exclude the whole module and only a particular class, you can add the exclusion in the pom like following:

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <version>3.1.1</version>
            <configuration>
                <excludes>path/to/your/class/from/sources/root/myclass.java</excludes>
            </configuration>
        </plugin>

Disable maven checkstyle

5 Answers5

Linked