[api-documenter] Ensure empty line after tables (#5256)

Ragnar-Oock · octogonz · web-flow · commit 9b923684ddde · 2025-06-23T15:19:18.000-07:00
* Ensure empty line after tables (fix #4878) * update api-extractor-scenarios snapshots * Update common/changes/@microsoft/api-documenter/fix-api-documenter-missing-new-lines-after-tables_2025-06-17-22-12.json --------- Co-authored-by: Pete Gonzalez <4673363+octogonz@users.noreply.github.com>
diff --git a/apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts b/apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts
@@ -136,7 +136,7 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {
         }
         writer.write('</tbody>');
         writer.write('</table>');
-        writer.writeLine();
+        writer.ensureSkippedLine();
 
         break;
       }
diff --git a/apps/api-documenter/src/markdown/test/CustomMarkdownEmitter.test.ts b/apps/api-documenter/src/markdown/test/CustomMarkdownEmitter.test.ts
@@ -171,6 +171,13 @@ test('render Markdown from TSDoc', () => {
     )
   ]);
 
+  output.appendNodes([
+    new DocHeading({ configuration, title: 'After a table' }),
+    new DocParagraph({ configuration }, [
+      new DocPlainText({ configuration, text: 'just checking lines after a table' }),
+    ])
+  ]);
+
   const stringBuilder: StringBuilder = new StringBuilder();
   const apiModel: ApiModel = new ApiModel();
   const markdownEmitter: CustomMarkdownEmitter = new CustomMarkdownEmitter(apiModel);
diff --git a/apps/api-documenter/src/markdown/test/__snapshots__/CustomMarkdownEmitter.test.ts.snap b/apps/api-documenter/src/markdown/test/__snapshots__/CustomMarkdownEmitter.test.ts.snap
@@ -75,5 +75,10 @@ Cell 2
 
 </td></tr>
 </tbody></table>
+
+## After a table
+
+just checking lines after a table
+
 "
 `;
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.md
@@ -166,3 +166,4 @@ Some overload. Overrides `Class3.someOverload`<!-- -->.
 
 </td></tr>
 </tbody></table>
+
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.someoverload.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.someoverload.md
@@ -45,6 +45,7 @@ boolean \| string
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.md
@@ -161,3 +161,4 @@ Some overload.
 
 </td></tr>
 </tbody></table>
+
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.somemethod.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.somemethod.md
@@ -45,6 +45,7 @@ boolean
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsinterfaceliketypealias.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsinterfaceliketypealias.md
@@ -81,3 +81,4 @@ Some prop.
 
 </td></tr>
 </tbody></table>
+
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.md
@@ -96,3 +96,4 @@ A third prop.
 
 </td></tr>
 </tbody></table>
+
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.md
@@ -73,3 +73,4 @@ Some prop.
 
 </td></tr>
 </tbody></table>
+
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface2.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface2.md
@@ -54,3 +54,4 @@ Some prop.
 
 </td></tr>
 </tbody></table>
+
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.md
@@ -216,3 +216,4 @@ Some interface-like type alias.
 
 </td></tr>
 </tbody></table>
+
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.md
@@ -116,3 +116,4 @@ Some overload.
 
 </td></tr>
 </tbody></table>
+
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.somemethod.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.somemethod.md
@@ -45,6 +45,7 @@ boolean \| string
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload.md
@@ -45,6 +45,7 @@ boolean
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload_1.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload_1.md
@@ -45,6 +45,7 @@ string
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.md
@@ -35,3 +35,4 @@ Description
 
 </td></tr>
 </tbody></table>
+
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/index.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/index.md
@@ -27,3 +27,4 @@ Description
 
 </td></tr>
 </tbody></table>
+
diff --git a/build-tests/api-documenter-test/src/test/__snapshots__/snapshot.test.ts.snap b/build-tests/api-documenter-test/src/test/__snapshots__/snapshot.test.ts.snap
@@ -1363,6 +1363,7 @@ Some abstract method.
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.abstractclass.method.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -1504,6 +1505,7 @@ The date when the record was created.
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.defaulttype.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -1580,6 +1582,7 @@ number
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.docbaseclass.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -1643,6 +1646,7 @@ The overloaded constructor for \`DocBaseClass\`
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.docclass1.deprecatedexample.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -1730,6 +1734,7 @@ the second string
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 string
@@ -1790,6 +1795,7 @@ the number
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 number
@@ -1844,6 +1850,7 @@ some generic parameter.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void
@@ -2252,6 +2259,7 @@ An example with tables:
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.docclass1.modifiedevent.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -2330,6 +2338,7 @@ _(Optional)_ the number
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void
@@ -2440,6 +2449,7 @@ the second number to add
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 number
@@ -2617,6 +2627,7 @@ These are some docs for Zero
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.docenumnamespacemerge.examplefunction.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -2675,6 +2686,7 @@ This is a function inside of a namespace that merges with an enum.
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.ecmasymbols.example.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -2729,6 +2741,7 @@ An ECMAScript symbol
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.exampleduplicatetypealias.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -2811,6 +2824,7 @@ a system type that should NOT get hyperlinked
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [IDocInterface1](./api-documenter-test.idocinterface1.md)
@@ -2931,6 +2945,7 @@ Does something
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.idocinterface1.regularproperty.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -3004,6 +3019,7 @@ Description
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.idocinterface3.__not.a.symbol__.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -3173,6 +3189,7 @@ Construct signature
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.idocinterface3.redundantquotes.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -3333,6 +3350,7 @@ a union type
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.idocinterface4.numberorfunction.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -3419,6 +3437,7 @@ Property of type string that does something
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.idocinterface5.regularproperty.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -3491,6 +3510,7 @@ T
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 T
@@ -3674,6 +3694,7 @@ Description
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.idocinterface6.regularproperty.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -3848,6 +3869,7 @@ _(Optional)_ Description of optionalMember
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.idocinterface7.optionalfield.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -4365,6 +4387,7 @@ A type alias that references multiple other types.
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.outernamespace.innernamespace.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -4405,6 +4428,7 @@ A function inside a namespace
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.outernamespace.innernamespace.nestedfunction.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -4453,6 +4477,7 @@ number
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 number
@@ -4523,6 +4548,7 @@ A variable exported from within a namespace.
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.outernamespace.nestedvariable.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -4585,6 +4611,7 @@ handler
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void
@@ -4638,6 +4665,7 @@ Adds an handler for the event.
 
 </td></tr>
 </tbody></table>
+
 ",
   "/api-documenter-test.typealias.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
@@ -4702,6 +4730,7 @@ This project tests various documentation generation scenarios and doc comment sy
 
 </td></tr>
 </tbody></table>
+
 ",
 }
 `;
