fix(frontmatter): prevent line wrapping as default in yaml.stringify(…

…) options
typedoc2md · Feb 15, 2025 · 42f9a60 · 42f9a60
1 parent c50eb66
commit 42f9a60
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 11 deletions.
diff --git a/.changeset/empty-dolls-explain.md b/.changeset/empty-dolls-explain.md
@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-frontmatter': patch
+---
+
+- Prevent line wrapping as default in yaml.stringify() options (#771).
diff --git a/docs/pages/plugins/frontmatter/options.mdx b/docs/pages/plugins/frontmatter/options.mdx
@@ -139,10 +139,13 @@ the `yaml.stringify` method from the [YAML](https://eemeli.org/yaml/#yaml) libra
 For available options, see
 [YAML ToString Options](https://eemeli.org/yaml/#tostring-options).
 
+Please note that `{ lineWidth: 0 }` is set by default to prevent invalid wrapping.
+
 ```json filename="typedoc.json"
 {
   "yamlStringifyOptions": {
-    "lineWidth": 0
+    "defaultStringType": "QUOTE_SINGLE",
+    "defaultKeyType": "PLAIN"
   }
 }
 ```
diff --git a/packages/typedoc-plugin-frontmatter/src/index.ts b/packages/typedoc-plugin-frontmatter/src/index.ts
@@ -66,7 +66,7 @@ export function load(app: MarkdownApplication) {
         page.contents = page?.contents
           ?.replace(
             /^/,
-            `---\n${yaml.stringify(page.frontmatter, yamlStringifyOptions)}---\n\n`,
+            `---\n${yaml.stringify(page.frontmatter, { ...yamlStringifyOptions, lineWidth: 0 })}---\n\n`,
           )
           .replace(/[\r\n]{3,}/g, '\n\n');
       }

diff --git a/packages/typedoc-plugin-frontmatter/src/options/declarations.ts b/packages/typedoc-plugin-frontmatter/src/options/declarations.ts
@@ -120,7 +120,9 @@ export const frontmatterNamingConvention: Partial<DeclarationOption> = {
  * For available options, see
  * [YAML ToString Options](https://eemeli.org/yaml/#tostring-options).
  *
- * @example { "lineWidth": 0 }
+ * Please note that `{ lineWidth: 0 }` is set by default to prevent invalid wrapping.
+ *
+ * @example {"defaultStringType": "QUOTE_SINGLE", "defaultKeyType": "PLAIN"}
  */
 export const yamlStringifyOptions: Partial<DeclarationOption> = {
   help: 'Options to pass into `yaml.stringify()`.',

diff --git a/packages/typedoc-plugin-frontmatter/test/specs/__snapshots__/options.spec.ts.snap b/packages/typedoc-plugin-frontmatter/test/specs/__snapshots__/options.spec.ts.snap
@@ -2,7 +2,8 @@
 
 exports[`Options: YAML should accept yaml stringify options 1`] = `
 "---
-veryLong: This is a long string that would normally wrap over multiple lines when the text exceeds a certain length.
+isTrue: yes
+veryLong: 'This is a long string that would normally wrap over multiple lines when the text exceeds a certain length.'
 ---
 
 # typedoc-plugin-frontmatter
@@ -31,8 +32,7 @@ exports[`Options: YAML should prepend frontmatter for readme page 1`] = `
 "---
 title: typedoc-plugin-frontmatter
 layout: blog
-veryLong: This is a long string that would normally wrap over multiple lines
-  when the text exceeds a certain length.
+veryLong: This is a long string that would normally wrap over multiple lines when the text exceeds a certain length.
 navOrder: 1
 hide: true
 onReadme: true
@@ -46,8 +46,7 @@ exports[`Options: YAML should prepend frontmatter to index page 1`] = `
 "---
 title: typedoc-plugin-frontmatter
 layout: blog
-veryLong: This is a long string that would normally wrap over multiple lines
-  when the text exceeds a certain length.
+veryLong: This is a long string that would normally wrap over multiple lines when the text exceeds a certain length.
 navOrder: 1
 hide: true
 onIndex: true
@@ -65,8 +64,7 @@ exports[`Options: YAML should prepend frontmatter with preserved tags 1`] = `
 "---
 title: SomeInterface
 layout: blog
-veryLong: This is a long string that would normally wrap over multiple lines
-  when the text exceeds a certain length.
+veryLong: This is a long string that would normally wrap over multiple lines when the text exceeds a certain length.
 navOrder: 1
 hide: true
 tagOne: 0

diff --git a/packages/typedoc-plugin-frontmatter/test/typedoc-options-3.cjs b/packages/typedoc-plugin-frontmatter/test/typedoc-options-3.cjs
@@ -9,11 +9,14 @@ module.exports = {
   hidePageHeader: true,
   hideBreadcrumbs: true,
   frontmatterGlobals: {
+    isTrue: true,
     veryLong:
       'This is a long string that would normally wrap over multiple lines when the text exceeds a certain length.',
   },
   yamlStringifyOptions: {
-    lineWidth: 0,
+    trueStr: 'yes',
+    defaultStringType: 'QUOTE_SINGLE',
+    defaultKeyType: 'PLAIN',
   },
   disableSources: true,
 };