lichess-org · ornicar · Feb 27, 2025 · Feb 22, 2025 · Feb 22, 2025 · Feb 22, 2025
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -0,0 +1,2 @@
+# Initial prettier formatting
+d3e7a4379f6a3e5a94fc1e75cf3024c53acbb4ac
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -10,13 +10,14 @@ jobs:
       run:
         working-directory: doc
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
-      with:
-        node-version: 22
-    - uses: pnpm/action-setup@v4
-      with:
-        run_install: true
-        package_json_file: doc/package.json
-    - run: pnpm spectral
-    - run: pnpm lint
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - uses: pnpm/action-setup@v4
+        with:
+          run_install: true
+          package_json_file: doc/package.json
+      - run: pnpm spectral
+      - run: pnpm lint
+      - run: pnpm check-format
diff --git a/README.md b/README.md
@@ -22,3 +22,9 @@ Make modifications to `doc/specs/lichess-api.yaml`, and reload the page to see y
 pnpm spectral
 pnpm lint
 ```
+
+### Format the yaml files
+
+```shell
+pnpm format
+```
diff --git a/doc/.prettierignore b/doc/.prettierignore
@@ -0,0 +1 @@
+pnpm-lock.yaml
diff --git a/doc/.prettierrc.json b/doc/.prettierrc.json
@@ -0,0 +1,3 @@
+{
+  "printWidth": 120
+}
diff --git a/doc/package.json b/doc/package.json
@@ -6,13 +6,16 @@
   "devDependencies": {
     "@redocly/cli": "^1.27.2",
     "@stoplight/spectral-cli": "^6.14.2",
-    "@stoplight/spectral-rulesets": "1.18.1"
+    "@stoplight/spectral-rulesets": "1.18.1",
+    "prettier": "3.5.2"
   },
   "scripts": {
     "spectral": "spectral lint --fail-severity=warn specs/*.yaml",
     "lint": "redocly lint specs/lichess-api.yaml",
     "bundle": "redocly bundle specs/lichess-api.yaml --output public/openapi.yaml",
     "build": "redocly build-docs specs/lichess-api.yaml --output public/index.html",
-    "serve": "redocly preview-docs specs/lichess-api.yaml --port 8089"
+    "serve": "redocly preview-docs specs/lichess-api.yaml --port 8089",
+    "format": "prettier . --write",
+    "check-format": "prettier . --check"
   }
 }
diff --git a/doc/pnpm-lock.yaml b/doc/pnpm-lock.yaml
diff --git a/doc/specs/examples/tvFeedFen.yaml b/doc/specs/examples/tvFeedFen.yaml
@@ -1,5 +1,5 @@
 value:
   {
-    't': 'fen',
-    'd': { 'fen': '5rk1/6p1/p4q2/4p3/2p5/2P2bNQ/PP3P1P/1K1RR3 w - - 4 32', 'lm': 'h8g8', 'wc': 14, 'bc': 30 },
+    "t": "fen",
+    "d": { "fen": "5rk1/6p1/p4q2/4p3/2p5/2P2bNQ/PP3P1P/1K1RR3 w - - 4 32", "lm": "h8g8", "wc": 14, "bc": 30 },
   }
diff --git a/doc/specs/examples/tvFeedFirst.yaml b/doc/specs/examples/tvFeedFirst.yaml
@@ -1,25 +1,25 @@
 value:
   {
-    't': 'featured',
-    'd':
+    "t": "featured",
+    "d":
       {
-        'id': 'qVSOPtMc',
-        'orientation': 'black',
-        'players':
+        "id": "qVSOPtMc",
+        "orientation": "black",
+        "players":
           [
             {
-              'color': 'white',
-              'user': { 'name': 'lizen9', 'id': 'lizen9', 'title': 'GM' },
-              'rating': 2531,
-              'seconds': 60,
+              "color": "white",
+              "user": { "name": "lizen9", "id": "lizen9", "title": "GM" },
+              "rating": 2531,
+              "seconds": 60,
             },
             {
-              'color': 'black',
-              'user': { 'name': 'lizen29', 'title': 'WGM', 'id': 'lizen29' },
-              'rating': 2594,
-              'seconds': 60,
+              "color": "black",
+              "user": { "name": "lizen29", "title": "WGM", "id": "lizen29" },
+              "rating": 2594,
+              "seconds": 60,
             },
           ],
-        'fen': 'rnbqk1r1/ppp1ppbp/8/N2p2p1/8/1PQPP3/P1P2PPn/R1B1K1NR',
+        "fen": "rnbqk1r1/ppp1ppbp/8/N2p2p1/8/1PQPP3/P1P2PPn/R1B1K1NR",
       },
   }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# Initial prettier formatting
		d3e7a4379f6a3e5a94fc1e75cf3024c53acbb4ac