Run markdown files through Prettier (#292)

Author: glennj

.github/workflows/run-configlet-sync.yml

@@ -3,7 +3,7 @@ name: Run Configlet Sync
 on:
   workflow_dispatch:
   schedule:
-    - cron: '0 0 15 * *'
+    - cron: "0 0 15 * *"
 
 jobs:
   call-gha-workflow:

.prettierignore

@@ -2,12 +2,18 @@
 # - install it in the track root dir: `npm install prettier`
 #   - note the .gitignore file
 # - check the status without writing changes: `npx prettier --check .`
-# - the above, verbosely: `npx prettier --check --loglevel debug .`
+# - the above, verbosely: `npx prettier --check --log-level debug .`
 # - preview the changes: (using https://dandavison.github.io/delta/)
 #   - fish: `set f some.file; delta $f (npx prettier $f | psub)`
 #   - bash: `f="some.file"; delta "$f" <(npx prettier "$f")`
 # - write the changes: `npx prettier --write .`
 
+# prettier wants to convert exercism markdown admonition blocks to code fences.
+#    from:     ~~~~exercism/note
+#    to:       ```exercism/note
+# I don't know how to configure this behaviour away.
+# Don't write those changes into git.
+
 # ignore files written by configlet or Exercism org-wide files
 exercises/practice/*/.meta/config.json
 exercises/practice/*/.docs/instructions.md
@@ -17,3 +23,6 @@ CODE_OF_CONDUCT.md
 generate_tests.json
 .github/pull_request_template.md
 exercises/concept/*/.meta/config.json
+config.json
+exercises/practice/*/.docs/introduction.md
+exercises/practice/*/.docs/instructions.md

concepts/basics/about.md

@@ -340,7 +340,6 @@ Without going into great depth (functions will be a topic for another exercise),
 - [`select`][man-select]
 
   Given _some_ input and a filter as an argument:
-
   - if the filter applied to the argument results in a _true_ value, output the input unchanged
   - otherwise, output _nothing_ (not the `null` value, truly no output)
 
@@ -362,7 +361,6 @@ Without going into great depth (functions will be a topic for another exercise),
   There are a couple of ways to do this.
 
   With the input `["Anne", "Bob", "Cathy", "Dave"]`, select the names having length 4.
-
   - use `map` and `select` together
 
     ```jq

concepts/basics/introduction.md

@@ -290,7 +290,6 @@ Without going into great depth (functions will be a topic for another exercise),
 - `select`
 
   Given _some_ input and a filter as an argument:
-
   - if the filter applied to the argument results in a _true_ value, output the input unchanged
   - otherwise, output _nothing_ (not the `null` value, truly no output)
 
@@ -312,7 +311,6 @@ Without going into great depth (functions will be a topic for another exercise),
   There are a couple of ways to do this.
 
   With the input `["Anne", "Bob", "Cathy", "Dave"]`, select the names having length 4.
-
   - use `map` and `select` together
 
     ```jq

concepts/conditionals/about.md

@@ -27,7 +27,7 @@ if A then B else . end
 if A then B end
 ```
 
-The `else` clause is **mandatory** in the previous v1.6 release. 
+The `else` clause is **mandatory** in the previous v1.6 release.
 Omitting it produces errors.
 
 ```sh

concepts/conditionals/introduction.md

@@ -27,7 +27,7 @@ if A then B else . end
 if A then B end
 ```
 
-The `else` clause is **mandatory** in the previous v1.6 release. 
+The `else` clause is **mandatory** in the previous v1.6 release.
 ~~~~
 
 ## Nested If-Statements

docs/DEBUGGING.md

@@ -10,49 +10,48 @@ The second element depends on how you invoke `debug`.
 
 1. the zero-arity debug function puts a compact representation of the input into the debug array:
 
-    ```sh
-    jq -n '[11, 22, 33] | debug | map(. * 2)'
-    ```
+   ```sh
+   jq -n '[11, 22, 33] | debug | map(. * 2)'
+   ```
 
-    outputs
+   outputs
 
-    ```none
-     ["DEBUG:",[11,22,33]]
-     [
-       22,
-       44,
-       66
-     ]
-    ```
+   ```none
+    ["DEBUG:",[11,22,33]]
+    [
+      22,
+      44,
+      66
+    ]
+   ```
 
 2. the one-arity version pipes the input through the given filter:
 
-    ```sh
-    jq -n '[11, 22, 33] | debug("length: \(length), last: \(.[-1])") | map(. * 2)'
-    ```
-
-    ```none
-     ["DEBUG:","length: 3, last: 33"]
-     [
-       22,
-       44,
-       66
-     ]
-    ```
-
-    The filter doesn't need to be a string.
-    It can be anything, including multiple comma-separated expressions for "multi-line" debug output:
-
-    ```sh
-    jq -n '[11, 22, 33] as $a | 44 | debug("I am here:", $a, .)'
-    ```
-
-    ```none
-    ["DEBUG:","I am here:"]
-    ["DEBUG:",[11,22,33]]
-    ["DEBUG:",44]
-    44
-    ```
-
+   ```sh
+   jq -n '[11, 22, 33] | debug("length: \(length), last: \(.[-1])") | map(. * 2)'
+   ```
+
+   ```none
+    ["DEBUG:","length: 3, last: 33"]
+    [
+      22,
+      44,
+      66
+    ]
+   ```
+
+   The filter doesn't need to be a string.
+   It can be anything, including multiple comma-separated expressions for "multi-line" debug output:
+
+   ```sh
+   jq -n '[11, 22, 33] as $a | 44 | debug("I am here:", $a, .)'
+   ```
+
+   ```none
+   ["DEBUG:","I am here:"]
+   ["DEBUG:",[11,22,33]]
+   ["DEBUG:",44]
+   44
+   ```
 
 [debug]: https://jqlang.github.io/jq/manual/#debug

exercises/concept/shopping/.docs/introduction.md

@@ -292,7 +292,6 @@ Without going into great depth (functions will be a topic for another exercise),
 - `select`
 
   Given _some_ input and a filter as an argument:
-
   - if the filter applied to the argument results in a _true_ value, output the input unchanged
   - otherwise, output _nothing_ (not the `null` value, truly no output)
 
@@ -314,7 +313,6 @@ Without going into great depth (functions will be a topic for another exercise),
   There are a couple of ways to do this.
 
   With the input `["Anne", "Bob", "Cathy", "Dave"]`, select the names having length 4.
-
   - use `map` and `select` together
 
     ```jq

exercises/concept/vehicle-purchase/.docs/introduction.md

@@ -109,7 +109,7 @@ if A then B else . end
 if A then B end
 ```
 
-The `else` clause is **mandatory** in the previous v1.6 release. 
+The `else` clause is **mandatory** in the previous v1.6 release.
 ~~~~
 
 ### Nested If-Statements

exercises/practice/flatten-array/.docs/instructions.append.md

@@ -7,9 +7,9 @@ Try to solve this yourself without using the builtin `flatten` function to get t
 
 <details><summary>Click here for hints:</summary>
 
-* A recursive function can be useful.
+- A recursive function can be useful.
   Learn more about recursion in the [Recursion lesson][recur].
-* The [`type`][type] function can help.
+- The [`type`][type] function can help.
 </details>
 
 [flatten]: https://jqlang.github.io/jq/manual/v1.7/#flatten