feat: add clang-format style configuration (#5424)

super-linter · Apr 11, 2024 · 0ae4572 · 0ae4572
1 parent e71a37d
commit 0ae4572
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -194,6 +194,7 @@ You can configure super-linter using the following environment variables:
 | **BASH_EXEC_IGNORE_LIBRARIES**                  | `false`                          | If set to `true`, shell files with a file extension and no shebang line are ignored when checking if the executable bit is set.                                                                                      |
 | **BASH_SEVERITY**                               | `style`                         | Specify the minimum severity of errors to consider in shellcheck. Valid values in order of severity are error, warning, info and style.                                                                              |
 | **CHECKOV_FILE_NAME**                           | `.checkov.yaml`                 | Configuration filename for Checkov.                                                                                                                                                                                  |
+| **CLANG_FORMAT_FILE_NAME**                           | `.clang-format`                 | Configuration filename for [clang-format](https://clang.llvm.org/docs/ClangFormatStyleOptions.html).                                                                                                                                                                                  |
 | **CREATE_LOG_FILE**                             | `false`                         | If set to `true`, it creates the log file. You can set the log filename using the `LOG_FILE` environment variable. This overrides any existing log files.                                                            |
 | **CSS_FILE_NAME**                               | `.stylelintrc.json`             | Filename for [Stylelint configuration](https://github.com/stylelint/stylelint) (ex: `.stylelintrc.yml`, `.stylelintrc.yaml`)                                                                                         |
 | **DEFAULT_BRANCH**                              | Default repository branch when running on GitHub Actions, `master` otherwise | The name of the repository default branch. There's no need to configure this variable when running on GitHub Actions                                                    |

diff --git a/TEMPLATES/.clang-format b/TEMPLATES/.clang-format
@@ -0,0 +1 @@
+BasedOnStyle: LLVM
diff --git a/lib/functions/linterCommands.sh b/lib/functions/linterCommands.sh
@@ -31,7 +31,7 @@ else
   debug "Adding the '--directory' option to the Checkov command."
   LINTER_COMMANDS_ARRAY_CHECKOV+=(--directory)
 fi
-LINTER_COMMANDS_ARRAY_CLANG_FORMAT=(clang-format --Werror --dry-run)
+LINTER_COMMANDS_ARRAY_CLANG_FORMAT=(clang-format --style=file:"${CLANG_FORMAT_LINTER_RULES}" --Werror --dry-run)
 LINTER_COMMANDS_ARRAY_CLOJURE=(clj-kondo --config "${CLOJURE_LINTER_RULES}" --lint)
 LINTER_COMMANDS_ARRAY_CLOUDFORMATION=(cfn-lint --config-file "${CLOUDFORMATION_LINTER_RULES}")
 LINTER_COMMANDS_ARRAY_COFFEESCRIPT=(coffeelint -f "${COFFEESCRIPT_LINTER_RULES}")

diff --git a/lib/linter.sh b/lib/linter.sh
@@ -152,6 +152,8 @@ ARM_FILE_NAME=".arm-ttk.psd1"
 BASH_SEVERITY="${BASH_SEVERITY:-""}"
 CHECKOV_FILE_NAME="${CHECKOV_FILE_NAME:-".checkov.yaml"}"
 # shellcheck disable=SC2034  # Variable is referenced indirectly
+CLANG_FORMAT_FILE_NAME="${CLANG_FORMAT_FILE_NAME:-".clang-format"}"
+# shellcheck disable=SC2034  # Variable is referenced indirectly
 CLOJURE_FILE_NAME=".clj-kondo/config.edn"
 # shellcheck disable=SC2034  # Variable is referenced indirectly
 CLOUDFORMATION_FILE_NAME=".cfnlintrc.yml"

diff --git a/test/inspec/super-linter/controls/super_linter.rb b/test/inspec/super-linter/controls/super_linter.rb
@@ -474,6 +474,7 @@
     "/action/lib/.automation/.cfnlintrc.yml",
     "/action/lib/.automation/.checkov.yaml",
     "/action/lib/.automation/.chktexrc",
+    "/action/lib/.automation/.clang-format",
     "/action/lib/.automation/.clj-kondo",
     "/action/lib/.automation/.coffee-lint.json",
     "/action/lib/.automation/.ecrc",