This commit is contained in:
CaiXiang
212
config/checkstyle/checkstyle-noframes-severity-sorted.xsl
Normal file
212
config/checkstyle/checkstyle-noframes-severity-sorted.xsl
Normal file
@@ -0,0 +1,212 @@
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
<!--
|
||||
SPDX-FileCopyrightText: The Checkstyle Contributors (https://github.com/checkstyle/contribution/)
|
||||
SPDX-License-Identifier: LGPL-2.1-only
|
||||
-->
|
||||
<xsl:output method="html" indent="yes"/>
|
||||
<xsl:decimal-format decimal-separator="." grouping-separator="," />
|
||||
|
||||
<xsl:key name="files" match="file" use="@name" />
|
||||
|
||||
<!-- Checkstyle XML Style Sheet by Rolf Wojtech <rolf@wojtech.de> -->
|
||||
<!-- (based on checkstyle-noframe-sorted.xsl by Stephane Bailliez -->
|
||||
<!-- <sbailliez@apache.org> and sf-patch 1721291 by Leo Liang) -->
|
||||
<!-- Changes: -->
|
||||
<!-- * Outputs seperate columns for error/warning/info -->
|
||||
<!-- * Sorts primarily by #error, secondarily by #warning, tertiary by #info -->
|
||||
<!-- * Compatible with windows path names (converts '\' to '/' for html anchor) -->
|
||||
<!-- -->
|
||||
<!-- Part of the Checkstyle distribution found at https://checkstyle.org -->
|
||||
<!-- Usage (generates checkstyle_report.html): -->
|
||||
<!-- <checkstyle failonviolation="false" config="${check.config}"> -->
|
||||
<!-- <fileset dir="${src.dir}" includes="**/*.java"/> -->
|
||||
<!-- <formatter type="xml" toFile="${doc.dir}/checkstyle_report.xml"/> -->
|
||||
<!-- </checkstyle> -->
|
||||
<!-- <style basedir="${doc.dir}" destdir="${doc.dir}" -->
|
||||
<!-- includes="checkstyle_report.xml" -->
|
||||
<!-- style="${doc.dir}/checkstyle-noframes-severity-sorted.xsl"/> -->
|
||||
|
||||
<xsl:template match="checkstyle">
|
||||
<html>
|
||||
<head>
|
||||
<style type="text/css">
|
||||
.bannercell {
|
||||
border: 0px;
|
||||
padding: 0px;
|
||||
}
|
||||
body {
|
||||
margin-left: 10;
|
||||
margin-right: 10;
|
||||
font:normal 80% arial,helvetica,sanserif;
|
||||
background-color:#FFFFFF;
|
||||
color:#000000;
|
||||
}
|
||||
.a td {
|
||||
background: #efefef;
|
||||
}
|
||||
.b td {
|
||||
background: #fff;
|
||||
}
|
||||
th, td {
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
}
|
||||
th {
|
||||
font-weight:bold;
|
||||
background: #ccc;
|
||||
color: black;
|
||||
}
|
||||
table, th, td {
|
||||
font-size:100%;
|
||||
border: none
|
||||
}
|
||||
table.log tr td, tr th {
|
||||
|
||||
}
|
||||
h2 {
|
||||
font-weight:bold;
|
||||
font-size:140%;
|
||||
margin-bottom: 5;
|
||||
}
|
||||
h3 {
|
||||
font-size:100%;
|
||||
font-weight:bold;
|
||||
background: #525D76;
|
||||
color: white;
|
||||
text-decoration: none;
|
||||
padding: 5px;
|
||||
margin-right: 2px;
|
||||
margin-left: 2px;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<a name="top"></a>
|
||||
<!-- jakarta logo -->
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
||||
<tr>
|
||||
<td class="bannercell" rowspan="2">
|
||||
<!--a href="http://jakarta.apache.org/">
|
||||
<img src="http://jakarta.apache.org/images/jakarta-logo.gif" alt="http://jakarta.apache.org" align="left" border="0"/>
|
||||
</a-->
|
||||
</td>
|
||||
<td class="text-align:right"><h2>CheckStyle Audit</h2></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="text-align:right">Designed for use with <a href='https://checkstyle.org/'>CheckStyle</a> and <a href='http://jakarta.apache.org'>Ant</a>.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<hr size="1"/>
|
||||
|
||||
<!-- Summary part -->
|
||||
<xsl:apply-templates select="." mode="summary"/>
|
||||
<hr size="1" width="100%" align="left"/>
|
||||
|
||||
<!-- Package List part -->
|
||||
<xsl:apply-templates select="." mode="filelist"/>
|
||||
<hr size="1" width="100%" align="left"/>
|
||||
|
||||
<!-- For each package create its part -->
|
||||
<xsl:apply-templates select="file[@name and generate-id(.) = generate-id(key('files', @name))]" />
|
||||
|
||||
<hr size="1" width="100%" align="left"/>
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
</xsl:template>
|
||||
|
||||
|
||||
|
||||
<xsl:template match="checkstyle" mode="filelist">
|
||||
<h3>Files</h3>
|
||||
<table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Errors</th>
|
||||
<th>Warnings</th>
|
||||
<th>Infos</th>
|
||||
</tr>
|
||||
<xsl:for-each select="file[@name and generate-id(.) = generate-id(key('files', @name))]">
|
||||
|
||||
<!-- Sort method 1: Primary by #error, secondary by #warning, tertiary by #info -->
|
||||
<xsl:sort data-type="number" order="descending" select="count(key('files', @name)/error[@severity='error'])"/>
|
||||
<xsl:sort data-type="number" order="descending" select="count(key('files', @name)/error[@severity='warning'])"/>
|
||||
<xsl:sort data-type="number" order="descending" select="count(key('files', @name)/error[@severity='info'])"/>
|
||||
|
||||
<!-- Sort method 1: Sum(#error+#info+#warning) (uncomment to use, comment method 1) -->
|
||||
<!--
|
||||
<xsl:sort data-type="number" order="descending" select="count(key('files', @name)/error)"/>
|
||||
-->
|
||||
|
||||
<xsl:variable name="errorCount" select="count(key('files', @name)/error[@severity='error'])"/>
|
||||
<xsl:variable name="warningCount" select="count(key('files', @name)/error[@severity='warning'])"/>
|
||||
<xsl:variable name="infoCount" select="count(key('files', @name)/error[@severity='info'])"/>
|
||||
|
||||
<tr>
|
||||
<xsl:call-template name="alternated-row"/>
|
||||
<td><a href="#f-{translate(@name,'\','/')}"><xsl:value-of select="@name"/></a></td>
|
||||
<td><xsl:value-of select="$errorCount"/></td>
|
||||
<td><xsl:value-of select="$warningCount"/></td>
|
||||
<td><xsl:value-of select="$infoCount"/></td>
|
||||
</tr>
|
||||
</xsl:for-each>
|
||||
</table>
|
||||
</xsl:template>
|
||||
|
||||
|
||||
<xsl:template match="file">
|
||||
<a name="f-{translate(@name,'\','/')}"></a>
|
||||
<h3>File <xsl:value-of select="@name"/></h3>
|
||||
|
||||
<table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
|
||||
<tr>
|
||||
<th>Severity</th>
|
||||
<th>Error Description</th>
|
||||
<th>Line</th>
|
||||
</tr>
|
||||
<xsl:for-each select="key('files', @name)/error">
|
||||
<xsl:sort data-type="number" order="ascending" select="@line"/>
|
||||
<tr>
|
||||
<xsl:call-template name="alternated-row"/>
|
||||
<td><xsl:value-of select="@severity"/></td>
|
||||
<td><xsl:value-of select="@message"/></td>
|
||||
<td><xsl:value-of select="@line"/></td>
|
||||
</tr>
|
||||
</xsl:for-each>
|
||||
</table>
|
||||
<a href="#top">Back to top</a>
|
||||
</xsl:template>
|
||||
|
||||
|
||||
<xsl:template match="checkstyle" mode="summary">
|
||||
<h3>Summary</h3>
|
||||
<xsl:variable name="fileCount" select="count(file[@name and generate-id(.) = generate-id(key('files', @name))])"/>
|
||||
<xsl:variable name="errorCount" select="count(file/error[@severity='error'])"/>
|
||||
<xsl:variable name="warningCount" select="count(file/error[@severity='warning'])"/>
|
||||
<xsl:variable name="infoCount" select="count(file/error[@severity='info'])"/>
|
||||
<table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
|
||||
<tr>
|
||||
<th>Files</th>
|
||||
<th>Errors</th>
|
||||
<th>Warnings</th>
|
||||
<th>Infos</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<xsl:call-template name="alternated-row"/>
|
||||
<td><xsl:value-of select="$fileCount"/></td>
|
||||
<td><xsl:value-of select="$errorCount"/></td>
|
||||
<td><xsl:value-of select="$warningCount"/></td>
|
||||
<td><xsl:value-of select="$infoCount"/></td>
|
||||
</tr>
|
||||
</table>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="alternated-row">
|
||||
<xsl:attribute name="class">
|
||||
<xsl:if test="position() mod 2 = 1">a</xsl:if>
|
||||
<xsl:if test="position() mod 2 = 0">b</xsl:if>
|
||||
</xsl:attribute>
|
||||
</xsl:template>
|
||||
</xsl:stylesheet>
|
||||
332
config/checkstyle/checkstyle.xml
Normal file
332
config/checkstyle/checkstyle.xml
Normal file
@@ -0,0 +1,332 @@
|
||||
<?xml version="1.0"?>
|
||||
<!DOCTYPE module PUBLIC
|
||||
"-//Puppy Crawl//DTD Check Configuration 1.2//EN"
|
||||
"http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
|
||||
<!--
|
||||
SPDX-FileCopyrightText: The openTCS Authors
|
||||
SPDX-License-Identifier: CC0-1.0
|
||||
-->
|
||||
|
||||
<!-- See http://checkstyle.sourceforge.net/checks.html for all checks + descriptions. -->
|
||||
<module name="Checker">
|
||||
|
||||
<!-- For tests and configuration interfaces, we allow missing method JavaDoc documentation. -->
|
||||
<module name="SuppressionSingleFilter">
|
||||
<property name="checks" value="MissingJavadocMethod"/>
|
||||
<property name="files" value=".*Test.java|.*Configuration.java"/>
|
||||
</module>
|
||||
|
||||
<!-- For tests, we allow missing constructors, as we have @BeforeClass and @BeforeEach there. -->
|
||||
<module name="SuppressionSingleFilter">
|
||||
<property name="checks" value="MissingCtor"/>
|
||||
<property name="files" value=".*Test.java"/>
|
||||
</module>
|
||||
|
||||
<!-- For thirdparty packages and for package info files we allow the license header to differ. -->
|
||||
<module name="SuppressionSingleFilter">
|
||||
<property name="checks" value="Header"/>
|
||||
<property name="files" value=".*[/\\]org[/\\]opentcs[/\\]thirdparty[/\\].*|.*[/\\]package-info.java"/>
|
||||
</module>
|
||||
|
||||
<module name="SuppressWithPlainTextCommentFilter">
|
||||
<property name="offCommentFormat" value="// CHECKSTYLE:OFF.*"/>
|
||||
<property name="onCommentFormat" value="// CHECKSTYLE:ON"/>
|
||||
</module>
|
||||
|
||||
<module name="SuppressWarningsFilter"/>
|
||||
|
||||
<property name="severity" value="warning"/>
|
||||
|
||||
<property name="fileExtensions" value="java, properties"/>
|
||||
|
||||
<module name="FileLength">
|
||||
<property name="max" value="2000"/>
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="FileTabCharacter">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="LineLength">
|
||||
<property name="max" value="100"/>
|
||||
<property name="ignorePattern" value="(^(package|import) .*)|(^ *\* *[^ ]+$)|(GEN-FIRST:)"/>
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="NewlineAtEndOfFile">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<!-- Checks that property files contain the same keys. -->
|
||||
<module name="Translation">
|
||||
<property name="fileExtensions" value="properties"/>
|
||||
<property name="baseName" value="^Bundle.*$"/>
|
||||
<property name="severity" value="ignore"/>
|
||||
</module>
|
||||
|
||||
<module name="TreeWalker">
|
||||
|
||||
<module name="SuppressionCommentFilter">
|
||||
<property name="offCommentFormat" value="// CHECKSTYLE:OFF.*"/>
|
||||
<property name="onCommentFormat" value="// CHECKSTYLE:ON"/>
|
||||
</module>
|
||||
|
||||
<module name="SuppressWarningsHolder"/>
|
||||
|
||||
<module name="IllegalImport">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="UnusedImports">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="RedundantImport">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<!-- Checks for Naming Conventions. -->
|
||||
<module name="LocalVariableName">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
<module name="LocalFinalVariableName">
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
<module name="StaticVariableName">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
<module name="ConstantName">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
<module name="ParameterName">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
<module name="MemberName">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
<module name="MethodName">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
<module name="PackageName">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
<module name="TypeName">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="HiddenField">
|
||||
<property name="tokens" value="VARIABLE_DEF, LAMBDA"/>
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="NeedBraces">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="CovariantEquals">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="EmptyStatement">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="InnerAssignment">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="MissingSwitchDefault">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="DefaultComesLast">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="FallThrough">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="ModifiedControlVariable">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="SimplifyBooleanExpression">
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="SimplifyBooleanReturn">
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="StringLiteralEquality">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="NestedTryDepth">
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="PackageDeclaration">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="ParameterAssignment">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="MultipleVariableDeclarations">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="HideUtilityClassConstructor">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="MutableException">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="InnerTypeLast">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="UpperEll">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="ArrayTypeStyle">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="AvoidStarImport">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="MethodLength">
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="AnonInnerLength">
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="ParameterNumber">
|
||||
<property name="ignoreOverriddenMethods" value="true"/>
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="EqualsHashCode">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="NestedIfDepth">
|
||||
<property name="max" value="2"/>
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="DeclarationOrder">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="IllegalCatch">
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="IllegalThrows">
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="IllegalType">
|
||||
<property name="tokens" value="PARAMETER_DEF, METHOD_DEF"/>
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="VisibilityModifier">
|
||||
<property name="protectedAllowed" value="true"/>
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<!-- Checks for Javadoc comments. -->
|
||||
<module name="JavadocType">
|
||||
<property name="scope" value="package"/>
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="JavadocMethod">
|
||||
<property name="accessModifiers" value="public, protected"/>
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
<module name="JavadocMethod">
|
||||
<property name="accessModifiers" value="package"/>
|
||||
<property name="severity" value="info"/>
|
||||
</module>
|
||||
|
||||
<module name="JavadocVariable">
|
||||
<property name="scope" value="public"/>
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="JavadocStyle">
|
||||
<property name="checkEmptyJavadoc" value="true"/>
|
||||
<property name="severity" value="info"/>
|
||||
</module>
|
||||
|
||||
<module name="MissingJavadocMethod">
|
||||
<property name="scope" value="public"/>
|
||||
<property name="allowMissingPropertyJavadoc" value="true"/>
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="ModifierOrder">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="RedundantModifier">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="EmptyBlock">
|
||||
<property name="severity" value="info"/>
|
||||
</module>
|
||||
|
||||
<module name="ExplicitInitialization">
|
||||
<property name="severity" value="info"/>
|
||||
</module>
|
||||
|
||||
<module name="UnnecessaryParentheses">
|
||||
<property name="severity" value="info"/>
|
||||
</module>
|
||||
|
||||
<module name="AvoidNestedBlocks">
|
||||
<property name="severity" value="warning"/>
|
||||
</module>
|
||||
|
||||
<module name="SuperClone">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="RegexpSinglelineJava">
|
||||
<property name="format" value="\S\s+$"/>
|
||||
<property name="message" value="Line has trailing spaces."/>
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="MissingCtor">
|
||||
<property name="severity" value="error"/>
|
||||
</module>
|
||||
|
||||
<module name="TodoComment">
|
||||
<property name="format" value="TODO|XXX"/>
|
||||
<property name="severity" value="info"/>
|
||||
</module>
|
||||
|
||||
<module name="TrailingComment">
|
||||
<!-- Trailing comments are often seen in NetBeans' generated GUI code. -->
|
||||
<property name="severity" value="ignore"/>
|
||||
</module>
|
||||
|
||||
</module>
|
||||
|
||||
</module>
|
||||
Reference in New Issue
Block a user