2012-02-02 16 views
5

私はMavenとcheckstyleを初めて使っていますので、丁寧に教えてください:)。checkstyleを使用してMavenビルドを停止する方法

私はcheckstyleプラグインでmavenを使用することができ、自分のコードでレポートを作成できます。しかし、私が本当にしたいのは、スタイルチェックにエラーがある場合、私はmavenのビルドプロセスを止めることができるということです。

これまでのところ、私のpom.xmlは、以下のようになります。

<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> 

私はここに私の目標を達成するにはどうすればよいですか?私たちのチームは、厳格なコーディングスタイルの標準を持ちたいので、私はそれを使用しなければなりません。

答えて

5

あなたが望むものを達成するために、あなたは、レポートのライフサイクルに加えて、ビルドのライフサイクルでのmaven-のCheckstyle-プラグインを使用する必要があります。

<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> 
+0

thnx man、xmlファイルに書き込むのではなく、結果をコマンドラインに出力する方法はありますか? – LostMohican

+1

@LostMohican:はい、コンソール出力を有効にするには、設定セクションに ' true'を追加できます。その他のオプションについては、こちらをご覧ください:http://maven.apache.org/plugins/maven-checkstyle-plugin/check-mojo.html –

3

failsOnError propertyなどを設定してみてください。

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

私は以来、いくつかの時間があったことを実現この質問は尋ねられましたが、上記の回答のどれも私のためにこれを解決しませんでした。

ビルドは違反で失敗するためには、私は次のようにconfigurationブロックにwarningにデフォルトerrorからviolationSeverity値を変更する必要がありました:

また
<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> 

、我々が確立していることに注意してください。ほとんどの場合、最新のgoogle_checks.xmlに基づいて、若干修正されたスタイルのスタイル(checkstyle.xmlで定義)。しかし、これを有効にするには、com.puppycrawl.tools.checkstyleの依存関係も更新する必要がありました。

関連する問題