feat: run ruff as a formatter (#6981)

Close #5951

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>

Author: ferrarimarco

lib/functions/buildFileList.sh

@@ -534,6 +534,7 @@ BuildFileArrays() {
       echo "${FILE}" >>"${FILE_ARRAYS_DIRECTORY_PATH}/file-array-PYTHON_PYLINT"
       echo "${FILE}" >>"${FILE_ARRAYS_DIRECTORY_PATH}/file-array-PYTHON_MYPY"
       echo "${FILE}" >>"${FILE_ARRAYS_DIRECTORY_PATH}/file-array-PYTHON_RUFF"
+      echo "${FILE}" >>"${FILE_ARRAYS_DIRECTORY_PATH}/file-array-PYTHON_RUFF_FORMAT"
     elif [ "${FILE_TYPE}" == "r" ] || [ "${FILE_TYPE}" == "rmd" ]; then
       echo "${FILE}" >>"${FILE_ARRAYS_DIRECTORY_PATH}/file-array-R"
     elif [ "${FILE_TYPE}" == "rb" ]; then

lib/functions/linterCommands.sh

@@ -251,6 +251,7 @@ LINTER_COMMANDS_ARRAY_PYTHON_FLAKE8=(flake8 --config="${PYTHON_FLAKE8_LINTER_RUL
 LINTER_COMMANDS_ARRAY_PYTHON_ISORT=(isort --sp "${PYTHON_ISORT_LINTER_RULES}")
 LINTER_COMMANDS_ARRAY_PYTHON_MYPY=(mypy --config-file "${PYTHON_MYPY_LINTER_RULES}" --install-types --non-interactive)
 LINTER_COMMANDS_ARRAY_PYTHON_RUFF=(ruff check --config "${PYTHON_RUFF_LINTER_RULES}")
+LINTER_COMMANDS_ARRAY_PYTHON_RUFF_FORMAT=(ruff format --config "${PYTHON_RUFF_FORMAT_LINTER_RULES}")
 LINTER_COMMANDS_ARRAY_R=(R --slave -e "\"lints <- lintr::lint('{}');print(lints);errors <- purrr::keep(lints, ~ .\\\$type == 'error');quit(save = 'no', status = if (length(errors) > 0) 1 else 0)\"")
 LINTER_COMMANDS_ARRAY_RENOVATE=(renovate-config-validator --strict)
 LINTER_COMMANDS_ARRAY_RUBY=(rubocop -c "${RUBY_LINTER_RULES}" --force-exclusion --ignore-unrecognized-cops)

lib/functions/validation.sh

@@ -609,4 +609,9 @@ ValidateDeprecatedConfigurationFiles() {
 
 ValidateConflictingTools() {
   debug "Validating if potentially conflicting tools are enabled"
+
+  if [[ "${VALIDATE_PYTHON_BLACK}" == "true" ]] && [[ "${VALIDATE_PYTHON_RUFF_FORMAT}" == "true" ]]; then
+    warn "Black and Ruff formatter are both enabled, and might conflict with each other. To avoid potential conflicts, keep only one of the two enabled, and disable the other."
+    return 1
+  fi
 }

lib/globals/languages.sh

@@ -40,6 +40,7 @@ LANGUAGE_ARRAY=('ANSIBLE' 'ARM' 'BASH' 'BASH_EXEC' 'CHECKOV' 'CLANG_FORMAT'
   'NATURAL_LANGUAGE' 'OPENAPI' 'PERL' 'PHP_BUILTIN' 'PHP_PHPCS' 'PHP_PHPSTAN'
   'PHP_PSALM' 'POWERSHELL' 'PROTOBUF' 'PYTHON_BLACK' 'PYTHON_PYLINT'
   'PYTHON_FLAKE8' 'PYTHON_ISORT' 'PYTHON_MYPY' 'PYTHON_RUFF'
+  "PYTHON_RUFF_FORMAT"
   'R' 'RENOVATE' 'RUBY' 'RUST_2015'
   'RUST_2018' 'RUST_2021' 'RUST_CLIPPY' 'SCALAFMT' 'SHELL_SHFMT'
   'SNAKEMAKE_LINT' 'SNAKEMAKE_SNAKEFMT' 'STATES' 'SQLFLUFF'

lib/globals/linterCommandsOptions.sh

@@ -29,6 +29,7 @@ JUPYTER_NBQA_ISORT_CHECK_ONLY_MODE_OPTIONS=(--diff --check)
 MARKDOWN_PRETTIER_CHECK_ONLY_MODE_OPTIONS=("${PRETTIER_CHECK_ONLY_MODE_OPTIONS[@]}")
 PYTHON_BLACK_CHECK_ONLY_MODE_OPTIONS=(--diff --check)
 PYTHON_ISORT_CHECK_ONLY_MODE_OPTIONS=(--diff --check)
+PYTHON_RUFF_FORMAT_CHECK_ONLY_MODE_OPTIONS=(--check)
 RUST_2015_CHECK_ONLY_MODE_OPTIONS=("${RUSTFMT_CHECK_ONLY_MODE_OPTIONS[@]}")
 RUST_2018_CHECK_ONLY_MODE_OPTIONS=("${RUSTFMT_CHECK_ONLY_MODE_OPTIONS[@]}")
 RUST_2021_CHECK_ONLY_MODE_OPTIONS=("${RUSTFMT_CHECK_ONLY_MODE_OPTIONS[@]}")

lib/globals/linterRules.sh

@@ -78,6 +78,8 @@ PYTHON_PYLINT_FILE_NAME="${PYTHON_PYLINT_CONFIG_FILE:-.python-lint}"
 # shellcheck disable=SC2034  # Variable is referenced indirectly
 PYTHON_RUFF_FILE_NAME="${PYTHON_RUFF_CONFIG_FILE:-.ruff.toml}"
 # shellcheck disable=SC2034  # Variable is referenced indirectly
+PYTHON_RUFF_FORMAT_FILE_NAME="${PYTHON_RUFF_FORMAT_CONFIG_FILE:-.ruff.toml}"
+# shellcheck disable=SC2034  # Variable is referenced indirectly
 R_FILE_NAME=".lintr"
 # shellcheck disable=SC2034  # Variable is referenced indirectly
 RUBY_FILE_NAME="${RUBY_CONFIG_FILE:-.ruby-lint.yml}"

scripts/linterVersions.sh

@@ -71,6 +71,7 @@ LINTER_NAMES_ARRAY['PYTHON_FLAKE8']="flake8"
 LINTER_NAMES_ARRAY['PYTHON_ISORT']="isort"
 LINTER_NAMES_ARRAY['PYTHON_MYPY']="mypy"
 LINTER_NAMES_ARRAY['PYTHON_RUFF']="ruff"
+LINTER_NAMES_ARRAY['PYTHON_RUFF_FORMAT']="ruff"
 LINTER_NAMES_ARRAY['R']="R"
 LINTER_NAMES_ARRAY['RENOVATE']="renovate-config-validator"
 LINTER_NAMES_ARRAY['RUBY']="rubocop"

test/data/super-linter-summary/markdown/table/expected-summary-test-linters-expect-failure-slim.md

@@ -67,6 +67,7 @@
 | PYTHON_ISORT               | Fail ❌           |
 | PYTHON_MYPY                | Fail ❌           |
 | PYTHON_RUFF                | Fail ❌           |
+| PYTHON_RUFF_FORMAT         | Fail ❌           |
 | R                          | Fail ❌           |
 | RENOVATE                   | Fail ❌           |
 | RUBY                       | Fail ❌           |

test/data/super-linter-summary/markdown/table/expected-summary-test-linters-expect-failure-standard.md

@@ -73,6 +73,7 @@
 | PYTHON_ISORT                 | Fail ❌           |
 | PYTHON_MYPY                  | Fail ❌           |
 | PYTHON_RUFF                  | Fail ❌           |
+| PYTHON_RUFF_FORMAT           | Fail ❌           |
 | R                            | Fail ❌           |
 | RENOVATE                     | Fail ❌           |
 | RUBY                         | Fail ❌           |

test/data/super-linter-summary/markdown/table/expected-summary-test-linters-expect-success-slim.md

@@ -67,6 +67,7 @@
 | PYTHON_ISORT               | Pass ✅           |
 | PYTHON_MYPY                | Pass ✅           |
 | PYTHON_RUFF                | Pass ✅           |
+| PYTHON_RUFF_FORMAT         | Pass ✅           |
 | R                          | Pass ✅           |
 | RENOVATE                   | Pass ✅           |
 | RUBY                       | Pass ✅           |