JAL-1854 initial checkstyle config

[jalview.git] / resources / checkstyle / checkstyle-suppress.xml

diff --git a/resources/checkstyle/checkstyle-suppress.xml b/resources/checkstyle/checkstyle-suppress.xml
new file mode 100644 (file)
index 0000000..0c1d2ee
--- /dev/null
+++ b/resources/checkstyle/checkstyle-suppress.xml
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>\r
+\r
+<!DOCTYPE suppressions PUBLIC\r
+    "-//Puppy Crawl//DTD Suppressions 1.1//EN"\r
+    "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">\r
+\r
+<suppressions>\r
+       <!-- \r
+               Do not put individual file-level suppressions here.\r
+               Instead use embedded comments to switch checks on and off.\r
+    -->\r
+        \r
+    <!-- \r
+        Suppress check of XML binding generated code packages \r
+    --> \r
+    <suppress checks="[a-zA-Z0-9]*" files="jalview[\\/]schemabinding[\\/]*"/>\r
+    <suppress checks="[a-zA-Z0-9]*" files="jalview[\\/]binding[\\/]*"/>\r
+    <suppress checks="[a-zA-Z0-9]*" files="jalview[\\/]json[\\/]binding[\\/]*"/>\r
+    <suppress checks="[a-zA-Z0-9]*" files="jalview[\\/]xml[\\/]binding[\\/]*"/>\r
+        \r
+    <!-- \r
+       Suppress check of externally sourced code \r
+    --> \r
+    <suppress checks="[a-zA-Z0-9]*" files="com[\\/]*"/>\r
+    <suppress checks="[a-zA-Z0-9]*" files="ext[\\/]*"/>\r
+    <suppress checks="[a-zA-Z0-9]*" files="org[\\/]*"/>\r
+    <suppress checks="[a-zA-Z0-9]*" files="uk[\\/]*"/>\r
+    \r
+    <!-- \r
+       ImportControl can only handle one top level package\r
+    -->\r
+    <suppress checks="ImportControl" files="MCview[\\/]*" />\r
+    <suppress checks="ImportControl" files="vamsas[\\/]*" />\r
+    \r
+    <!--  \r
+       Suppress checks by name \r
+    -->\r
+       <suppress checks="FinalLocalVariable" files=".*\.java"/>\r
+    \r
+    <!--  \r
+       Suppress checks by id \r
+    -->\r
+       <suppress id="InterfaceNaming" files=".*\.java"/>\r
+       <suppress id="NoStaticInitialization" files=".*\.java"/>\r
+         \r
+</suppressions>
\ No newline at end of file