Merge pull request #1227 from pjkaufman/swap-to-yaml

Swap to from `js-yaml` to `yaml` for Parsing YAML

Author: pjkaufman

__tests__/yaml-key-sort.test.ts

@@ -199,5 +199,165 @@ ruleTest({
         ],
       },
     },
+    { // accounts for https://github.com/platers/obsidian-linter/issues/1082
+      testName: 'Make sure that literal operator `|` is handled correctly',
+      before: dedent`
+        ---
+        sorting-spec: |
+          order-desc: a-z
+        first: alphabetical
+        ---
+      `,
+      after: dedent`
+        ---
+        first: alphabetical
+        sorting-spec: |
+          order-desc: a-z
+        ---
+      `,
+      options: {
+        yamlKeyPrioritySortOrder: [
+          'first',
+          'sorting-spec:',
+        ],
+      },
+    },
+    { // accounts for https://github.com/platers/obsidian-linter/issues/912
+      testName: 'Make sure that lots of nesting does not get broken',
+      before: dedent`
+        ---
+        AAA:
+          - BBB: x
+            CCC: x
+          - DDD: x
+            EEE: x
+            FFF:
+              - GGG: x
+              - HHH
+            III: x
+        FFF:
+          -${' '}
+        ---
+      `,
+      after: dedent`
+        ---
+        AAA:
+          - BBB: x
+            CCC: x
+          - DDD: x
+            EEE: x
+            FFF:
+              - GGG: x
+              - HHH
+            III: x
+        FFF:
+          -${' '}
+        ---
+      `, // note that this does look wonky, but it works the same in Obsidian, so I am going to consider this fine for now
+      // see https://github.com/eemeli/yaml/issues/590 for more information on this
+      options: {
+        yamlSortOrderForOtherKeys: 'Ascending Alphabetical',
+      },
+    },
+    { // accounts for https://github.com/platers/obsidian-linter/issues/660
+      testName: 'Make sure that comments are not removed when sorting',
+      before: dedent`
+        ---
+        created: 2023-02-18T10:53:01+00:00
+        # Dont remove me
+        disabled rules: [capitalize-headings]
+        modified: 2023-03-20T14:53:42+00:00
+        ---
+      `,
+      after: dedent`
+        ---
+        created: 2023-02-18T10:53:01+00:00
+        # Dont remove me
+        disabled rules: [capitalize-headings]
+        modified: 2023-03-20T14:53:42+00:00
+        ---
+      `,
+      options: {
+        yamlSortOrderForOtherKeys: 'Ascending Alphabetical',
+      },
+    },
+    { // accounts for https://github.com/platers/obsidian-linter/issues/660
+      testName: 'Make sure that scalars are not removed when sorting',
+      before: dedent`
+        ---
+        name: John
+        husband: Tim
+        biography: |
+          A very nice chap. A very nice chap. A very nice chap. A very nice chap. A very nice chap. A very nice chap. A very nice chap. A very nice chap.
+        ---
+      `,
+      after: dedent`
+        ---
+        biography: |
+          A very nice chap. A very nice chap. A very nice chap. A very nice chap. A very nice chap. A very nice chap. A very nice chap. A very nice chap.
+        husband: Tim
+        name: John
+        ---
+      `,
+      options: {
+        yamlSortOrderForOtherKeys: 'Ascending Alphabetical',
+      },
+    },
+    { // accounts for https://github.com/platers/obsidian-linter/issues/1258
+      testName: 'Make sure that folded block scalars are not broken up when sorting',
+      before: dedent`
+        ---
+        aliases: []
+        tags:
+          - media/podcast/episode
+        description: >-
+          Follow our ad-free Rain Playlist here:
+        image: 'https://i.scdn.co/image/ab6765630000ba8a8d796ac81fdad1d895dd28a1'
+        links:
+          - https://open.spotify.com/episode/1LSnoZVPWB8ynOCMCwKw5S
+        showName: ASMR Rain Recordings
+        created: 11-05-2024 21:09
+        updated: 13-01-2025 08:16
+        ---
+      `,
+      after: dedent`
+        ---
+        aliases: []
+        created: 11-05-2024 21:09
+        description: >-
+          Follow our ad-free Rain Playlist here:
+        image: 'https://i.scdn.co/image/ab6765630000ba8a8d796ac81fdad1d895dd28a1'
+        links:
+          - https://open.spotify.com/episode/1LSnoZVPWB8ynOCMCwKw5S
+        showName: ASMR Rain Recordings
+        tags:
+          - media/podcast/episode
+        updated: 13-01-2025 08:16
+        ---
+      `,
+      options: {
+        yamlSortOrderForOtherKeys: 'Ascending Alphabetical',
+      },
+    },
+    { // accounts for https://github.com/platers/obsidian-linter/issues/660
+      testName: 'Make sure that comments on an array do not cause issues when sorting',
+      before: dedent`
+        ---
+        Ingredients: # [\`<free text for ingredient>\`,\`<amount>\`, \`<unit>\`, \`<form>\`, \`<note>\`]
+          - [Watermelon, 80 g, cubed, note]
+          - [sugar, 20 g]
+        ---
+      `,
+      after: dedent`
+        ---
+        Ingredients: # [\`<free text for ingredient>\`,\`<amount>\`, \`<unit>\`, \`<form>\`, \`<note>\`]
+          - [Watermelon, 80 g, cubed, note]
+          - [sugar, 20 g]
+        ---
+      `,
+      options: {
+        yamlSortOrderForOtherKeys: 'Ascending Alphabetical',
+      },
+    },
   ],
 });

package-lock.json

@@ -31,7 +31,6 @@
     "@types/diff": "^5.0.9",
     "@types/diff-match-patch": "^1.0.32",
     "@types/jest": "^29.5.12",
-    "@types/js-yaml": "^4.0.5",
     "@types/node": "^20.11.28",
     "@typescript-eslint/eslint-plugin": "^7.2.0",
     "@typescript-eslint/parser": "^7.2.0",
@@ -61,7 +60,6 @@
     "@popperjs/core": "^2.11.6",
     "async-lock": "^1.4.1",
     "diff-match-patch": "^1.0.5",
-    "js-yaml": "^4.1.0",
     "loglevel": "^1.9.1",
     "mdast-util-from-markdown": "^2.0.0",
     "mdast-util-frontmatter": "^2.0.1",
@@ -75,6 +73,7 @@
     "moment-parseformat": "^4.0.0",
     "quick-lru": "^7.0.0",
     "ts-dedent": "^2.2.0",
-    "unist-util-visit": "^5.0.0"
+    "unist-util-visit": "^5.0.0",
+    "yaml": "^2.7.0"
   }
 }