From f34b0845868c9df6a8c3378ec1a9840168942adb Mon Sep 17 00:00:00 2001
From: Josselin <josselin@trailofbits.com>
Date: Wed, 2 Sep 2020 09:27:32 +0200
Subject: [PATCH] Add support for black config file

---
 .github/linters/.python-black | 0
 README.md                     | 1 +
 TEMPLATES/.python-black       | 0
 docs/disabling-linters.md     | 4 +++-
 lib/linter.sh                 | 4 +++-
 lib/worker.sh                 | 2 +-
 6 files changed, 8 insertions(+), 3 deletions(-)
 create mode 100644 .github/linters/.python-black
 create mode 100644 TEMPLATES/.python-black

diff --git a/.github/linters/.python-black b/.github/linters/.python-black
new file mode 100644
index 00000000..e69de29b
diff --git a/README.md b/README.md
index 549657d8..4fd9d753 100644
--- a/README.md
+++ b/README.md
@@ -191,6 +191,7 @@ But if you wish to select or exclude specific linters, we give you full control
 | **OUTPUT_DETAILS**                | `simpler`             | What level of details to be reported. Supported formats: simpler or detailed.                                                                                                    |
 | **PYTHON_PYLINT_CONFIG_FILE**     | `.python-lint`        | Filename for [pylint configuration](http://pylint.pycqa.org/en/latest/user_guide/run.html?highlight=rcfile#command-line-options) (ex: `.python-lint`, `.pylintrc`)               |
 | **PYTHON_FLAKE8_CONFIG_FILE**     | `.flake8`             | Filename for [flake8 configuration](https://flake8.pycqa.org/en/latest/user/configuration.html) (ex: `.flake8`, `tox.ini`)                                                       |
+| **PYTHON_BLACK_CONFIG_FILE**      | `.python-black        | Filename for [black configuration](https://github.com/psf/black/blob/master/docs/compatible_configs.md) (ex: `.isort.cfg`, `pyproject.toml`)                                     |
 | **RUBY_CONFIG_FILE**              | `.ruby-lint.yml`      | Filename for [rubocop configuration](https://docs.rubocop.org/rubocop/configuration.html) (ex: `.ruby-lint.yml`, `.rubocop.yml`)                                                 |
 | **TYPESCRIPT_ES_CONFIG_FILE**     | `.eslintrc.yml`       | Filename for [eslint configuration](https://eslint.org/docs/user-guide/configuring#configuration-file-formats) (ex: `.eslintrc.yml`, `.eslintrc.json`)                           |
 | **VALIDATE_ALL_CODEBASE**         | `true`                | Will parse the entire repository and find all files to validate across all types. **NOTE:** When set to `false`, only **new** or **edited** files will be parsed for validation. |
diff --git a/TEMPLATES/.python-black b/TEMPLATES/.python-black
new file mode 100644
index 00000000..e69de29b
diff --git a/docs/disabling-linters.md b/docs/disabling-linters.md
index 7a8d949b..a15f2f89 100644
--- a/docs/disabling-linters.md
+++ b/docs/disabling-linters.md
@@ -948,7 +948,9 @@ var = "terrible code down here..."
 
 ### Black Config file
 
-- There is no top level _configuration file_ available at this time
+- .github/linters/.python-black
+- You can pass multiple rules and overwrite default rules
+- File should be located at: .github/linters/.python-black
 
 ### Black disable single line
 
diff --git a/lib/linter.sh b/lib/linter.sh
index 2b0030b3..a46cb0f9 100755
--- a/lib/linter.sh
+++ b/lib/linter.sh
@@ -110,6 +110,8 @@ PYTHON_PYLINT_FILE_NAME="${PYTHON_PYLINT_CONFIG_FILE:-.python-lint}"
 PYTHON_PYLINT_LINTER_RULES="${DEFAULT_RULES_LOCATION}/${PYTHON_PYLINT_FILE_NAME}" # Path to the python lint rules
 PYTHON_FLAKE8_FILE_NAME="${PYTHON_FLAKE8_CONFIG_FILE:-.flake8}"                   # Name of the file
 PYTHON_FLAKE8_LINTER_RULES="${DEFAULT_RULES_LOCATION}/${PYTHON_FLAKE8_FILE_NAME}" # Path to the python lint rules
+PYTHON_BLACK_FILE_NAME="${PYTHON_BLACK_CONFIG_FILE:-.python-black}"               # Name of the file
+PYTHON_BLACK_LINTER_RULES="${DEFAULT_RULES_LOCATION}/${PYTHON_BLACK_FILE_NAME}"   # Path to the python lint rules
 # R Vars
 R_FILE_NAME='.lintr'                                                              # Name of the file
 R_LINTER_RULES="${DEFAULT_RULES_LOCATION}/${R_FILE_NAME}"                         # Path to the R lint rules
@@ -1777,7 +1779,7 @@ if [ "${VALIDATE_PYTHON_BLACK}" == "true" ]; then
   # Lint the python files #
   #########################
   # LintCodebase "FILE_TYPE" "LINTER_NAME" "LINTER_CMD" "FILE_TYPES_REGEX" "FILE_ARRAY"
-  LintCodebase "PYTHON_BLACK" "black" "black --diff --check" ".*\.\(py\)\$" "${FILE_ARRAY_PYTHON_BLACK[@]}"
+  LintCodebase "PYTHON_BLACK" "black" "black --config ${PYTHON_BLACK_LINTER_RULES} --diff --check" ".*\.\(py\)\$" "${FILE_ARRAY_PYTHON_BLACK[@]}"
 fi
 
 #########################
diff --git a/lib/worker.sh b/lib/worker.sh
index 35247b75..1f4b66b9 100755
--- a/lib/worker.sh
+++ b/lib/worker.sh
@@ -684,7 +684,7 @@ function RunTestCases() {
   TestCodebase "OPENAPI" "spectral" "spectral lint -r ${OPENAPI_LINTER_RULES}" ".*\.\(ymlopenapi\|jsonopenapi\)\$" "openapi"
   TestCodebase "POWERSHELL" "pwsh" "Invoke-ScriptAnalyzer -EnableExit -Settings ${POWERSHELL_LINTER_RULES} -Path" ".*\.\(ps1\|psm1\|psd1\|ps1xml\|pssc\|psrc\|cdxml\)\$" "powershell"
   TestCodebase "PROTOBUF" "protolint" "protolint lint --config_path ${PROTOBUF_LINTER_RULES}" ".*\.\(proto\)\$" "protobuf"
-  TestCodebase "PYTHON_BLACK" "black" "black --diff --check" ".*\.\(py\)\$" "python"
+  TestCodebase "PYTHON_BLACK" "black" "black --config ${PYTHON_BLACK_LINTER_RULES} --diff --check" ".*\.\(py\)\$" "python"
   TestCodebase "PYTHON_FLAKE8" "flake8" "flake8 --config ${PYTHON_FLAKE8_LINTER_RULES}" ".*\.\(py\)\$" "python"
   TestCodebase "PYTHON_PYLINT" "pylint" "pylint --rcfile ${PYTHON_PYLINT_LINTER_RULES}" ".*\.\(py\)\$" "python"
   TestCodebase "R" "lintr" "lintr::lint()" ".*\.\(r\|rmd\)\$" "r"