[MCHECKSTYLE-273] Remove Turbine configuration since it is not used any more
I had to create a custom Checkstyle configuration for the IT MCHECKSTYLE-219-no-license_failure, because it relied on turbine_checks.xml.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk@1663881 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/it/MCHECKSTYLE-219-no-license_failure/checkstyle.xml b/src/it/MCHECKSTYLE-219-no-license_failure/checkstyle.xml
new file mode 100644
index 0000000..7ff76e3
--- /dev/null
+++ b/src/it/MCHECKSTYLE-219-no-license_failure/checkstyle.xml
@@ -0,0 +1,35 @@
+<?xml version="1.0"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<!DOCTYPE module PUBLIC
+ "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
+ "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
+
+<module name="Checker">
+
+ <!-- Checks for Headers -->
+ <!-- See http://checkstyle.sf.net/config_header.html -->
+ <module name="RegexpHeader">
+ <property name="fileExtensions" value="java"/>
+ <property name="headerFile" value="${checkstyle.header.file}"/>
+ <!-- The ignoreLines property no longer exists -->
+ </module>
+
+</module>
diff --git a/src/it/MCHECKSTYLE-219-no-license_failure/pom.xml b/src/it/MCHECKSTYLE-219-no-license_failure/pom.xml
index c62d517..fc38b6c 100644
--- a/src/it/MCHECKSTYLE-219-no-license_failure/pom.xml
+++ b/src/it/MCHECKSTYLE-219-no-license_failure/pom.xml
@@ -31,6 +31,10 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
+ <description>
+ Uses a custom Checkstyle configuration that checks for headers, so it matters if the LICENSE.txt couldn't be found.
+ </description>
+
<build>
<plugins>
<plugin>
@@ -46,7 +50,7 @@
</execution>
</executions>
<configuration>
- <configLocation>config/turbine_checks.xml</configLocation>
+ <configLocation>checkstyle.xml</configLocation>
</configuration>
</plugin>
</plugins>
diff --git a/src/it/turbine-checks/invoker.properties b/src/it/turbine-checks/invoker.properties
deleted file mode 100644
index 88f0d8f..0000000
--- a/src/it/turbine-checks/invoker.properties
+++ /dev/null
@@ -1,18 +0,0 @@
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements. See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership. The ASF licenses this file
-# to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance
-# with the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied. See the License for the
-# specific language governing permissions and limitations
-# under the License.
-
-invoker.goals=verify
diff --git a/src/it/turbine-checks/pom.xml b/src/it/turbine-checks/pom.xml
deleted file mode 100644
index 0ea12fa..0000000
--- a/src/it/turbine-checks/pom.xml
+++ /dev/null
@@ -1,59 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one
- ~ or more contributor license agreements. See the NOTICE file
- ~ distributed with this work for additional information
- ~ regarding copyright ownership. The ASF licenses this file
- ~ to you under the Apache License, Version 2.0 (the
- ~ "License"); you may not use this file except in compliance
- ~ with the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing,
- ~ software distributed under the License is distributed on an
- ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~ KIND, either express or implied. See the License for the
- ~ specific language governing permissions and limitations
- ~ under the License.
- -->
-
-<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>org.apache.maven.plugins.checkstyle</groupId>
- <artifactId>turbine-checks</artifactId>
- <version>1.0-SNAPSHOT</version>
- <packaging>jar</packaging>
-
- <url>http://maven.apache.org/</url>
-
- <properties>
- <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
- <checkstyle.violation.ignore>NewlineAtEndOfFile</checkstyle.violation.ignore>
- </properties>
-
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-checkstyle-plugin</artifactId>
- <version>@pom.version@</version>
- <configuration>
- <configLocation>config/turbine_checks.xml</configLocation>
- <headerLocation>config/maven-header.txt</headerLocation>
- </configuration>
- <executions>
- <execution>
- <id>check</id>
- <goals>
- <goal>check</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
-</project>
diff --git a/src/it/turbine-checks/src/main/java/org/MyClass.java b/src/it/turbine-checks/src/main/java/org/MyClass.java
deleted file mode 100644
index d3466c1..0000000
--- a/src/it/turbine-checks/src/main/java/org/MyClass.java
+++ /dev/null
@@ -1,27 +0,0 @@
-package org;
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-/**
- * Yada yada yada.
- */
-public class MyClass
-{
-}
diff --git a/src/it/turbine-checks/src/main/java/org/package.html b/src/it/turbine-checks/src/main/java/org/package.html
deleted file mode 100644
index c66f6f2..0000000
--- a/src/it/turbine-checks/src/main/java/org/package.html
+++ /dev/null
@@ -1,25 +0,0 @@
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-<html>
- <head>
- <title></title>
- </head>
- <body>
- </body>
-</html>
diff --git a/src/main/java/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.java b/src/main/java/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.java
index b7548b4..f13968a 100644
--- a/src/main/java/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.java
+++ b/src/main/java/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.java
@@ -102,11 +102,10 @@
* </p>
* <p/>
* <p>
- * There are 3 predefined rulesets included in Maven Checkstyle Plugin:
+ * There are 2 predefined rulesets included in Maven Checkstyle Plugin:
* </p>
* <ul>
* <li><code>config/sun_checks.xml</code>: Sun Checks.</li>
- * <li><code>config/turbine_checks.xml</code>: Turbine Checks.</li>
* <li><code>config/maven_checks.xml</code>: Maven Source Checks.</li>
* </ul>
*/
diff --git a/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java b/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java
index 4f827ed..9326f6c 100644
--- a/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java
+++ b/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java
@@ -59,7 +59,6 @@
Map<String, String> fmt2Cfg = new HashMap<String, String>();
fmt2Cfg.put( "sun", "config/sun_checks.xml" );
- fmt2Cfg.put( "turbine", "config/turbine_checks.xml" );
fmt2Cfg.put( "maven", "config/maven_checks.xml" );
FORMAT_TO_CONFIG_LOCATION = Collections.unmodifiableMap( fmt2Cfg );
@@ -67,7 +66,7 @@
/**
* Specifies what predefined check set to use. Available sets are "sun" (for
- * the Sun coding conventions), and "turbine".
+ * the Sun coding conventions), and "maven".
*
* @deprecated Use configLocation instead.
*/
diff --git a/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.java b/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.java
index 6a82e56..8b79d8b 100644
--- a/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.java
+++ b/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.java
@@ -190,12 +190,10 @@
* </p>
* <p/>
* <p>
- * There are 3 predefined rulesets.
+ * There are 2 predefined rulesets.
* </p>
- * <p/>
* <ul>
* <li><code>config/sun_checks.xml</code>: Sun Checks.</li>
- * <li><code>config/turbine_checks.xml</code>: Turbine Checks.</li>
* <li><code>config/maven_checks.xml</code>: Maven Source Checks.</li>
* </ul>
*
diff --git a/src/main/resources/config/turbine_checks.xml b/src/main/resources/config/turbine_checks.xml
deleted file mode 100644
index 630c226..0000000
--- a/src/main/resources/config/turbine_checks.xml
+++ /dev/null
@@ -1,180 +0,0 @@
-<?xml version="1.0"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-
-<!DOCTYPE module PUBLIC
- "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
- "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
-
-<!--
- Checkstyle configuration that checks the Turbine coding conventions:
- http://turbine.apache.org/common/code-standards.html
--->
-
-<module name="Checker">
-
- <!-- Checks that each Java package has a Javadoc file used for commenting. -->
- <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
- <module name="JavadocPackage">
- <property name="allowLegacy" value="true"/>
- </module>
-
- <!-- Checks whether files end with a new line. -->
- <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
- <module name="NewlineAtEndOfFile"/>
-
- <!-- Checks that property files contain the same keys. -->
- <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
- <module name="Translation"/>
-
- <module name="FileLength"/>
-
- <!-- Checks for Headers -->
- <!-- See http://checkstyle.sf.net/config_header.html -->
- <module name="RegexpHeader">
- <property name="fileExtensions" value="java"/>
- <property name="headerFile" value="${checkstyle.header.file}"/>
- <!-- The ignoreLines property no longer exists -->
- </module>
-
- <module name="FileTabCharacter">
- <property name="eachLine" value="true"/>
- </module>
-
- <module name="RegexpSingleline">
- <!-- \s matches whitespace character, $ matches end of line. -->
- <property name="format" value="\s+$"/>
- <property name="message" value="Line has trailing spaces."/>
- </module>
-
- <module name="TreeWalker">
-
- <property name="cacheFile" value="${checkstyle.cache.file}"/>
-
- <!-- ************************************************************** -->
- <!-- Checks that are different from the sun coding conventions ones -->
- <!-- ************************************************************** -->
- <property name="tabWidth" value="4"/>
- <module name="LeftCurly">
- <property name="option" value="nl"/>
- </module>
- <module name="RightCurly">
- <property name="option" value="alone"/>
- </module>
- <module name="LineLength">
- <property name="ignorePattern" value="@version"/>
- </module>
- <module name="MemberName">
- <property name="format" value="^f[A-Z][a-zA-Z0-9]*$"/>
- </module>
-
- <!-- ************************************************************** -->
- <!-- Default Sun coding conventions checks -->
- <!-- ************************************************************** -->
-
- <!-- Checks for Javadoc comments. -->
- <!-- See http://checkstyle.sf.net/config_javadoc.html -->
- <module name="JavadocMethod"/>
- <module name="JavadocType"/>
- <module name="JavadocVariable"/>
-
-
- <!-- Checks for Naming Conventions. -->
- <!-- See http://checkstyle.sf.net/config_naming.html -->
- <module name="ConstantName"/>
- <module name="LocalFinalVariableName"/>
- <module name="LocalVariableName"/>
- <module name="MethodName"/>
- <module name="PackageName"/>
- <module name="ParameterName"/>
- <module name="StaticVariableName"/>
- <module name="TypeName"/>
-
-
- <!-- Checks for imports -->
- <!-- See http://checkstyle.sf.net/config_import.html -->
- <module name="AvoidStarImport"/>
- <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
- <module name="RedundantImport"/>
- <module name="UnusedImports"/>
-
-
- <!-- Checks for Size Violations. -->
- <!-- See http://checkstyle.sf.net/config_sizes.html -->
- <module name="MethodLength"/>
- <module name="ParameterNumber"/>
-
-
- <!-- Checks for whitespace -->
- <!-- See http://checkstyle.sf.net/config_whitespace.html -->
- <module name="EmptyForIteratorPad"/>
- <module name="NoWhitespaceAfter"/>
- <module name="NoWhitespaceBefore"/>
- <module name="OperatorWrap"/>
- <module name="ParenPad"/>
- <module name="WhitespaceAfter"/>
- <module name="WhitespaceAround"/>
-
-
- <!-- Modifier Checks -->
- <!-- See http://checkstyle.sf.net/config_modifiers.html -->
- <module name="ModifierOrder"/>
- <module name="RedundantModifier"/>
-
-
- <!-- Checks for blocks. You know, those {}'s -->
- <!-- See http://checkstyle.sf.net/config_blocks.html -->
- <module name="AvoidNestedBlocks"/>
- <module name="EmptyBlock"/>
-
- <module name="NeedBraces"/>
-
-
- <!-- Checks for common coding problems -->
- <!-- See http://checkstyle.sf.net/config_coding.html -->
- <module name="AvoidInlineConditionals"/>
- <module name="EmptyStatement"/>
- <module name="EqualsHashCode"/>
- <module name="HiddenField"/>
- <module name="IllegalInstantiation"/>
- <module name="InnerAssignment"/>
- <module name="MagicNumber"/>
- <module name="MissingSwitchDefault"/>
- <module name="SimplifyBooleanExpression"/>
- <module name="SimplifyBooleanReturn"/>
-
- <!-- Checks for class design -->
- <!-- See http://checkstyle.sf.net/config_design.html -->
- <module name="DesignForExtension"/>
- <module name="FinalClass"/>
- <module name="HideUtilityClassConstructor"/>
- <module name="InterfaceIsType"/>
- <module name="VisibilityModifier"/>
-
-
- <!-- Miscellaneous other checks. -->
- <!-- See http://checkstyle.sf.net/config_misc.html -->
- <module name="ArrayTypeStyle"/>
- <module name="FinalParameters"/>
- <module name="TodoComment"/>
- <module name="UpperEll"/>
-
- </module>
-
-</module>
diff --git a/src/site/apt/config/index.apt b/src/site/apt/config/index.apt
index e75491d..6bc1a06 100644
--- a/src/site/apt/config/index.apt
+++ b/src/site/apt/config/index.apt
@@ -3,7 +3,7 @@
------
Hervé Boutemy
------
- 2015-01-18
+ 2015-03-04
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -29,14 +29,22 @@
Predefined Rulesets
- Maven Checkstyle Plugin contains these predefined rulesets:
+ Maven Checkstyle Plugin contains this predefined ruleset:
* {{{./sun_checks.html}<<<config/sun_checks.xml>>>}},
- * {{{./turbine_checks.html}<<<config/turbine_checks.xml>>>}}.
-
[]
In versions up to and including 2.13 the plugin also included the
<<<config/maven_checks.xml>>> predefined ruleset. In version 2.14 this was
- moved to {{{/shared/maven-shared-resources/}maven-shared-resources}}.
+ moved to {{{/shared/maven-shared-resources/}maven-shared-resources}}. It is
+ still available to use, because maven-shared-resources has been added as a
+ dependency to Maven Checkstyle Plugin
+
+ In versions up to and including 2.13 the plugin also included the
+ <<<config/avalon_checks.xml>>> predefined ruleset. This was removed in
+ version 2.14.
+
+ In versions up to and including 2.14 the plugin also included the
+ <<<config/turbine_checks.xml>>> predefined ruleset. This was removed in
+ version 2.15.
diff --git a/src/site/apt/config/turbine_checks.apt.vm b/src/site/apt/config/turbine_checks.apt.vm
deleted file mode 100644
index 003ff28..0000000
--- a/src/site/apt/config/turbine_checks.apt.vm
+++ /dev/null
@@ -1,35 +0,0 @@
- ------
- config/turbine_checks.xml Predefined Ruleset
- ------
- Hervé Boutemy
- ------
- 2015-01-18
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-
-<<<config/turbine_checks.xml>>> Predefined Ruleset
-
- Maven Checkstyle plugin contains <<<config/turbine_checks.xml>>> predefined ruleset for
- {{{http://turbine.apache.org/common/code-standards.html}Turbine coding conventions}}:
-
-%{snippet|file=${project.basedir}/src/main/resources/config/turbine_checks.xml}
diff --git a/src/site/apt/examples/custom-checker-config.apt.vm b/src/site/apt/examples/custom-checker-config.apt.vm
index 330b313..09397fb 100644
--- a/src/site/apt/examples/custom-checker-config.apt.vm
+++ b/src/site/apt/examples/custom-checker-config.apt.vm
@@ -1,7 +1,7 @@
------
Using a Custom Checkstyle Checker Configuration
------
- 2006-07-21
+ 2015-03-04
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -55,11 +55,9 @@
resource named <<<checkstyle.xml>>> within the compile scope of the dependencies or build extensions
classpath.
- There are 3 predefined Checkstyle configuration definitions that ship with the Checkstyle Plugin,
+ There are 2 predefined Checkstyle configuration definitions that ship with the Checkstyle Plugin,
the Sun Microsystems Definition is selected by default.
* <<config/sun_checks.xml>> - Sun Microsystems Definition (default).
* <<config/maven_checks.xml>> - Maven Development Definitions.
-
- * <<config/turbine_checks.xml>> - Turbine Development Definitions.
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index 9b42e80..90ef61d 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -3,7 +3,7 @@
------
Maria Odea Ching
------
- 2013-07-22
+ 2015-03-04
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -36,8 +36,7 @@
{{{./examples/upgrading-checkstyle.html}upgrade the version used at runtime}}.
The plugin can be configured in the project's POM. Predefined rulesets are included with the plugin, these are:
- {{{./config/sun_checks.html}<<<sun_checks.xml>>>}},
- {{{./config/turbine_checks.html}<<<turbine_checks.xml>>>}} and
+ {{{./config/sun_checks.html}<<<sun_checks.xml>>>}} and
{{{./config/maven_checks.html}<<<maven_checks.xml>>>}}. You can also use a custom ruleset by
specifying it in the plugin configuration.
