docs: optimize line breaks in default objects (#3190)

faker-js · Oct 23, 2024 · c6e52e5 · c6e52e5
1 parent d5e697d
commit c6e52e5
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/scripts/apidocs/processing/jsdocs.ts b/scripts/apidocs/processing/jsdocs.ts
@@ -50,7 +50,11 @@ export function getParameterTags(jsdocs: JSDoc): Record<string, JSDocTag> {
 }
 
 export function getDefault(jsdocs: JSDoc): string | undefined {
-  return getOptionalTagFromJSDoc(jsdocs, `default`);
+  return (
+    getOptionalTagFromJSDoc(jsdocs, `default`)
+      // Prevent line breaks between the key and the value { foo: 'bar' }
+      ?.replaceAll(': ', ': ')
+  );
 }
 
 export function getThrows(jsdocs: JSDoc): string[] {