Format using prettier (#1917)

Format using prettier

Author: ErikSchierboom

.github/workflow-tests/immutability-check/canonical-data-changed-scenarios-after.json

@@ -69,7 +69,7 @@
           "uuid": "0f998f19-69ee-4c64-80ef-01b086feab80",
           "description": "Imaginary part of a number with real and imaginary part",
           "property": "imaginary",
-          "input":  {
+          "input": {
             "z": [1, 2]
           },
           "expected": 2
@@ -331,7 +331,7 @@
           "uuid": "6d96d4c6-2edb-445b-94a2-7de6d4caaf60",
           "description": "Euler's identity/formula",
           "property": "exp",
-          "input":  {
+          "input": {
             "z": [0, "pi"]
           },
           "expected": [-1, 0]

.github/workflow-tests/immutability-check/canonical-data-changed-scenarios-before.json

@@ -69,7 +69,7 @@
           "uuid": "0f998f19-69ee-4c64-80ef-01b086feab80",
           "description": "Imaginary part of a number with real and imaginary part",
           "property": "imaginary",
-          "input":  {
+          "input": {
             "z": [1, 2]
           },
           "expected": 2
@@ -331,7 +331,7 @@
           "uuid": "6d96d4c6-2edb-445b-94a2-7de6d4caaf60",
           "description": "Euler's identity/formula",
           "property": "exp",
-          "input":  {
+          "input": {
             "z": [0, "pi"]
           },
           "expected": [-1, 0]

.github/workflow-tests/immutability-check/canonical-data-deleted-case.json

@@ -59,7 +59,7 @@
           "uuid": "0f998f19-69ee-4c64-80ef-01b086feab80",
           "description": "Imaginary part of a number with real and imaginary part",
           "property": "imaginary",
-          "input":  {
+          "input": {
             "z": [1, 2]
           },
           "expected": 2
@@ -321,7 +321,7 @@
           "uuid": "6d96d4c6-2edb-445b-94a2-7de6d4caaf60",
           "description": "Euler's identity/formula",
           "property": "exp",
-          "input":  {
+          "input": {
             "z": [0, "pi"]
           },
           "expected": [-1, 0]

.github/workflow-tests/immutability-check/canonical-data-mutated-and-deleted.json

@@ -68,7 +68,7 @@
           "uuid": "0f998f19-69ee-4c64-80ef-01b086feab80",
           "description": "Imaginary part of a number with real and imaginary part",
           "property": "imaginary",
-          "input":  {
+          "input": {
             "z": [1, 2]
           },
           "expected": 2
@@ -320,7 +320,7 @@
           "uuid": "6d96d4c6-2edb-445b-94a2-7de6d4caaf60",
           "description": "Euler's identity/formula",
           "property": "exp",
-          "input":  {
+          "input": {
             "z": [0, "pi"]
           },
           "expected": [-1, 0]

.github/workflow-tests/immutability-check/canonical-data-mutated.json

@@ -68,7 +68,7 @@
           "uuid": "0f998f19-69ee-4c64-80ef-01b086feab80",
           "description": "Imaginary part of a number with real and imaginary part",
           "property": "imaginary",
-          "input":  {
+          "input": {
             "z": [1, 2]
           },
           "expected": 2
@@ -330,7 +330,7 @@
           "uuid": "6d96d4c6-2edb-445b-94a2-7de6d4caaf60",
           "description": "Euler's identity/formula",
           "property": "exp",
-          "input":  {
+          "input": {
             "z": [0, "pi"]
           },
           "expected": [-1, 0]

.github/workflow-tests/immutability-check/canonical-data-new-test.json

@@ -77,7 +77,7 @@
           "uuid": "0f998f19-69ee-4c64-80ef-01b086feab80",
           "description": "Imaginary part of a number with real and imaginary part",
           "property": "imaginary",
-          "input":  {
+          "input": {
             "z": [1, 2]
           },
           "expected": 2
@@ -339,7 +339,7 @@
           "uuid": "6d96d4c6-2edb-445b-94a2-7de6d4caaf60",
           "description": "Euler's identity/formula",
           "property": "exp",
-          "input":  {
+          "input": {
             "z": [0, "pi"]
           },
           "expected": [-1, 0]

.github/workflow-tests/immutability-check/canonical-data.json

@@ -68,7 +68,7 @@
           "uuid": "0f998f19-69ee-4c64-80ef-01b086feab80",
           "description": "Imaginary part of a number with real and imaginary part",
           "property": "imaginary",
-          "input":  {
+          "input": {
             "z": [1, 2]
           },
           "expected": 2
@@ -330,7 +330,7 @@
           "uuid": "6d96d4c6-2edb-445b-94a2-7de6d4caaf60",
           "description": "Euler's identity/formula",
           "property": "exp",
-          "input":  {
+          "input": {
             "z": [0, "pi"]
           },
           "expected": [-1, 0]

.github/workflows/ci.yml

@@ -126,3 +126,28 @@ jobs:
         with:
           globs: |
             **/*.md
+
+  json-lint:
+    name: Lint json files
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - name: Cache yarn
+        uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed
+        id: yarn-cache
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Verify that json files are formatted correctly
+        run: yarn test-json-formatting

.prettierignore

@@ -0,0 +1,33 @@
+exercises/allergies/canonical-data.json
+exercises/book-store/canonical-data.json
+exercises/bowling/canonical-data.json
+exercises/change/canonical-data.json
+exercises/connect/canonical-data.json
+exercises/diamond/canonical-data.json
+exercises/dominoes/canonical-data.json
+exercises/flatten-array/canonical-data.json
+exercises/forth/canonical-data.json
+exercises/go-counting/canonical-data.json
+exercises/grep/canonical-data.json
+exercises/house/canonical-data.json
+exercises/kindergarten-garden/canonical-data.json
+exercises/knapsack/canonical-data.json
+exercises/markdown/canonical-data.json
+exercises/minesweeper/canonical-data.json
+exercises/ocr-numbers/canonical-data.json
+exercises/pascals-triangle/canonical-data.json
+exercises/poker/canonical-data.json
+exercises/pov/canonical-data.json
+exercises/pythagorean-triplet/canonical-data.json
+exercises/rectangles/canonical-data.json
+exercises/reverse-string/canonical-data.json
+exercises/roman-numerals/canonical-data.json
+exercises/rotational-cipher/canonical-data.json
+exercises/saddle-points/canonical-data.json
+exercises/scale-generator/canonical-data.json
+exercises/sieve/canonical-data.json
+exercises/spiral-matrix/canonical-data.json
+exercises/tournament/canonical-data.json
+exercises/transpose/canonical-data.json
+exercises/variable-length-quantity/canonical-data.json
+exercises/word-search/canonical-data.json

CONTRIBUTING.md

@@ -22,13 +22,14 @@ This guide covers several common scenarios pertaining to **improving the languag
 * [Track Anatomy](#track-anatomy)
 * [Starting a New Track](#starting-a-new-track)
   * [Beta-Testing a Language Track](#beta-testing-a-language-track)
-* [Useful Tidbits](#useful-tidbits)
+* [Useful Tidbits](#useful-tidbits)  
   * [Pull Request Guidelines](#pull-request-guidelines)
   * [Anatomy of an Exercise](#anatomy-of-an-exercise)
   * [Track configuration file (config.json)](#track-configuration-file)
   * [Track-Level Linting With Configlet](#track-level-linting-with-configlet)
   * [Git Basics](#git-basics)
   * [Improving Consistency By Extracting Shared Test Data](#improving-consistency-by-extracting-shared-test-data)
+  * [Formatting](#formatting)
 
 ## We Will Gladly Help You Help Us
 
@@ -301,6 +302,18 @@ TODO: add more sections:
 
 We are maintaining this section, since many open issues link to it.
 
+## Formatting
+
+This repository uses [prettier][prettier] to automatically format its JSON files.
+If you've added or modified a JSON file, you can format it using:
+
+```shell
+yarn install
+yarn format-json
+```
+
+Note: if you use VS Code as your editor, you can install the [prettier plugin][prettier-vs-code] to automatically handle formatting for you.
+
 [contributing]: https://exercism.org/contributing
 [support-chat]: https://gitter.im/exercism/support
 [exercism-issues]: https://github.com/exercism/exercism/issues
@@ -322,3 +335,5 @@ We are maintaining this section, since many open issues link to it.
 [git-basics]: https://github.com/exercism/legacy-docs/blob/main/contributing/git-basics.md
 [improve-exercise-metadata]: https://github.com/exercism/legacy-docs/blob/main/you-can-help/improve-exercise-metadata.md
 [legacy-docs]: https://github.com/exercism/legacy-docs
+[prettier]: https://prettier.io/
+[prettier-vs-code]: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode