build: enable toml-sort-fix (#1949)

Partial: AAP-44002

Author: ssbarnea

.config/dictionary.txt

@@ -242,6 +242,7 @@ suboptions
 subshells
 sysninja
 seccomp
+tamasfe
 taskfile
 tasklist
 testenv
@@ -254,6 +255,7 @@ tls
 toctree
 todos
 tomaciazek
+tomlsort
 towerhost
 towncrier
 toxenv

.config/mise.toml

@@ -1,18 +1,20 @@
 [env]
+# https://github.com/nodejs/corepack/issues/550
+COREPACK_ENABLE_DOWNLOAD_PROMPT = 0
 # Command such `yarn webpack-dev` might fail with
 # Reached heap limit Allocation failed - JavaScript heap out of memory
 # https://nodejs.org/api/cli.html#--max-old-space-sizesize-in-megabytes
 # default 16 MiB for 64-bit systems and 8 MiB for 32-bit systems
 NODE_OPTIONS = "--max-old-space-size=8192"
-
 # 'vsa' is acronym for 'visual studio ansible'
 # we use HOME location below to avoid polluting the project directory with,
 # temporary data and to allow us to mount the codebase on multiple machines
 # for build and testing purposes.
 VIRTUAL_ENV = "{{ xdg_cache_home }}/.local/share/virtualenvs/vsa"
 
-# https://github.com/nodejs/corepack/issues/550
-COREPACK_ENABLE_DOWNLOAD_PROMPT = 0
+# Do not use other hooks than preinstall or postinstall because they will
+# not work without 'mise activate' command, something that we do not use on CI.
+[hooks]
 
 [settings]
 # Needs to be enabled for hooks to work
@@ -21,10 +23,3 @@ experimental = true
 [tools]
 # do not add tools unsupported on windows such: gh, yarn
 direnv = "latest"
-
-[hooks]
-# Do not use other hooks than preinstall or postinstall because they will
-# not work without 'mise activate' command, something that we do not use on CI.
-
-# Enabling corepack will install the `pnpm` package manager specified in package.json
-preinstall = "bash -c 'echo 123'"

.gitleaks.toml

@@ -1,8 +1,7 @@
 [allowlist]
-  description = "Global Allowlist"
-
-  # Ignore based on any subset of the file path
-  paths = [
-    # Ignore yarn
-    '''\.yarn''',
-  ]
+description = "Global Allowlist"
+# Ignore based on any subset of the file path
+paths = [
+  # Ignore yarn
+  '''\.yarn'''
+]

.pre-commit-config.yaml

@@ -20,6 +20,10 @@ exclude: >
   )$
 minimum_pre_commit_version: 4.0.0 # Related to https://github.com/ekalinin/nodeenv/issues/369
 repos:
+  - repo: https://github.com/pappasam/toml-sort
+    rev: v0.24.2
+    hooks:
+      - id: toml-sort-fix
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: "v0.11.6"
     hooks:
@@ -30,9 +34,6 @@ repos:
     rev: v8.17.3
     hooks:
       - id: cspell
-        args:
-          -  --config=cspell.config.yaml
-        # name: Spell check with cspell
   - repo: https://github.com/codespell-project/codespell
     rev: v2.4.1
     hooks:

.taplo.toml

@@ -0,0 +1,10 @@
+[formatting]
+# cspell: disable-next-line
+# compatibility between toml-sort-fix pre-commit hook and panekj.even-betterer-toml extension
+align_comments = false
+array_trailing_comma = false
+compact_arrays = true
+compact_entries = false
+compact_inline_tables = true
+inline_table_expand = false
+reorder_keys = true

.vscode/extensions.json

@@ -1,10 +1,11 @@
 {
   "recommendations": [
-    "DavidAnson.vscode-markdownlint",
     "charliermarsh.ruff",
+    "DavidAnson.vscode-markdownlint",
     "dbaeumer.vscode-eslint",
     "esbenp.prettier-vscode",
     "hbenl.vscode-mocha-test-adapter",
+    "tamasfe.even-better-toml",
     "timonwong.shellcheck"
   ],
   "unwantedRecommendations": ["ms-python.black-formatter"]

.vscode/settings.json

@@ -13,6 +13,9 @@
   "[typescript]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
+  "[toml]": {
+    "editor.defaultFormatter": "tamasfe.even-better-toml"
+  },
   "[shellscript]": {
     "editor.tabSize": 4
   },

pyproject.toml

@@ -9,20 +9,20 @@ skip = "out,node_modules,.mypy_cache,.ruff_cache,site,codicon.css,yarn.lock,pack
 # vscode python extension from showing errors while trying to collect tests.
 [tool.pytest.ini_options]
 norecursedirs = [
-    "*.egg",
-    ".cache",
-    ".eggs",
-    ".git",
-    ".github",
-    ".mypy_cache",
-    ".projects",
-    ".tox",
-    "build",
-    "collections",
-    "dist",
-    "docs",
-    "out",
-    "node_modules",
+  "*.egg",
+  ".cache",
+  ".eggs",
+  ".git",
+  ".github",
+  ".mypy_cache",
+  ".projects",
+  ".tox",
+  "build",
+  "collections",
+  "dist",
+  "docs",
+  "out",
+  "node_modules"
 ]
 
 [tool.ruff]
@@ -31,7 +31,14 @@ fix = true
 line-length = 100
 target-version = "py310"
 
+[tool.tomlsort]
+in_place = true
+sort_inline_tables = true
+sort_table_keys = true
+
 [tool.uv.pip]
+annotation-style = "line"
+custom-compile-command = "task -e deps"
 no-emit-package = [
   "ansible-core",
   "exceptiongroup", # <py311
@@ -44,5 +51,3 @@ no-emit-package = [
   "wheel",
   "uv"
 ]
-annotation-style = "line"
-custom-compile-command = "task -e deps"