feat: support passing arguments to java (#6785)

ferrarimarco · web-flow · commit 4099648f56a2 · 2025-05-19T18:08:06.000+02:00
Close #6281
diff --git a/README.md b/README.md
@@ -286,6 +286,7 @@ You can configure Super-linter using the following environment variables:
 | **GROOVY_FAILON_LEVEL**                         | `warning`                                                                    | npm-groovy-lint failon level.                                                                                                                                                                                                                                                                                                        |
 | **IGNORE_GENERATED_FILES**                      | `false`                                                                      | If set to `true`, super-linter will ignore all the files with `@generated` marker but without `@not-generated` marker. Jscpd and Checkov ignore this variable. Use their include and ignore features to select or ignore the files to lint.                                                                                          |
 | **IGNORE_GITIGNORED_FILES**                     | `false`                                                                      | If set to `true`, super-linter will ignore all the files that are ignored by Git. Jscpd and Checkov ignore this variable. Use their include and ignore features to select or ignore the files to lint.                                                                                                                               |
+| **JAVA_COMMAND_ARGS**                           | not set                                                                      | Additional Java JRE arguments passed to the checkstyle linter that can be used to specify additional configuration parameters via Java properties, such as [Suppression Filter files](https://checkstyle.org/filters/suppressionfilter.html), for example: `-Dorg.checkstyle.sun.suppressionfilter.config=path/to/suppressions.xml`  |
 | **JAVA_FILE_NAME**                              | `sun_checks.xml`                                                             | Filename for [Checkstyle configuration](https://checkstyle.sourceforge.io/config.html). Checkstyle embeds several configuration files, such as `sun_checks.xml`, `google_checks.xml` that you can use without providing your own configuration file.                                                                                 |
 | **JAVASCRIPT_ES_CONFIG_FILE**                   | `.eslintrc.yml`                                                              | Filename for [ESLint configuration](https://eslint.org/docs/user-guide/configuring#configuration-file-formats) (ex: `.eslintrc.yml`, `.eslintrc.json`)                                                                                                                                                                               |
 | **JSCPD_CONFIG_FILE**                           | `.jscpd.json`                                                                | Filename for JSCPD configuration                                                                                                                                                                                                                                                                                                     |
diff --git a/lib/functions/linterCommands.sh b/lib/functions/linterCommands.sh
@@ -151,7 +151,9 @@ if [ -n "${GITLEAKS_LOG_LEVEL:-}" ]; then
 fi
 if [ -n "${GITLEAKS_COMMAND_OPTIONS:-}" ]; then
   export GITLEAKS_COMMAND_OPTIONS
-  AddOptionsToCommand "LINTER_COMMANDS_ARRAY_GITLEAKS" "${GITLEAKS_COMMAND_OPTIONS}"
+  if ! AddOptionsToCommand "LINTER_COMMANDS_ARRAY_GITLEAKS" "${GITLEAKS_COMMAND_OPTIONS}"; then
+    fatal "Error while adding options to GITLEAKS command"
+  fi
 fi
 LINTER_COMMANDS_ARRAY_GITLEAKS+=(--source)
 LINTER_COMMANDS_ARRAY_GIT_COMMITLINT=(commitlint --verbose --cwd "{}")
@@ -175,6 +177,12 @@ LINTER_COMMANDS_ARRAY_GROOVY=(npm-groovy-lint -c "${GROOVY_LINTER_RULES}" --fail
 LINTER_COMMANDS_ARRAY_HTML=(htmlhint --config "${HTML_LINTER_RULES}")
 LINTER_COMMANDS_ARRAY_HTML_PRETTIER=("${PRETTIER_COMMAND[@]}")
 LINTER_COMMANDS_ARRAY_JAVA=(java -jar /usr/bin/checkstyle -c "${JAVA_LINTER_RULES}")
+if [ -n "${JAVA_COMMAND_ARGS:-}" ]; then
+  export JAVA_COMMAND_ARGS
+  if ! AddOptionsToCommand "LINTER_COMMANDS_ARRAY_JAVA" "${JAVA_COMMAND_ARGS}"; then
+    fatal "Error while adding options to JAVA command"
+  fi
+fi
 LINTER_COMMANDS_ARRAY_JAVASCRIPT_ES=(eslint -c "${JAVASCRIPT_ES_LINTER_RULES}")
 LINTER_COMMANDS_ARRAY_JAVASCRIPT_PRETTIER=("${PRETTIER_COMMAND[@]}")
 LINTER_COMMANDS_ARRAY_JSCPD=(jscpd --config "${JSCPD_LINTER_RULES}")
diff --git a/test/lib/linterCommandsTest.sh b/test/lib/linterCommandsTest.sh
@@ -61,6 +61,7 @@ BASE_LINTER_COMMANDS_ARRAY_GITHUB_ACTIONS=("${LINTER_COMMANDS_ARRAY_GITHUB_ACTIO
 BASE_LINTER_COMMANDS_ARRAY_GIT_COMMITLINT=("${LINTER_COMMANDS_ARRAY_GIT_COMMITLINT[@]}")
 BASE_LINTER_COMMANDS_ARRAY_GITLEAKS=("${LINTER_COMMANDS_ARRAY_GITLEAKS[@]}")
 BASE_LINTER_COMMANDS_ARRAY_GO_MODULES=("${LINTER_COMMANDS_ARRAY_GO_MODULES[@]}")
+BASE_LINTER_COMMANDS_ARRAY_JAVA=("${LINTER_COMMANDS_ARRAY_JAVA[@]}")
 BASE_LINTER_COMMANDS_ARRAY_JSCPD=("${LINTER_COMMANDS_ARRAY_JSCPD[@]}")
 BASE_LINTER_COMMANDS_ARRAY_PERL=("${LINTER_COMMANDS_ARRAY_PERL[@]}")
 BASE_LINTER_COMMANDS_ARRAY_RUST_CLIPPY=("${LINTER_COMMANDS_ARRAY_RUST_CLIPPY[@]}")
@@ -408,6 +409,8 @@ CommandOptionsTest() {
   # shellcheck disable=SC2034
   local GITLEAKS_COMMAND_OPTIONS="${ARGS_TO_ADD}"
   # shellcheck disable=SC2034
+  local JAVA_COMMAND_ARGS="${ARGS_TO_ADD}"
+  # shellcheck disable=SC2034
   local PERL_PERLCRITIC_OPTIONS="${ARGS_TO_ADD}"
   # shellcheck disable=SC2034
   local RUST_CLIPPY_COMMAND_OPTIONS="${ARGS_TO_ADD}"
@@ -433,6 +436,13 @@ CommandOptionsTest() {
     fatal "${FUNCTION_NAME} test failed"
   fi
 
+  # shellcheck disable=SC2034
+  local EXPECTED_LINTER_COMMANDS_ARRAY_JAVA=("${BASE_LINTER_COMMANDS_ARRAY_JAVA[@]}")
+  AddOptionsToCommand "EXPECTED_LINTER_COMMANDS_ARRAY_JAVA" "${JAVA_COMMAND_ARGS}"
+  if ! AssertArraysElementsContentMatch "LINTER_COMMANDS_ARRAY_JAVA" "EXPECTED_LINTER_COMMANDS_ARRAY_JAVA"; then
+    fatal "${FUNCTION_NAME} test failed"
+  fi
+
   # shellcheck disable=SC2034
   local EXPECTED_LINTER_COMMANDS_ARRAY_PERL=("${BASE_LINTER_COMMANDS_ARRAY_PERL[@]}")
   AddOptionsToCommand "EXPECTED_LINTER_COMMANDS_ARRAY_PERL" "${PERL_PERLCRITIC_OPTIONS}"
