ENH: sort JSON document case-insensitive (#197)

docs/conf.py

@@ -117,10 +117,10 @@ def get_version(package_name: str) -> str:
     "colon_fence",
 ]
 nitpick_ignore = [
-    ("py:class", "repoma.utilities.precommit.T"),
     ("py:class", "tomlkit.container.Container"),
 ]
 nitpick_ignore_regex = [
+    ("py:class", r"^.*.[A-Z]$"),
     (r"py:.*", r"ruamel\.yaml\..*"),
 ]
 nitpicky = True

pyproject.toml

@@ -87,6 +87,7 @@ reportPrivateImportUsage = false
 reportPrivateUsage = false
 reportUnboundVariable = false
 reportUnknownArgumentType = false
+reportUnknownLambdaType = false
 reportUnknownMemberType = false
 reportUnknownParameterType = false
 reportUnknownVariableType = false
@@ -151,21 +152,22 @@ extend-select = [
     "YTT",
 ]
 ignore = [
-    "C408", # Unnecessary dict call - rewrite as a literal
-    "D101", # class docstring
-    "D102", # method docstring
-    "D103", # function docstring
-    "D105", # magic method docstring
-    "D107", # init docstring
-    "D203", # conflicts with D211
-    "D213", # multi-line docstring should start at the second line
-    "D407", # missing dashed underline after section
-    "D416", # section name does not have to end with a colon
-    "E501", # handled by black formatting
-    "PLR0913", # sympy functions
-    "PLW2901", # often used for xreplace
-    "S301", # allow pickle
-    "SIM108", # if-else-block-instead-of-if-exp
+    "C408",
+    "D101",
+    "D102",
+    "D103",
+    "D105",
+    "D107",
+    "D203",
+    "D213",
+    "D407",
+    "D416",
+    "E501",
+    "PLR0913",
+    "PLW2901",
+    "S301",
+    "SIM108",
+    "UP036",
 ]
 show-fixes = true
 src = [

setup.cfg

@@ -41,6 +41,7 @@ install_requires =
     PyYAML
     ruamel.yaml  # better YAML dumping
     tomlkit
+    typing-extensions; python_version<"3.7.0"
 packages = find:
 package_dir =
     =src

src/repoma/check_dev_files/ruff.py

@@ -173,6 +173,8 @@ def _update_ruff_settings() -> None:
         "E501",  # line-width already handled by black
         "SIM108",  # allow if-else blocks
     ]
+    if "3.6" in get_supported_python_versions():
+        extend_ignore.append("UP036")
     ignores = sorted({*settings.get("ignore", []), *extend_ignore})
     minimal_settings = {
         "extend-select": __get_selected_ruff_rules(),

src/repoma/utilities/vscode.py

@@ -1,15 +1,23 @@
 """Helper functions for modifying a VSCode configuration."""
 
+import collections
 import json
+import sys
+from collections import abc
 from copy import deepcopy
 from pathlib import Path
-from typing import Iterable, Union
+from typing import Dict, Iterable, List, TypeVar, Union, overload
 
 from repoma.errors import PrecommitError
 from repoma.utilities.executor import Executor
 
 from . import CONFIG_PATH
 
+if sys.version_info < (3, 7):
+    from typing_extensions import OrderedDict
+else:
+    from typing import OrderedDict
+
 
 def remove_setting(key: Union[str, dict]) -> None:
     old = __load_config(CONFIG_PATH.vscode_settings, create=True)
@@ -110,10 +118,48 @@ def _remove() -> None:
 
 def __dump_config(config: dict, path: Path) -> None:
     with open(path, "w") as stream:
-        json.dump(config, stream, indent=2, sort_keys=True)
+        json.dump(sort_case_insensitive(config), stream, indent=2)
         stream.write("\n")
 
 
+K = TypeVar("K")
+V = TypeVar("V")
+
+
+@overload
+def sort_case_insensitive(dct: Dict[K, V]) -> OrderedDict[K, V]: ...  # type: ignore[misc]
+@overload
+def sort_case_insensitive(dct: str) -> str: ...  # type: ignore[misc]
+@overload
+def sort_case_insensitive(dct: Iterable[K]) -> List[K]: ...  # type: ignore[misc]
+@overload
+def sort_case_insensitive(dct: K) -> K: ...
+def sort_case_insensitive(dct):  # type: ignore[no-untyped-def]
+    """Order a `dict` by key, **case-insensitive**.
+
+    This function is implemented in order to :func:`~json.dump` a JSON file with a
+    sorting that is the same as `the one used by VS Code
+    <https://code.visualstudio.com/updates/v1_76#_jsonc-document-sorting>`_.
+
+    >>> sort_case_insensitive(
+    ...     {
+    ...         "cSpell.enabled": True,
+    ...         "coverage-gutters": ["test", "coverage.xml"],
+    ...     }
+    ... )
+    OrderedDict([('coverage-gutters', ['coverage.xml', 'test']), ('cSpell.enabled', True)])
+    """
+    if isinstance(dct, abc.Mapping):
+        return collections.OrderedDict(
+            {k: sort_case_insensitive(dct[k]) for k in sorted(dct, key=str.lower)}
+        )
+    if isinstance(dct, str):
+        return dct
+    if isinstance(dct, abc.Iterable):
+        return sorted(dct, key=lambda t: str(t).lower())
+    return dct
+
+
 def __load_config(path: Path, create: bool = False) -> dict:
     if not path.exists() and create:
         path.parent.mkdir(exist_ok=True)