Skip to content

Format using prettier #1917

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 58 commits into from
Feb 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
2d45a33
affine-cipher: format
ErikSchierboom Jan 13, 2022
50ec8c7
all-your-base: format
ErikSchierboom Jan 13, 2022
cd67821
alphametics: format
ErikSchierboom Jan 13, 2022
2c7fe52
atbash-cipher: format
ErikSchierboom Jan 13, 2022
d2da698
binary-search: format
ErikSchierboom Jan 13, 2022
c46ce29
binary-search-tree: format
ErikSchierboom Jan 13, 2022
9a8fb23
book-store: format
ErikSchierboom Jan 13, 2022
b1e82d4
bowling: format
ErikSchierboom Jan 13, 2022
2244130
change: format
ErikSchierboom Jan 13, 2022
171fd22
complex-numbers: format
ErikSchierboom Jan 13, 2022
81f4367
diamond: format
ErikSchierboom Jan 13, 2022
7e2bc92
diffie-hellman: format
ErikSchierboom Jan 13, 2022
fdb8ee3
etl: format
ErikSchierboom Jan 13, 2022
3dce8e3
grade-school: format
ErikSchierboom Jan 13, 2022
4c1dfb3
grains: format
ErikSchierboom Jan 13, 2022
7a63292
hamming: format
ErikSchierboom Jan 13, 2022
b2431e6
high-scores: format
ErikSchierboom Jan 13, 2022
37ddc8c
isbn-verifier: format
ErikSchierboom Jan 13, 2022
4e20fd5
isogram: format
ErikSchierboom Jan 13, 2022
cca24e4
largest-series-product: format
ErikSchierboom Jan 13, 2022
8c3ab85
luhn: format
ErikSchierboom Jan 13, 2022
ed4fdd2
markdown: format
ErikSchierboom Jan 13, 2022
5f93925
palindrome-products: format
ErikSchierboom Jan 13, 2022
53597c5
perfect-numbers: format
ErikSchierboom Jan 13, 2022
38bf8f4
phone-number: format
ErikSchierboom Jan 13, 2022
4090026
prime-factors: format
ErikSchierboom Jan 13, 2022
716802d
protein-translation: format
ErikSchierboom Jan 13, 2022
9110420
proverb: format
ErikSchierboom Jan 13, 2022
c7b2a09
pythagorean-triplets: format
ErikSchierboom Jan 13, 2022
d379164
yacht: format
ErikSchierboom Jan 13, 2022
9082e33
say: format
ErikSchierboom Jan 13, 2022
822c9c5
satellite: format
ErikSchierboom Jan 13, 2022
3484902
resistor-color: format
ErikSchierboom Jan 13, 2022
e30af26
rest-api: format
ErikSchierboom Jan 13, 2022
27e861f
reverse-string: format
ErikSchierboom Jan 13, 2022
26566b2
robot-simulator: format
ErikSchierboom Jan 13, 2022
1e82c20
roman-numerals: format
ErikSchierboom Jan 13, 2022
13108aa
scale-generator: format
ErikSchierboom Jan 13, 2022
afa5cec
series: format
ErikSchierboom Jan 13, 2022
9083cd1
sgf-parsing: format
ErikSchierboom Jan 13, 2022
4edc136
simple-cipher: format
ErikSchierboom Jan 13, 2022
d9856f8
space-age: format
ErikSchierboom Jan 13, 2022
0d72ce4
spiral-matirx: format
ErikSchierboom Jan 13, 2022
5f7616e
tournament: format
ErikSchierboom Jan 13, 2022
3e4e9c9
variable-length-quantity: format
ErikSchierboom Jan 13, 2022
131d573
word-search: format
ErikSchierboom Jan 13, 2022
510e72e
wordy: format
ErikSchierboom Jan 13, 2022
387594c
Apply review comments
ErikSchierboom Jan 14, 2022
7c78d2c
Fix error expected value indentation
ErikSchierboom Jan 14, 2022
83c1467
bowling: use consistent array formatting
ErikSchierboom Jan 19, 2022
9725d3f
scale-generator: use consistent array formatting
ErikSchierboom Jan 19, 2022
2b786c0
word-search: use consistent array formatting
ErikSchierboom Jan 19, 2022
dd229f5
Ignore manually formatted files
ErikSchierboom Jan 25, 2022
6ee1de2
Format non-exercise JSON files
ErikSchierboom Jan 25, 2022
467b34b
Allow testing of formatting
ErikSchierboom Jan 25, 2022
2be235c
Add CI to formatting
ErikSchierboom Jan 25, 2022
ddfc0f9
Add command to format JSON
ErikSchierboom Feb 1, 2022
fbd495f
Add documentation on how to format JSON
ErikSchierboom Feb 1, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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]
Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
33 changes: 33 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -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
17 changes: 16 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,9 @@ The file format is described in [canonical-data.schema.json](./canonical-data.sc
"firstName": "HAL",
"lastName": "9000"
},
"expected": { "error": "You should never bar a number" }
"expected": {
"error": "You should never bar a number"
}
}
]
}
Expand Down
Loading