fix(theme): yaml parsing error caused by special chars (#586)

* fix(theme): yaml parsing error caused by special chars

* chore: tweak

package.json

@@ -44,6 +44,7 @@
     "@commitlint/config-conventional": "catalog:dev",
     "@pengzhanbo/eslint-config-vue": "catalog:dev",
     "@pengzhanbo/stylelint-config": "catalog:dev",
+    "@types/js-yaml": "catalog:dev",
     "@types/less": "catalog:dev",
     "@types/lodash.merge": "catalog:dev",
     "@types/minimist": "catalog:dev",

pnpm-lock.yaml

@@ -24,6 +24,9 @@ catalogs:
     '@types/express':
       specifier: ^5.0.1
       version: 5.0.1
+    '@types/js-yaml':
+      specifier: ^4.0.9
+      version: 4.0.9
     '@types/less':
       specifier: ^3.0.8
       version: 3.0.8
@@ -227,9 +230,9 @@ catalogs:
     image-size:
       specifier: ^2.0.2
       version: 2.0.2
-    json2yaml:
-      specifier: ^1.1.0
-      version: 1.1.0
+    js-yaml:
+      specifier: ^4.1.0
+      version: 4.1.0
     katex:
       specifier: ^0.16.22
       version: 0.16.22
@@ -380,6 +383,9 @@ importers:
       '@pengzhanbo/stylelint-config':
         specifier: catalog:dev
         version: 1.30.0(stylelint@16.19.1(typescript@5.8.3))
+      '@types/js-yaml':
+        specifier: catalog:dev
+        version: 4.0.9
       '@types/less':
         specifier: catalog:dev
         version: 3.0.8
@@ -823,9 +829,9 @@ importers:
       gray-matter:
         specifier: catalog:prod
         version: 4.0.3
-      json2yaml:
+      js-yaml:
         specifier: catalog:prod
-        version: 1.1.0
+        version: 4.1.0
       katex:
         specifier: catalog:prod
         version: 0.16.22
@@ -2419,6 +2425,9 @@ packages:
   '@types/http-errors@2.0.4':
     resolution: {integrity: sha512-D0CFMMtydbJAegzOyHjtiKPLlvnm3iTZyZRSZoLq2mRhDdmLfIWOCYPfQJ4cu2erKghU++QvjcUjp/5h7hESpA==}
 
+  '@types/js-yaml@4.0.9':
+    resolution: {integrity: sha512-k4MGaQl5TGo/iipqb2UDG2UwjXziSWkh0uysQelTlJpX1qGlpUZYm8PnO4DxG1qBomtJUdYJ6qR6xdIah10JLg==}
+
   '@types/json-schema@7.0.15':
     resolution: {integrity: sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==}
 
@@ -5014,11 +5023,6 @@ packages:
   json-stable-stringify-without-jsonify@1.0.1:
     resolution: {integrity: sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==}
 
-  json2yaml@1.1.0:
-    resolution: {integrity: sha512-/xse+m0SlllfZahQrNOelmLrFNfeZv4QG0QKlvg7VsPSGIxpB3X+ggLkdffwmI1DdQ3o9XjZX+K+EOI1epdKgg==}
-    engines: {node: '>= 0.2.0'}
-    hasBin: true
-
   json5@2.2.3:
     resolution: {integrity: sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==}
     engines: {node: '>=6'}
@@ -6090,9 +6094,6 @@ packages:
   rehype-stringify@10.0.1:
     resolution: {integrity: sha512-k9ecfXHmIPuFVI61B9DeLPN0qFHfawM6RsuX48hoqlaKSF61RskNjSm1lI8PhBEM0MRdLxVVm4WmTqJQccH9mA==}
 
-  remedial@1.0.8:
-    resolution: {integrity: sha512-/62tYiOe6DzS5BqVsNpH/nkGlX45C/Sp6V+NtiN6JQNS1Viay7cWkazmRkrQrdFj2eshDe96SIQNIoMxqhzBOg==}
-
   require-directory@2.1.1:
     resolution: {integrity: sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==}
     engines: {node: '>=0.10.0'}
@@ -8898,6 +8899,8 @@ snapshots:
 
   '@types/http-errors@2.0.4': {}
 
+  '@types/js-yaml@4.0.9': {}
+
   '@types/json-schema@7.0.15': {}
 
   '@types/jsonfile@6.1.4':
@@ -11952,10 +11955,6 @@ snapshots:
 
   json-stable-stringify-without-jsonify@1.0.1: {}
 
-  json2yaml@1.1.0:
-    dependencies:
-      remedial: 1.0.8
-
   json5@2.2.3: {}
 
   jsonc-eslint-parser@2.4.0:
@@ -13213,8 +13212,6 @@ snapshots:
       hast-util-to-html: 9.0.5
       unified: 11.0.5
 
-  remedial@1.0.8: {}
-
   require-directory@2.1.1: {}
 
   require-from-string@2.0.2: {}

pnpm-workspace.yaml

@@ -19,6 +19,7 @@ catalogs:
     '@pengzhanbo/stylelint-config': ^1.30.0
     '@simonwep/pickr': ^1.9.1
     '@types/express': ^5.0.1
+    '@types/js-yaml': ^4.0.9
     '@types/less': ^3.0.8
     '@types/lodash.merge': ^4.6.9
     '@types/markdown-it': ^14.1.2
@@ -93,7 +94,7 @@ catalogs:
     gray-matter: ^4.0.3
     handlebars: ^4.7.8
     image-size: ^2.0.2
-    json2yaml: ^1.1.0
+    js-yaml: ^4.1.0
     katex: ^0.16.22
     local-pkg: ^1.1.1
     lru-cache: ^11.1.0

theme/package.json

@@ -128,7 +128,7 @@
     "esbuild": "catalog:prod",
     "fast-glob": "catalog:prod",
     "gray-matter": "catalog:prod",
-    "json2yaml": "catalog:prod",
+    "js-yaml": "catalog:prod",
     "katex": "catalog:prod",
     "local-pkg": "catalog:prod",
     "nanoid": "catalog:prod",

theme/src/node/autoFrontmatter/generator.ts

@@ -8,7 +8,7 @@ import { isArray, isEmptyObject, promiseParallel, toArray } from '@pengzhanbo/ut
 import chokidar from 'chokidar'
 import { createFilter } from 'create-filter'
 import grayMatter from 'gray-matter'
-import jsonToYaml from 'json2yaml'
+import yaml from 'js-yaml'
 import { colors, fs, hash, path } from 'vuepress/utils'
 import { getThemeConfig } from '../loadConfig/index.js'
 import { perf } from '../utils/index.js'
@@ -163,15 +163,11 @@ async function generator(file: AutoFrontmatterMarkdownFile): Promise<void> {
     return
 
   try {
-    const yaml = isEmptyObject(data)
+    const formatted = isEmptyObject(data)
       ? ''
-      : jsonToYaml
-          .stringify(data)
-          .replace(/\n\s{2}/g, '\n')
-          .replace(/"/g, '')
-          .replace(/\s+\n/g, '\n')
-    const newContent = yaml ? `${yaml}---\n${content}` : content
+      : yaml.dump(data)
 
+    const newContent = formatted ? `---\n${formatted}---\n${content}` : content
     await fs.promises.writeFile(filepath, newContent, 'utf-8')
     generate.checkCache(filepath)
   }