feat: enable prettier for scenarios (#212)

.github/workflows/check.yaml

@@ -33,6 +33,11 @@ jobs:
       - name: Check Python formatting
         run: uvx ruff format --check .  --config pyproject.toml
 
+      - name: Check Scenarios formatting
+        run: |
+          npm ci
+          npx prettier --check "scenarios/**/*.{toml,json,yaml}"
+
   typos:
     runs-on: ubuntu-latest
     name: Check typos

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "plugins": ["prettier-plugin-toml"]
+}

CONTRIBUTING.md

@@ -42,3 +42,12 @@ manually back out the change. See [this comment][index-incorrect-snapshot] for
 an example.
 
 [index-incorrect-snapshot]: https://github.com/astral-sh/packse/pull/175#issuecomment-2056964089
+
+## Formatting Scenarios
+
+This step requires NodeJS installed.
+
+```
+npm install
+npx prettier --write "scenarios/**/*.{toml,json,yaml}"
+```

package.json

@@ -0,0 +1,6 @@
+{
+  "devDependencies": {
+    "prettier": "^3.3.3",
+    "prettier-plugin-toml": "^2.0.1"
+  }
+}

scenarios/examples/example.json

@@ -1,39 +1,33 @@
 {
-    "name": "example",
-    "description": "This is an example scenario, in which the user depends on a single package `a` which requires `b`.",
-    "expected": {
-        "satisfiable": true,
-        "packages": {
-            "a": "1.0.0",
-            "b": "2.0.0"
-        },
-        "explanation": "The latest valid version of `b` should be installed. `b==3.0.0` is not valid because it requires `c` which does not exist."
+  "name": "example",
+  "description": "This is an example scenario, in which the user depends on a single package `a` which requires `b`.",
+  "expected": {
+    "satisfiable": true,
+    "packages": {
+      "a": "1.0.0",
+      "b": "2.0.0"
     },
-    "root": {
-        "requires": [
-            "a"
-        ]
+    "explanation": "The latest valid version of `b` should be installed. `b==3.0.0` is not valid because it requires `c` which does not exist."
+  },
+  "root": {
+    "requires": ["a"]
+  },
+  "packages": {
+    "a": {
+      "versions": {
+        "1.0.0": {
+          "requires": ["b>1.0.0"]
+        }
+      }
     },
-    "packages": {
-        "a": {
-            "versions": {
-                "1.0.0": {
-                    "requires": [
-                        "b>1.0.0"
-                    ]
-                }
-            }
-        },
-        "b": {
-            "versions": {
-                "1.0.0": {},
-                "2.0.0": {},
-                "3.0.0": {
-                    "requires": [
-                        "c"
-                    ]
-                }
-            }
+    "b": {
+      "versions": {
+        "1.0.0": {},
+        "2.0.0": {},
+        "3.0.0": {
+          "requires": ["c"]
         }
+      }
     }
+  }
 }

scenarios/examples/example.toml

@@ -5,19 +5,19 @@ description = "This is an example scenario written in TOML, in which the user de
 satisfiable = true
 explanation = "The latest valid version of `b` should be installed. `b==3.0.0` is not valid because it requires `c` which does not exist."
 
-  [expected.packages]
-  a = "1.0.0"
-  b = "2.0.0"
+[expected.packages]
+a = "1.0.0"
+b = "2.0.0"
 
 [root]
-requires = [ "a" ]
+requires = ["a"]
 
 [packages.a.versions."1.0.0"]
-requires = [ "b>1.0.0" ]
+requires = ["b>1.0.0"]
 
 [packages.b.versions]
-"1.0.0" = { }
-"2.0.0" = { }
+"1.0.0" = {}
+"2.0.0" = {}
 
-  [packages.b.versions."3.0.0"]
-  requires = [ "c" ]
+[packages.b.versions."3.0.0"]
+requires = ["c"]

scenarios/examples/example.yaml

@@ -1,26 +1,28 @@
 - name: example-yaml
-  description: This is an example scenario written in YAML, in which the user depends on a single
-    package `a` which requires `b`.
+  description:
+    This is an example scenario written in YAML, in which the user depends on a
+    single package `a` which requires `b`.
   expected:
     satisfiable: true
     packages:
       a: 1.0.0
       b: 2.0.0
-    explanation: The latest valid version of `b` should be installed. `b==3.0.0` is
-      not valid because it requires `c` which does not exist.
+    explanation:
+      The latest valid version of `b` should be installed. `b==3.0.0` is not
+      valid because it requires `c` which does not exist.
   root:
     requires:
-    - a
+      - a
   packages:
     a:
       versions:
         1.0.0:
           requires:
-          - b>1.0.0
+            - b>1.0.0
     b:
       versions:
         1.0.0: {}
         2.0.0: {}
         3.0.0:
           requires:
-          - c
+            - c