[api-docs-builder] Preserve multiline prop descriptions with `rawDesc…

…riptions` option (#44737)
mui · Dec 11, 2024 · 6b5d751 · 6b5d751
1 parent 2a8ba74
commit 6b5d751
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/packages/api-docs-builder/buildApi.ts b/packages/api-docs-builder/buildApi.ts
@@ -224,6 +224,9 @@ export function escapeEntities(value: string) {
 export function escapeCell(value: string) {
   return rawDescriptionsCurrent ? value : _escapeCell(value);
 }
+export function removeNewLines(value: string) {
+  return rawDescriptionsCurrent ? value : value.replace(/\r*\n/g, ' ');
+}
 export function joinUnionTypes(value: string[]) {
   // Use unopinionated formatting for raw descriptions
   return rawDescriptionsCurrent ? value.join(' | ') : value.join('<br>&#124;&nbsp;');

diff --git a/packages/api-docs-builder/utils/generatePropDescription.ts b/packages/api-docs-builder/utils/generatePropDescription.ts
@@ -1,7 +1,7 @@
 import * as doctrine from 'doctrine';
 import * as recast from 'recast';
 import { PropTypeDescriptor } from 'react-docgen';
-import { escapeCell } from '../buildApi';
+import { escapeCell, removeNewLines } from '../buildApi';
 import {
   isElementTypeAcceptingRefProp,
   isElementAcceptingRefProp,
@@ -129,7 +129,7 @@ export default function generatePropDescription(
     // Remove new lines from tag descriptions to avoid markdown errors.
     annotation.tags.forEach((tag) => {
       if (tag.description) {
-        tag.description = tag.description.replace(/\r*\n/g, ' ');
+        tag.description = removeNewLines(tag.description);
       }
     });