CODEWITHSUNDEEP
mavencheckstyle
RandomCoder
RandomCoder

Reputation: 7054

Disable maven checkstyle

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 ?

Upvotes: 141

Views: 170936

Answers (5)

Constantin Konstantinidis
Constantin Konstantinidis

Reputation: 1515

In one line:

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

Upvotes: 28

FerFig
FerFig

Reputation: 123

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>

Upvotes: 1

Sven D&#246;ring
Sven D&#246;ring

Reputation: 4388

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>

Upvotes: 32

K. Gol
K. Gol

Reputation: 1616

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>

Upvotes: 11

RandomCoder
RandomCoder

Reputation: 7054

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.

Upvotes: 330

Related Questions