Skip to content

Instantly share code, notes, and snippets.

@romani
Created March 21, 2024 15:55
Show Gist options
  • Save romani/cacb61a7a2b7e4124e17423157562ea8 to your computer and use it in GitHub Desktop.
Save romani/cacb61a7a2b7e4124e17423157562ea8 to your computer and use it in GitHub Desktop.
Discord discussion
<?xml version="1.0"?>
<!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"/>
<!-- do not change severity to 'error', as that will hide errors caused by exceptions -->
<property name="severity" value="warning"/>
<!-- haltOnException is required for exception fixes and reporting of all exceptions -->
<property name="haltOnException" value="false"/>
<!-- BeforeExecutionFileFilters is required for sources of java9 -->
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$" />
</module>
<module name="TreeWalker">
<!-- Example of checkstyle Check usage -->
<!-- might be taken from https://github.com/checkstyle/checkstyle/blob/master/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/annotation/annotationlocation/Example1.java -->
<module id="default" name="AnnotationLocation"/>
<!-- example2.java , attention that I'd is added https://github.com/checkstyle/checkstyle/blob/master/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/annotation/annotationlocation/Example2.java -->
<module id="example2" name="AnnotationLocation">
<property name="allowSamelineSingleParameterlessAnnotation"
value="false"/>
<property name="allowSamelineParameterizedAnnotation" value="false"/>
<property name="allowSamelineMultipleAnnotations" value="true"/>
</module>
<!-- https://github.com/checkstyle/checkstyle/blob/master/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/annotation/annotationlocation/Example3.java -->
<module id="config3" name="AnnotationLocation">
<property name="allowSamelineMultipleAnnotations" value="false"/>
<property name="allowSamelineSingleParameterlessAnnotation"
value="false"/>
<property name="allowSamelineParameterizedAnnotation" value="true"/>
</module>
<!-- https://github.com/checkstyle/checkstyle/blob/master/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/annotation/annotationlocation/Example4.java -->
<module id="config4" name="AnnotationLocation">
<property name="tokens" value="METHOD_DEF"/>
<property name="allowSamelineMultipleAnnotations" value="false"/>
<property name="allowSamelineSingleParameterlessAnnotation"
value="true"/>
<property name="allowSamelineParameterizedAnnotation" value="false"/>
</module>
<!-- no more examples, but why to limit us ??? -->
<!-- Example of sevntu.checkstyle Check usage -->
<!-- <module name="NestedSwitchCheck"/> -->
<!-- usuppress javadoc parsing errors, as we test Check not a parser -->
<module name="SuppressionXpathSingleFilter">
<property name="message" value="Javadoc comment at column \d+ has parse error"/>
</module>
</module>
<!-- Example of filter -->
<!--
<module name="SeverityMatchFilter">
<property name="severity" value="warning"/>
<property name="acceptOnMatch" value="false"/>
</module>
-->
<!-- as we run on regression even on non-compiled files we need to skip exceptions on them -->
<module name="SuppressionSingleFilter">
<property name="message" value="Exception occurred while parsing"/>
<property name="checks" value="Checker"/>
</module>
</module>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment