Implement pull request check on code style (#505)

* Implement pull request check on code style

* Enable debug logging

* Explicitly set EDITORCONFIG_FILE_NAME

* Move .ecrc file to .github/linters

* Revert to standard loglevel and do not set EDITORCONFIG_FILE_NAME

.github/linters/.ecrc

@@ -0,0 +1,36 @@
+{
+  "Verbose": false,
+  "Debug": false,
+  "IgnoreDefaults": false,
+  "SpacesAftertabs": true,
+  "NoColor": false,
+  "Exclude": [
+    ".editorconfig",
+    ".github",
+    "LICENSE",
+    "README.md",
+    "chart",
+    "docker-compose",
+    "docs",
+    "kaas_local_jaas.conf",
+    "mvnw",
+    "mvnw.cmd",
+    "pom.xml",
+    "src/main/assembly",
+    "src/main/docker",
+    "src/main/resources",
+    "src/test/resources",
+    "target",
+    "theme"
+  ],
+  "AllowedContentTypes": [],
+  "PassedFiles": [],
+  "Disable": {
+    "EndOfLine": false,
+    "Indentation": false,
+    "IndentSize": true,
+    "InsertFinalNewline": false,
+    "TrimTrailingWhitespace": false,
+    "MaxLineLength": true
+  }
+}

.github/workflows/pull_request.yml

@@ -13,8 +13,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up JDK 17
+    - name: Checkout src repo
+      uses: actions/checkout@v3
+    - name: Lint code base
+      uses: github/super-linter@v4
+      env:
+        VALIDATE_ALL_CODEBASE: false
+        VALIDATE_EDITORCONFIG: true
+        DEFAULT_BRANCH: master
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Set up JDK
       uses: actions/setup-java@v3
       with:
         java-version: '17'

CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Introduction
+
+All contributions are more than welcomed. Contributions may close an issue, fix a bug (reported or not reported), add new design blocks, improve the existing code, add new feature, and so on. In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone.
+
+# Coding style
+
+For code contributions, please respect the coding style as documented in [.editorconfig](.editorconfig). We are in the process of setting up automated checks on this.

README.md

@@ -396,7 +396,7 @@ To logout, browse to [/logout](http://localhost:8080/logout).
 
 # Contributing Guidelines
 
-All contributions are more than welcomed. Contributions may close an issue, fix a bug (reported or not reported), add new design blocks, improve the existing code, add new feature, and so on. In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone.
+See [here](CONTRIBUTING.md).
 
 ## Release workflow
 

src/main/java/kafdrop/config/KafkaConfiguration.java

@@ -65,4 +65,4 @@ public void applyCommon(Properties properties) {
       properties.putAll(propertyOverrides);
     }
   }
-}
+}

src/main/java/kafdrop/controller/BasicErrorController.java

@@ -34,4 +34,4 @@ public ModelAndView handleError(HttpServletRequest request) {
     final var model = Map.of("error", error);
     return new ModelAndView("error", model);
   }
-}
+}

src/main/java/kafdrop/controller/ConsumerController.java

@@ -61,4 +61,4 @@ public String consumerDetail(@PathVariable("groupId") String groupId, Model mode
 
     return consumer.orElseThrow(() -> new ConsumerNotFoundException(groupId));
   }
-}
+}

src/main/java/kafdrop/util/KeyFormat.java

@@ -2,4 +2,4 @@
 
 public enum KeyFormat {
   DEFAULT, AVRO
-}
+}

src/main/java/kafdrop/util/MessageFormat.java

@@ -2,4 +2,4 @@
 
 public enum MessageFormat {
   DEFAULT, AVRO, PROTOBUF, MSGPACK
-}
+}

src/test/java/kafdrop/model/ConsumerPartitionVOTest.java

@@ -40,4 +40,4 @@ void testGetLag() {
     doLagTest(6, 6, 2, 0);
     doLagTest(5, 10, -1, 5);
   }
-}
+}