jak zatrzymać budowanie maven za pomocą checkstyle

Question

Jestem nowy dla maven i checkstyle więc proszę bądź uprzejmy :).

Udało mi się użyć maven z wtyczką checkstyle i mogę tworzyć raporty na temat mojego kodu. Ale naprawdę chcę mieć to, że mogę zatrzymać proces budowania maven, jeśli są jakieś błędy w sprawdzaniu stylu.

Dotychczas moja pom.xml wygląda jak poniżej:

<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/maven-v4_0_0.xsd"> 
    <modelVersion>4.0.0</modelVersion> 
    <groupId>com.company.app</groupId> 
    <artifactId>my-app</artifactId> 
    <packaging>jar</packaging> 
    <version>1.0-SNAPSHOT</version> 
    <name>my-app</name> 
    <url>http://maven.apache.org</url> 
    <dependencies> 
    <dependency> 
     <groupId>junit</groupId> 
     <artifactId>junit</artifactId> 
     <version>3.8.1</version> 
     <scope>test</scope> 
    </dependency> 
    <dependency> 
     <groupId>log4j</groupId> 
     <artifactId>log4j</artifactId> 
     <version>1.2.12</version> 
     <scope>compile</scope> 
    </dependency> 
    </dependencies> 
    <reporting> 
    <plugins> 
     <plugin> 
     <groupId>org.apache.maven.plugins</groupId> 
     <artifactId>maven-checkstyle-plugin</artifactId> 
     <version>2.8</version> 
     </plugin> 
    </plugins> 
    </reporting> 
</project> 

Jak mogę osiągnąć mój cel tutaj? Nasz zespół chce mieć ścisłe standardy stylu kodowania, więc muszę go używać.

Answer 1

Aby osiągnąć to, co chcesz, musisz użyć maven-Checkstyle-plugin w kompilacji cyklu oprócz cyklu sprawozdawczego:

<project> 
... 
<build> 
... 
<plugins> 
    <plugin> 
    <groupId>org.apache.maven.plugins</groupId> 
    <artifactId>maven-checkstyle-plugin</artifactId> 
    <version>2.8</version> 
    <executions> 
     <execution> 
     <phase>process-sources</phase> 
     <goals> 
      <goal>check</goal> 
     </goals> 
     </execution> 
    </executions> 
    <configuration> 
     <failsOnError>true</failsOnError> 
    </configuration> 
    </plugin> 
</plugins> 
</build> 
</project> 

Answer 2

Możesz spróbować ustawić failsOnError property np.

<plugin> 
    <groupId>org.apache.maven.plugins</groupId> 
    <artifactId>maven-checkstyle-plugin</artifactId> 
    <version>2.8</version> 
    <configuration> 
    <failsOnError>true</failsOnError> 
    </configuration> 
    </plugin> 

Answer 3

Zdaję sobie sprawę, że nastąpił jakiś czas od zadawano to pytanie, ale żadna z powyższych odpowiedzi nie rozwiązała tego problemu.

W porządku na budowie do fail na łamanie, musiałem zmienić wartość violationSeverity z domyślnej error do warning w bloku configuration, podobny do:

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

Należy również pamiętać, że mamy siedzibę nieznacznie zmodyfikowana wersja stylów (zdefiniowana w checkstyle.xml), w większości oparta na najnowszym google_checks.xml. Aby jednak to zadziałało, zależność com.puppycrawl.tools.checkstyle również musiała zostać zaktualizowana.