diff --git a/common/changes/@microsoft/api-documenter/fix-api-documenter-missing-new-lines-after-tables_2025-06-17-22-12.json b/common/changes/@microsoft/api-documenter/fix-api-documenter-missing-new-lines-after-tables_2025-06-17-22-12.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/api-documenter",
+      "comment": "Ensure a new line is inserted after rendering a table",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft/api-documenter"
+}

Original file line number	Diff line number	Diff line change
`@@ -136,7 +136,7 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {`
`136`	`136`	`}`
`137`	`137`	`writer.write('</tbody>');`
`138`	`138`	`writer.write('</table>');`
`139`		`- writer.writeLine();`
	`139`	`+ writer.ensureSkippedLine();`
`140`	`140`
`141`	`141`	`break;`
`142`	`142`	`}`
Original file line number	Diff line number	Diff line change
@@ -166,3 +166,4 @@ Some overload. Overrides `Class3.someOverload`<!-- -->.
`166`	`166`
`167`	`167`	`</td></tr>`
`168`	`168`	`</tbody></table>`
	`169`	`+`
Original file line number	Diff line number	Diff line change
`@@ -161,3 +161,4 @@ Some overload.`
`161`	`161`
`162`	`162`	`</td></tr>`
`163`	`163`	`</tbody></table>`
	`164`	`+`
Original file line number	Diff line number	Diff line change
`@@ -81,3 +81,4 @@ Some prop.`
`81`	`81`
`82`	`82`	`</td></tr>`
`83`	`83`	`</tbody></table>`
	`84`	`+`
Original file line number	Diff line number	Diff line change
`@@ -96,3 +96,4 @@ A third prop.`
`96`	`96`
`97`	`97`	`</td></tr>`
`98`	`98`	`</tbody></table>`
	`99`	`+`
Original file line number	Diff line number	Diff line change
`@@ -73,3 +73,4 @@ Some prop.`
`73`	`73`
`74`	`74`	`</td></tr>`
`75`	`75`	`</tbody></table>`
	`76`	`+`