Skip to content

Commit

Permalink
Add copyright (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
@big-andy-coates
big-andy-coates authored Feb 1, 2023
1 parent 911c63a commit ac389d6
Show file tree
Hide file tree
Showing 38 changed files with 772 additions and 165 deletions.
16 changes: 16 additions & 0 deletions build.gradle.kts
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2023 SpecMesh Contributors (https://github.com/specmesh)
*
* 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.
*/

plugins {
java
`maven-publish`
Expand Down
345 changes: 180 additions & 165 deletions config/checkstyle/checkstyle.xml
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
<?xml version="1.0"?>
<!--
~ Copyright 2023 SpecMesh Contributors (https://github.com/specmesh)
~
~ 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.
-->

<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
Expand Down Expand Up @@ -32,185 +48,184 @@
-->

<module name="Checker">
<!--
If you set the basedir property below, then all reported file
names will be relative to the specified directory. See
https://checkstyle.org/config.html#Checker
<property name="basedir" value="${basedir}"/>
-->
<property name="severity" value="error"/>
<!--
If you set the basedir property below, then all reported file
names will be relative to the specified directory. See
https://checkstyle.org/config.html#Checker
<property name="basedir" value="${basedir}"/>
-->
<property name="severity" value="error"/>

<property name="fileExtensions" value="java, properties, xml"/>

<!-- Excludes all 'module-info.java' files -->
<!-- See https://checkstyle.org/config_filefilters.html -->
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$"/>
</module>


<!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
<module name="SuppressionFilter">
<property name="file" value="${config_loc}/suppressions.xml"/>
<property name="optional" value="true"/>
</module>

<module name="SuppressWarningsFilter" />

<!-- Checks whether files end with a new line. -->
<!-- See https://checkstyle.org/config_misc.html#NewlineAtEndOfFile -->
<module name="NewlineAtEndOfFile"/>

<!-- Checks that property files contain the same keys. -->
<!-- See https://checkstyle.org/config_misc.html#Translation -->
<module name="Translation"/>

<!-- Checks for Size Violations. -->
<!-- See https://checkstyle.org/config_sizes.html -->
<module name="FileLength"/>
<module name="LineLength">
<property name="max" value="145"/>
<property name="fileExtensions" value="java"/>
</module>

<!-- Checks for whitespace -->
<!-- See https://checkstyle.org/config_whitespace.html -->
<module name="FileTabCharacter"/>

<!-- Miscellaneous other checks. -->
<!-- See https://checkstyle.org/config_misc.html -->
<module name="RegexpSingleline">
<property name="format" value="\s+$"/>
<property name="minimum" value="0"/>
<property name="maximum" value="0"/>
<property name="message" value="Line has trailing spaces."/>
</module>

<!-- Checks for Headers -->
<!-- See https://checkstyle.org/config_header.html init:remove -->
<module name="RegexpHeader"> <!-- init:remove -->
<property name="header" value="/\*\n\* Copyright (\d\d\d\d-)?2023 SpecMesh Contributors \(https://github.com/specmesh\)$\n \*$\n \* Licensed under the Apache License, Version 2.0"/> <!-- init:remove -->
</module> <!-- init:remove -->

<module name="TreeWalker">

<!-- Generic 'turn all checkstyle off' comment filter -->
<!-- Specific 'turn list of checkstyle rules off' comment filter -->
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="CHECKSTYLE_RULES.OFF:\s+([\w\|]+)"/>
<property name="onCommentFormat" value="CHECKSTYLE_RULES.ON:\s+([\w\|]+)"/>
<property name="checkFormat" value="$1"/>
</module>

<property name="fileExtensions" value="java, properties, xml"/>
<module name="SuppressWarningsHolder" />

<!-- Checks for Naming Conventions. -->
<!-- See https://checkstyle.org/config_naming.html -->
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="PackageName"/>
<module name="ParameterName"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>

<!-- Checks for imports -->
<!-- See https://checkstyle.org/config_imports.html -->
<module name="AvoidStarImport"/>
<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
<module name="RedundantImport"/>
<module name="UnusedImports">
<property name="processJavadoc" value="false"/>
</module>

<!-- Excludes all 'module-info.java' files -->
<!-- See https://checkstyle.org/config_filefilters.html -->
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$"/>
<!-- Checks for Size Violations. -->
<!-- See https://checkstyle.org/config_sizes.html -->
<module name="MethodLength"/>
<module name="ParameterNumber"/>

<!-- Modifier Checks -->
<!-- See https://checkstyle.org/config_modifiers.html -->
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>

<!-- Checks for blocks. You know, those {}'s -->
<!-- See https://checkstyle.org/config_blocks.html -->
<module name="AvoidNestedBlocks"/>
<module name="EmptyBlock"/>
<module name="LeftCurly"/>
<module name="NeedBraces"/>
<module name="RightCurly"/>

<!-- Checks for common coding problems -->
<!-- See https://checkstyle.org/config_coding.html -->
<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
<module name="IllegalInstantiation"/>
<module name="InnerAssignment"/>
<module name="MissingSwitchDefault"/>
<module name="MultipleVariableDeclarations"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>

<!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
<module name="SuppressionXpathFilter">
<property name="file" value="${org.checkstyle.sun.suppressionxpathfilter.config}"
default="checkstyle-xpath-suppressions.xml" />
<property name="optional" value="true"/>
</module>

<module name="BooleanExpressionComplexity"/>
<module name="CyclomaticComplexity"/>
<module name="JavaNCSS" />
<module name="NPathComplexity"/>

<!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
<module name="SuppressionFilter">
<property name="file" value="${config_loc}/suppressions.xml"/>
<property name="optional" value="true"/>
<module name="FinalParameters">
<property name="severity"
value="${checkstyle.finalparameters.severity}"
default="error"/>
</module>

<module name="SuppressWarningsFilter" />
<module name="FinalLocalVariable">
<property name="severity"
value="${checkstyle.finallocalvariable.severity}"
default="error"/>
</module>

<!-- Checks whether files end with a new line. -->
<!-- See https://checkstyle.org/config_misc.html#NewlineAtEndOfFile -->
<module name="NewlineAtEndOfFile"/>
<module name="FinalClass">
<property name="severity"
value="${checkstyle.finalclass.severity}"
default="error"/>
</module>

<!-- Checks that property files contain the same keys. -->
<!-- See https://checkstyle.org/config_misc.html#Translation -->
<module name="Translation"/>
<module name="TodoComment">
<property name="format"
value="${checkstyle.todocomment.format}"
default="(TODO)|(FIXME)"/>
<property name="severity"
value="${checkstyle.todocomment.severity}"
default="error"/>
</module>

<!-- Checks for Size Violations. -->
<!-- See https://checkstyle.org/config_sizes.html -->
<module name="FileLength"/>
<module name="LineLength">
<property name="max" value="145"/>
<property name="fileExtensions" value="java"/>
<module name="HideUtilityClassConstructor">
<property name="severity"
value="${checkstyle.hideutilityclassconstructor.severity}"
default="error"/>
</module>

<!-- Checks for whitespace -->
<!-- See https://checkstyle.org/config_whitespace.html -->
<module name="FileTabCharacter"/>

<!-- Miscellaneous other checks. -->
<!-- See https://checkstyle.org/config_misc.html -->
<module name="RegexpSingleline">
<property name="format" value="\s+$"/>
<property name="minimum" value="0"/>
<property name="maximum" value="0"/>
<property name="message" value="Line has trailing spaces."/>
<module name="RedundantModifier">
<property name="severity"
value="${checkstyle.redundantmodifier.severity}"
default="error"/>
</module>

<!-- Checks for Headers -->
<!-- See https://checkstyle.org/config_header.html -->
<!-- <module name="Header"> -->
<!-- <property name="headerFile" value="${checkstyle.header.file}"/> -->
<!-- <property name="fileExtensions" value="java"/> -->
<!-- </module> -->

<module name="TreeWalker">

<!-- Generic 'turn all checkstyle off' comment filter -->
<!-- Specific 'turn list of checkstyle rules off' comment filter -->
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="CHECKSTYLE_RULES.OFF:\s+([\w\|]+)"/>
<property name="onCommentFormat" value="CHECKSTYLE_RULES.ON:\s+([\w\|]+)"/>
<property name="checkFormat" value="$1"/>
</module>

<module name="SuppressWarningsHolder" />

<!-- Checks for Naming Conventions. -->
<!-- See https://checkstyle.org/config_naming.html -->
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="PackageName"/>
<module name="ParameterName"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>

<!-- Checks for imports -->
<!-- See https://checkstyle.org/config_imports.html -->
<module name="AvoidStarImport"/>
<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
<module name="RedundantImport"/>
<module name="UnusedImports">
<property name="processJavadoc" value="false"/>
</module>

<!-- Checks for Size Violations. -->
<!-- See https://checkstyle.org/config_sizes.html -->
<module name="MethodLength"/>
<module name="ParameterNumber"/>

<!-- Modifier Checks -->
<!-- See https://checkstyle.org/config_modifiers.html -->
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>

<!-- Checks for blocks. You know, those {}'s -->
<!-- See https://checkstyle.org/config_blocks.html -->
<module name="AvoidNestedBlocks"/>
<module name="EmptyBlock"/>
<module name="LeftCurly"/>
<module name="NeedBraces"/>
<module name="RightCurly"/>

<!-- Checks for common coding problems -->
<!-- See https://checkstyle.org/config_coding.html -->
<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
<module name="IllegalInstantiation"/>
<module name="InnerAssignment"/>
<module name="MissingSwitchDefault"/>
<module name="MultipleVariableDeclarations"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>

<!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
<module name="SuppressionXpathFilter">
<property name="file" value="${org.checkstyle.sun.suppressionxpathfilter.config}"
default="checkstyle-xpath-suppressions.xml" />
<property name="optional" value="true"/>
</module>

<module name="BooleanExpressionComplexity"/>
<module name="CyclomaticComplexity"/>
<module name="JavaNCSS" />
<module name="NPathComplexity"/>

<module name="FinalParameters">
<property name="severity"
value="${checkstyle.finalparameters.severity}"
default="error"/>
</module>

<module name="FinalLocalVariable">
<property name="severity"
value="${checkstyle.finallocalvariable.severity}"
default="error"/>
</module>

<module name="FinalClass">
<property name="severity"
value="${checkstyle.finalclass.severity}"
default="error"/>
</module>

<module name="TodoComment">
<property name="format"
value="${checkstyle.todocomment.format}"
default="(TODO)|(FIXME)"/>
<property name="severity"
value="${checkstyle.todocomment.severity}"
default="error"/>
</module>

<module name="HideUtilityClassConstructor">
<property name="severity"
value="${checkstyle.hideutilityclassconstructor.severity}"
default="error"/>
</module>

<module name="RedundantModifier">
<property name="severity"
value="${checkstyle.redundantmodifier.severity}"
default="error"/>
</module>

<module name="RedundantImport">
<property name="severity"
value="${checkstyle.redundantimport.severity}"
default="error"/>
</module>
<module name="RedundantImport">
<property name="severity"
value="${checkstyle.redundantimport.severity}"
default="error"/>
</module>
</module>

</module>
Loading

0 comments on commit ac389d6

Please sign in to comment.