From: Joakim Erdfelt <joakime@apache.org>
Date: Fri, 14 Mar 2008 05:41:37 +0000 (+0000)
Subject: Adding initial archiva-build-resources module to hold checkstyle / pmd / etc.. rules
X-Git-Tag: archiva-r676265~310
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=4c114bee2f604d40bbd68d5857d7f1524f834e97;p=archiva.git

Adding initial archiva-build-resources module to hold checkstyle / pmd / etc.. rules

git-svn-id: https://svn.apache.org/repos/asf/maven/archiva/trunk@636998 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/archiva-build-resources/pom.xml b/archiva-build-resources/pom.xml
new file mode 100644
index 000000000..6dd4639b5
--- /dev/null
+++ b/archiva-build-resources/pom.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright 2005-2006 The Apache Software Foundation.
+  ~
+  ~ Licensed 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/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>org.apache.maven</groupId>
+    <artifactId>maven-parent</artifactId>
+    <version>5</version>
+  </parent>
+
+  <artifactId>archiva-build-resources</artifactId>
+  <version>1-SNAPSHOT</version>
+  <name>Archiva Build Resources</name>
+  <packaging>jar</packaging>
+
+</project>
diff --git a/archiva-build-resources/src/main/resources/checkstyle.xml b/archiva-build-resources/src/main/resources/checkstyle.xml
new file mode 100644
index 000000000..538ba578d
--- /dev/null
+++ b/archiva-build-resources/src/main/resources/checkstyle.xml
@@ -0,0 +1,282 @@
+<?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 maven coding conventions from:
+-->
+
+<module name="Checker">
+
+    <!-- Checks that a package.html file exists for each package.     -->
+    <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->
+    <!-- module name="PackageHtml"/ -->
+
+    <!-- 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="TreeWalker">
+
+        <property name="cacheFile" value="${checkstyle.cache.file}"/>
+
+        <property name="tabWidth" value="4"/>
+
+        <module name="LeftCurly">
+          <property name="option" value="nl"/>
+          <property name="severity" value="warning"/>
+        </module>
+
+        <module name="RightCurly">
+          <property name="option" value="alone"/>
+          <property name="severity" value="warning"/>
+        </module>
+
+        <module name="LineLength">
+          <property name="max" value="120" />
+          <property name="ignorePattern" value="@version|@see|@todo|TODO"/>
+          <property name="severity" value="warning"/>
+        </module>
+
+        <module name="MemberName" >
+          <property name="severity" value="warning"/>
+        </module>
+
+        <!-- Checks for Javadoc comments.                     -->
+        <!-- See http://checkstyle.sf.net/config_javadoc.html -->
+        <module name="JavadocMethod">
+          <property name="severity" value="info"/>
+        </module>
+        <module name="JavadocType">
+          <property name="severity" value="info"/>
+        </module>
+        <module name="JavadocVariable">
+          <property name="severity" value="info"/>
+        </module>
+
+
+        <!-- Checks for Naming Conventions.                  -->
+        <!-- See http://checkstyle.sf.net/config_naming.html -->
+        <module name="ConstantName">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="LocalFinalVariableName">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="LocalVariableName">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="MethodName">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="PackageName">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="ParameterName">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="StaticVariableName">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="TypeName">
+          <property name="severity" value="warning"/>
+        </module>
+
+
+        <!-- Checks for Headers                              -->
+        <!-- See http://checkstyle.sf.net/config_header.html -->
+        <module name="RegexpHeader">
+          <property name="headerFile" value="${checkstyle.header.file}"/>
+          <property name="severity" value="error"/>
+        </module>
+
+        <!-- Checks for imports                              -->
+        <!-- See http://checkstyle.sf.net/config_import.html -->
+        <module name="AvoidStarImport">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="IllegalImport">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="RedundantImport">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="UnusedImports">
+          <property name="severity" value="warning"/>
+        </module>
+
+
+        <!-- Checks for Size Violations.                    -->
+        <!-- See http://checkstyle.sf.net/config_sizes.html -->
+        <module name="FileLength">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="MethodLength">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="ParameterNumber">
+          <property name="severity" value="warning"/>
+        </module>
+
+
+        <!-- Checks for whitespace                               -->
+        <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+        <module name="EmptyForIteratorPad">
+          <property name="option" value="space"/>
+          <property name="severity" value="warning"/>
+        </module>
+        <!-- module name="NoWhitespaceAfter"/ -->
+        <!-- module name="NoWhitespaceBefore"/ -->
+        <module name="OperatorWrap">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="ParenPad">
+          <property name="option" value="space" />
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="TabCharacter">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="WhitespaceAfter">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="WhitespaceAround">
+          <property name="severity" value="warning"/>
+        </module>
+        <!-- module name="MethodParamPad"/ -->
+
+
+        <!-- Modifier Checks                                    -->
+        <!-- See http://checkstyle.sf.net/config_modifiers.html -->
+        <module name="ModifierOrder">
+          <property name="severity" value="warning"/>
+        </module>
+        <!-- <module name="RedundantModifier">
+          <property name="severity" value="warning"/>
+        </module> -->
+
+
+        <!-- Checks for blocks. You know, those {}'s         -->
+        <!-- See http://checkstyle.sf.net/config_blocks.html -->
+        <module name="AvoidNestedBlocks">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="EmptyBlock">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="NeedBraces">
+          <property name="severity" value="warning"/>
+        </module>
+
+
+        <!-- Checks for common coding problems               -->
+        <!-- See http://checkstyle.sf.net/config_coding.html -->
+        <!-- module name="AvoidInlineConditionals"/ -->
+        <module name="DoubleCheckedLocking">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="EmptyStatement">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="EqualsHashCode">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="HiddenField">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="IllegalInstantiation">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="InnerAssignment">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="MagicNumber">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="MissingSwitchDefault">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="RedundantThrows">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="SimplifyBooleanExpression">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="SimplifyBooleanReturn">
+          <property name="severity" value="warning"/>
+        </module>
+
+        <!-- Checks for class design                         -->
+        <!-- See http://checkstyle.sf.net/config_design.html -->
+        <!-- module name="DesignForExtension"/ -->
+        <!-- module name="FinalClass"/ -->
+        <!-- module name="HideUtilityClassConstructor"/ -->
+        <module name="InterfaceIsType">
+          <property name="severity" value="warning"/>
+        </module>
+        <module name="VisibilityModifier">
+          <property name="severity" value="warning"/>
+        </module>
+
+
+        <!-- Miscellaneous other checks.                   -->
+        <!-- See http://checkstyle.sf.net/config_misc.html -->
+        <!-- module name="ArrayTypeStyle"/ -->
+        <!-- module name="FinalParameters"/ -->
+        <!-- Line with Trailing Spaces (disabled as it's to noisy)
+        <module name="GenericIllegalRegexp">
+            <property name="format" value="\s+$"/>
+            <property name="message" value="Line has trailing spaces."/>
+        </module>
+          -->
+        <!-- Let todo plugin handle this.
+        <module name="TodoComment"/>
+          -->
+        <module name="UpperEll">
+          <property name="severity" value="warning"/>
+        </module>
+
+        <!-- Old Habits Die Hard -->
+        <module name="GenericIllegalRegexp">
+          <property name="format" value="org.codehaus.plexus.util.StringUtil" />
+          <property name="message" value="[MRM-710] Use commons-lang and StringUtils instead." />
+          <property name="severity" value="error"/>
+        </module>
+        <module name="GenericIllegalRegexp">
+          <property name="format" value="org.codehaus.plexus.util.FileUtil" />
+          <property name="message" value="[MRM-709] Use commons-io and FileUtils instead." />
+          <property name="severity" value="error"/>
+        </module>
+        <module name="GenericIllegalRegexp">
+          <property name="format" value="org.codehaus.plexus.util.IOUtil" />
+          <property name="message" value="[MRM-709] Use commons-io and IOUtils instead." />
+          <property name="severity" value="error"/>
+        </module>
+
+    </module>
+
+</module>
diff --git a/archiva-build-resources/src/main/resources/header.txt b/archiva-build-resources/src/main/resources/header.txt
new file mode 100644
index 000000000..5059f0022
--- /dev/null
+++ b/archiva-build-resources/src/main/resources/header.txt
@@ -0,0 +1,21 @@
+^package 
+^\s*$
+^/\*\s*$
+^ \* Licensed to the Apache Software Foundation \(ASF\) under one\s*$
+^ \* or more contributor license agreements.  See the NOTICE file\s*$
+^ \* distributed with this work for additional information\s*$
+^ \* regarding copyright ownership.  The ASF licenses this file\s*$
+^ \* to you under the Apache License, Version 2.0 \(the\s*$
+^ \* "License"\)\; you may not use this file except in compliance\s*$
+^ \* with the License.  You may obtain a copy of the License at\s*$
+^ \*\s*$
+^ \* \s*http://www\.apache\.org/licenses/LICENSE-2\.0\s*$
+^ \*\s*$
+^ \* Unless required by applicable law or agreed to in writing,\s*$
+^ \* software distributed under the License is distributed on an\s*$
+^ \* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\s*$
+^ \* KIND, either express or implied.  See the License for the\s*$
+^ \* specific language governing permissions and limitations\s*$
+^ \* under the License.\s*$
+^ \*/\s*$
+^\s*$