Convert CustomMarkdownEmitter.test.ts to use Jest snapshots instead of the deprecated FileDiffTest API

pgonzal · pgonzal · commit 441280d76348 · 2019-01-09T16:52:43.000-08:00
diff --git a/apps/api-documenter/src/markdown/test/CustomMarkdownEmitter.test.ts b/apps/api-documenter/src/markdown/test/CustomMarkdownEmitter.test.ts
@@ -1,8 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import * as path from 'path';
-import { FileDiffTest, FileSystem } from '@microsoft/node-core-library';
 import {
   DocSection,
   TSDocConfiguration,
@@ -24,8 +22,7 @@ import { DocTableCell } from '../../nodes/DocTableCell';
 import { CustomMarkdownEmitter } from '../CustomMarkdownEmitter';
 import { ApiModel, ApiItem } from '@microsoft/api-extractor';
 
-test('render Markdown from TSDoc', done => {
-  const outputFolder: string = FileDiffTest.prepareFolder(__dirname, 'MarkdownPageRenderer');
+test('render Markdown from TSDoc', () => {
   const configuration: TSDocConfiguration = CustomDocNodes.configuration;
 
   const output: DocSection = new DocSection({ configuration });
@@ -196,7 +193,6 @@ test('render Markdown from TSDoc', done => {
     ])
   ]);
 
-  const outputFilename: string = path.join(outputFolder, 'ActualOutput.md');
   const stringBuilder: StringBuilder = new StringBuilder();
   const apiModel: ApiModel = new ApiModel();
   const markdownEmitter: CustomMarkdownEmitter = new CustomMarkdownEmitter(apiModel);
@@ -206,9 +202,6 @@ test('render Markdown from TSDoc', done => {
       return '#';
     }
   });
-  FileSystem.writeFile(outputFilename, stringBuilder.toString());
 
-  FileDiffTest.assertEqual(outputFilename, path.join(__dirname, 'ExpectedOutput.md'));
-
-  done();
+  expect(stringBuilder).toMatchSnapshot();
 });
diff --git a/apps/api-documenter/src/markdown/test/ExpectedOutput.md b/apps/api-documenter/src/markdown/test/ExpectedOutput.md
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
@@ -0,0 +1,58 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`render Markdown from TSDoc 1`] = `
+StringBuilder {
+  "_chunks": Array [
+    "
+## Simple bold test
+
+This is a <b>bold</b> word.
+
+## All whitespace bold
+
+  
+
+## Newline bold
+
+<b>line 1</b> <b>line 2</b>
+
+## Newline bold with spaces
+
+  <b>line 1</b>    <b>line 2</b>    <b>line 3</b>  
+
+## Adjacent bold regions
+
+<b>one</b><b>two</b> <b>three</b> <b>four</b>non-bold<!-- --><b>five</b>
+
+## Adjacent to other characters
+
+[a link](./index.md)<!-- --><b>bold</b>non-boldmore-non-bold
+
+## Bad characters
+
+<b>\\\\*one\\\\*two\\\\*</b><b>three\\\\*four</b>
+
+## Characters that should be escaped
+
+Double-encoded JSON: \\"{ \\\\\\\\\\"A\\\\\\\\\\": 123}\\"
+
+HTML chars: &lt;script&gt;alert(\\"\\\\[You\\\\] are \\\\#1!\\");&lt;/script&gt;
+
+HTML escape: &amp;quot;
+
+3 or more hyphens: - -- \\\\-\\\\-\\\\- \\\\-\\\\-\\\\-- \\\\-\\\\-\\\\--- \\\\-\\\\-\\\\-\\\\-\\\\-\\\\-
+
+## HTML tag
+
+<b>bold</b>
+
+## Table
+
+|  Header 1 | Header 2 |
+|  --- | --- |
+|  Cell 1 | Cell 2 |
+
+",
+  ],
+}
+`;
