From 35e07bf52e9bf8732cf4bf946e63719bfb7e2d05 Mon Sep 17 00:00:00 2001
From: Anatoly Karlov <a.karlov@rbkmoney.com>
Date: Thu, 11 Mar 2021 19:33:12 +0700
Subject: [PATCH] add @SuppressWarnings and checkstyle-suppressions.xml
 opportunity (#13)

update README
---
 README.md                           | 86 ++++++++++++++++++++++-------
 conf/checkstyle-suppressions.xml    | 12 ++++
 conf/rbkmoney_google_checkstyle.xml |  2 +
 3 files changed, 80 insertions(+), 20 deletions(-)
 create mode 100644 conf/checkstyle-suppressions.xml

diff --git a/README.md b/README.md
index 02a3f17..c1dc212 100644
--- a/README.md
+++ b/README.md
@@ -2,27 +2,73 @@
 Our check style config based on Google style
 
 Usage example:
+
 ```xml
 <plugin>
-    <groupId>org.apache.maven.plugins</groupId>
-    <artifactId>maven-checkstyle-plugin</artifactId>
-    <version>3.1.1</version>
-    <executions>
-        <execution>
-            <id>validate</id>
-            <phase>validate</phase>
-            <configuration>
-                <configLocation>https://raw.githubusercontent.com/rbkmoney/java-checkstyle-config/master/conf/rbkmoney_google_checkstyle.xml</configLocation>
-                <encoding>UTF-8</encoding>
-                <failsOnError>true</failsOnError>
-                <consoleOutput>true</consoleOutput>
-                <violationSeverity>warning</violationSeverity>
-                <includeTestSourceDirectory>true</includeTestSourceDirectory>
-            </configuration>
-            <goals>
-                <goal>check</goal>
-            </goals>
-        </execution>
-    </executions>
+  <groupId>org.apache.maven.plugins</groupId>
+  <artifactId>maven-checkstyle-plugin</artifactId>
+  <version>3.1.2</version>
+  <dependencies>
+    <dependency>
+      <groupId>com.puppycrawl.tools</groupId>
+      <artifactId>checkstyle</artifactId>
+      <version>8.41</version>
+    </dependency>
+  </dependencies>
+  <executions>
+    <execution>
+      <id>validate</id>
+      <phase>validate</phase>
+      <configuration>
+        <configLocation>${checkstyle.config.path}</configLocation>
+        <encoding>UTF-8</encoding>
+        <failsOnError>true</failsOnError>
+        <consoleOutput>true</consoleOutput>
+        <violationSeverity>warning</violationSeverity>
+        <includeTestSourceDirectory>true</includeTestSourceDirectory>
+        <suppressionsLocation>${checkstyle.config.suppressions.path}</suppressionsLocation>
+      </configuration>
+      <goals>
+        <goal>check</goal>
+      </goals>
+    </execution>
+  </executions>
 </plugin>
 ```
+
+### SuppressWarnings examples
+
+First path — override `${checkstyle.config.suppressions.path}` in project with `checkstyle-suppressions.xml` file and fill with your filters
+
+pom.xml:
+```xml
+<properties>
+    <checkstyle.config.suppressions.path>checkstyle-suppressions.xml</checkstyle.config.suppressions.path>
+</properties>
+```
+
+checkstyle-suppressions.xml:
+```xml
+<?xml version="1.0"?>
+
+<!DOCTYPE suppressions PUBLIC
+        "-//Checkstyle//DTD SuppressionFilter Configuration 1.0//EN"
+        "https://checkstyle.org/dtds/suppressions_1_0.dtd">
+
+<suppressions>
+<!--    EXAMPLE -->
+<!--    <suppress checks="LineLength"-->
+<!--              files="AppConfig.java"-->
+<!--              lines="0-9999"/>-->
+</suppressions>
+```
+
+Other path — use:
+```java 
+@SuppressWarnings({"checkstyle:%module_name%", "checkstyle:%module_name%""})
+``` 
+
+Example:
+```java 
+@SuppressWarnings({"checkstyle:parametername", "checkstyle:localvariablename"})
+``` 
diff --git a/conf/checkstyle-suppressions.xml b/conf/checkstyle-suppressions.xml
new file mode 100644
index 0000000..ef2efcd
--- /dev/null
+++ b/conf/checkstyle-suppressions.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE suppressions PUBLIC
+        "-//Checkstyle//DTD SuppressionFilter Configuration 1.0//EN"
+        "https://checkstyle.org/dtds/suppressions_1_0.dtd">
+
+<suppressions>
+<!--    EXAMPLE -->
+<!--    <suppress checks="LineLength"-->
+<!--              files="AppConfig.java"-->
+<!--              lines="0-9999"/>-->
+</suppressions>
diff --git a/conf/rbkmoney_google_checkstyle.xml b/conf/rbkmoney_google_checkstyle.xml
index 5cc1ced..03956ef 100644
--- a/conf/rbkmoney_google_checkstyle.xml
+++ b/conf/rbkmoney_google_checkstyle.xml
@@ -33,6 +33,7 @@
                   default="checkstyle-suppressions.xml" />
         <property name="optional" value="true"/>
     </module>
+    <module name="SuppressWarningsFilter"/>
 
     <!-- Checks for whitespace                               -->
     <!-- See http://checkstyle.org/config_whitespace.html -->
@@ -48,6 +49,7 @@
     </module>
 
     <module name="TreeWalker">
+        <module name="SuppressWarningsHolder"/>
         <module name="OuterTypeFilename"/>
         <module name="IllegalTokenText">
             <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>