ENH: deactivate Ruff isort split-on-trailing-comma

pyproject.toml

@@ -298,6 +298,9 @@ task-tags = ["cspell"]
 [tool.ruff.isort]
 known-first-party = ["compwa_policy"]
 
+[tool.ruff.lint.isort]
+split-on-trailing-comma = false
+
 [tool.ruff.per-file-ignores]
 "docs/*" = [
     "E402",

src/compwa_policy/check_dev_files/citation.py

@@ -10,10 +10,7 @@
 from html2text import HTML2Text
 from ruamel.yaml import YAML
 from ruamel.yaml.comments import CommentedMap, CommentedSeq
-from ruamel.yaml.scalarstring import (
-    FoldedScalarString,
-    PreservedScalarString,
-)
+from ruamel.yaml.scalarstring import FoldedScalarString, PreservedScalarString
 
 from compwa_policy.errors import PrecommitError
 from compwa_policy.utilities import CONFIG_PATH, vscode

src/compwa_policy/check_dev_files/ruff.py

@@ -53,7 +53,6 @@
     executor(_remove_pydocstyle)
     executor(_remove_pylint)
     executor(_update_ruff_settings, has_notebooks)
-    executor(_update_ruff_pydocstyle_settings)
     executor(_update_precommit_hook, has_notebooks)
     executor(_update_pyproject)
     executor(_update_vscode_settings)
@@ -262,7 +261,9 @@
 def _update_ruff_settings(has_notebooks: bool) -> None:
     executor = Executor()
     executor(__update_ruff_settings, has_notebooks)
-    executor(_update_ruff_per_file_ignores, has_notebooks)
+    executor(__update_ruff_per_file_ignores, has_notebooks)
+    executor(__update_ruff_isort_settings)
+    executor(__update_ruff_pydocstyle_settings)
     executor(_remove_nbqa)
     executor.finalize()
 
@@ -435,7 +436,7 @@
     return lowest_version
 
 
-def _update_ruff_per_file_ignores(has_notebooks: bool) -> None:
+def __update_ruff_per_file_ignores(has_notebooks: bool) -> None:
     pyproject = load_pyproject()
     settings = get_sub_table(pyproject, "tool.ruff.per-file-ignores", create=True)
     minimal_settings = {}
@@ -506,7 +507,18 @@
         raise PrecommitError(msg)
 
 
-def _update_ruff_pydocstyle_settings() -> None:
+def __update_ruff_isort_settings() -> None:
+    pyproject = load_pyproject()
+    settings = get_sub_table(pyproject, "tool.ruff.lint.isort", create=True)
+    minimal_settings = {"split-on-trailing-comma": False}
+    if not complies_with_subset(settings, minimal_settings):
+        settings.update(minimal_settings)
+        write_pyproject(pyproject)
+        msg = f"Updated Ruff isort settings in {CONFIG_PATH.pyproject}"
+        raise PrecommitError(msg)
+
+
+def __update_ruff_pydocstyle_settings() -> None:
     pyproject = load_pyproject()
     settings = get_sub_table(pyproject, "tool.ruff.pydocstyle", create=True)
     minimal_settings = {