This is an automated email from the ASF dual-hosted git repository.
exceptionfactory pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi-maven.git
The following commit(s) were added to refs/heads/main by this push:
new cb896fc NIFI-10905 Update checkstyle to v9.3
cb896fc is described below
commit cb896fc6b142d57280185610e7e7703ea2a71eba
Author: Kevin Doran <[email protected]>
AuthorDate: Tue Nov 29 16:01:04 2022 -0500
NIFI-10905 Update checkstyle to v9.3
- Also update checkstyle plugin version
- Also externalize checkstyle rules from pom file to standalone xml
This closes #24
Signed-off-by: David Handermann <[email protected]>
---
checkstyle.xml | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
pom.xml | 81 +++----------------------------------------------------
2 files changed, 88 insertions(+), 78 deletions(-)
diff --git a/checkstyle.xml b/checkstyle.xml
new file mode 100644
index 0000000..193a4df
--- /dev/null
+++ b/checkstyle.xml
@@ -0,0 +1,85 @@
+<?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
+ "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+ "https://checkstyle.org/dtds/configuration_1_3.dtd";>
+<module name="Checker">
+ <property name="charset" value="UTF-8"/>
+ <property name="severity" value="warning"/>
+ <!-- Checks for whitespace -->
+ <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+ <module name="FileTabCharacter">
+ <property name="eachLine" value="true"/>
+ </module>
+ <module name="LineLength">
+ <!-- needs extra, because Eclipse formatter
+ ignores the ending left brace -->
+ <property name="max" value="200"/>
+ <property name="ignorePattern" value="^package.*|^import.*|a
href|href|http://|https://|ftp://"/>
+ </module>
+ <module name="TreeWalker">
+ <module name="RegexpSinglelineJava">
+ <property name="format" value="\s+$"/>
+ <property name="message" value="Line has trailing whitespace."/>
+ </module>
+ <module name="RegexpSinglelineJava">
+ <property name="format" value="[@]see\s+[{][@]link"/>
+ <property name="message" value="Javadoc @see does not need @link:
pick one or the other."/>
+ </module>
+ <module name="OuterTypeFilename"/>
+ <module name="AvoidStarImport"/>
+ <module name="UnusedImports">
+ <property name="processJavadoc" value="true"/>
+ </module>
+ <module name="NoLineWrap"/>
+ <module name="LeftCurly"/>
+ <module name="RightCurly"/>
+ <module name="RightCurly">
+ <property name="option" value="alone_or_singleline"/>
+ <property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF,
LITERAL_FOR, LITERAL_WHILE, STATIC_INIT"/>
+ </module>
+ <module name="SeparatorWrap">
+ <property name="tokens" value="DOT"/>
+ <property name="option" value="nl"/>
+ </module>
+ <module name="SeparatorWrap">
+ <property name="tokens" value="COMMA"/>
+ <property name="option" value="EOL"/>
+ </module>
+ <module name="PackageName">
+ <property name="format" value="^[a-z]+(\.[a-z][a-zA-Z0-9]*)*$"/>
+ </module>
+ <module name="MethodTypeParameterName">
+ <property name="format"
value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
+ </module>
+ <module name="MethodParamPad"/>
+ <module name="OperatorWrap">
+ <property name="option" value="NL"/>
+ <property name="tokens"
+ value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND,
LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, QUESTION, SL, SR, STAR
"/>
+ </module>
+ <module name="AnnotationLocation">
+ <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
METHOD_DEF, CTOR_DEF"/>
+ </module>
+ <module name="AnnotationLocation">
+ <property name="tokens" value="VARIABLE_DEF"/>
+ <property name="allowSamelineMultipleAnnotations" value="true"/>
+ </module>
+ <module name="NonEmptyAtclauseDescription"/>
+ <module name="JavadocMethod">
+ <property name="allowMissingParamTags" value="true"/>
+ <property name="allowMissingReturnTag" value="true"/>
+ <property name="allowedAnnotations"
value="Override,Test,BeforeClass,AfterClass,Before,After"/>
+ </module>
+ <module name="SingleLineJavadoc"/>
+ </module>
+</module>
diff --git a/pom.xml b/pom.xml
index d849197..90b1d6c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -167,12 +167,12 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.15</version>
+ <version>3.2.0</version>
<dependencies>
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
- <version>6.5</version>
+ <version>9.3</version>
</dependency>
</dependencies>
</plugin>
@@ -219,82 +219,7 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<configuration>
- <checkstyleRules>
- <module name="Checker">
- <property name="charset" value="UTF-8" />
- <property name="severity" value="warning" />
- <!-- Checks for whitespace
-->
- <!-- See
http://checkstyle.sf.net/config_whitespace.html -->
- <module name="FileTabCharacter">
- <property name="eachLine" value="true" />
- </module>
- <module name="TreeWalker">
- <module name="RegexpSinglelineJava">
- <property name="format" value="\s+$" />
- <property name="message" value="Line has
trailing whitespace." />
- </module>
- <module name="RegexpSinglelineJava">
- <property name="format"
value="[@]see\s+[{][@]link" />
- <property name="message" value="Javadoc
@see does not need @link: pick one or the other." />
- </module>
- <module name="OuterTypeFilename" />
- <module name="LineLength">
- <!-- needs extra, because Eclipse
formatter ignores the ending left brace -->
- <property name="max" value="200" />
- <property name="ignorePattern"
value="^package.*|^import.*|a href|href|http://|https://|ftp://"; />
- </module>
- <module name="AvoidStarImport" />
- <module name="UnusedImports">
- <property name="processJavadoc"
value="true" />
- </module>
- <module name="NoLineWrap" />
- <module name="LeftCurly">
- <property name="maxLineLength" value="160"
/>
- </module>
- <module name="RightCurly" />
- <module name="RightCurly">
- <property name="option" value="alone" />
- <property name="tokens" value="CLASS_DEF,
METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT,
INSTANCE_INIT" />
- </module>
- <module name="SeparatorWrap">
- <property name="tokens" value="DOT" />
- <property name="option" value="nl" />
- </module>
- <module name="SeparatorWrap">
- <property name="tokens" value="COMMA" />
- <property name="option" value="EOL" />
- </module>
- <module name="PackageName">
- <property name="format"
value="^[a-z]+(\.[a-z][a-zA-Z0-9]*)*$" />
- </module>
- <module name="MethodTypeParameterName">
- <property name="format"
value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
- </module>
- <module name="MethodParamPad" />
- <module name="OperatorWrap">
- <property name="option" value="NL" />
- <property name="tokens" value="BAND, BOR,
BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS,
MOD, NOT_EQUAL, QUESTION, SL, SR, STAR " />
- </module>
- <module name="AnnotationLocation">
- <property name="tokens" value="CLASS_DEF,
INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF" />
- </module>
- <module name="AnnotationLocation">
- <property name="tokens"
value="VARIABLE_DEF" />
- <property
name="allowSamelineMultipleAnnotations" value="true" />
- </module>
- <module name="NonEmptyAtclauseDescription" />
- <module name="JavadocMethod">
- <property name="allowMissingJavadoc"
value="true" />
- <property name="allowMissingParamTags"
value="true" />
- <property name="allowMissingThrowsTags"
value="true" />
- <property name="allowMissingReturnTag"
value="true" />
- <property name="allowedAnnotations"
value="Override,Test,BeforeClass,AfterClass,Before,After" />
- <property
name="allowThrowsTagsForSubclasses" value="true" />
- </module>
- <module name="SingleLineJavadoc" />
- </module>
- </module>
- </checkstyleRules>
+ <configLocation>checkstyle.xml</configLocation>
<violationSeverity>warning</violationSeverity>
<includeTestSourceDirectory>true</includeTestSourceDirectory>
<excludes>**/HelpMojo.java</excludes>
