fix(tests): fix some tests that got out of sync with the code (#77)

Signed-off-by: flakey5 <[email protected]>

Author: flakey5

src/metadata.mjs

@@ -132,7 +132,7 @@ const createMetadata = slugger => {
       // a certain navigation section to a page ad the exact point of the page (scroll)
       // This is useful for classes, globals and other type of YAML entries, as they reside
       // within a module (page) and we want to link to them directly
-      const slugHash = `#${slugger.slug(internalMetadata.heading.data.text)}`;
+      const slugHash = `#${slugger.slug(internalMetadata.heading.text)}`;
 
       const {
         source_link: sourceLink,

src/test/metadata.test.mjs

@@ -23,8 +23,13 @@ describe('createMetadata', () => {
     const slugger = new GitHubSlugger();
     const metadata = createMetadata(slugger);
     const stability = 2;
-    metadata.setStability(stability);
-    strictEqual(metadata.create(new VFile(), {}).stability, stability);
+    metadata.addStability(stability);
+    const actual = metadata.create(new VFile(), {}).stability;
+    delete actual.toJSON;
+    deepStrictEqual(actual, {
+      children: [stability],
+      type: 'root',
+    });
   });
 
   it('should create a metadata entry correctly', () => {
@@ -41,7 +46,7 @@ describe('createMetadata', () => {
     const stability = 2;
     const properties = { source_link: 'test.com' };
     metadata.setHeading(heading);
-    metadata.setStability(stability);
+    metadata.addStability(stability);
     metadata.updateProperties(properties);
     const expected = {
       api: 'test',
@@ -50,9 +55,12 @@ describe('createMetadata', () => {
       updates: [],
       changes: [],
       heading,
-      stability,
+      stability: { type: 'root', children: [stability] },
       content: section,
+      tags: [],
     };
-    deepStrictEqual(metadata.create(apiDoc, section), expected);
+    const actual = metadata.create(apiDoc, section);
+    delete actual.stability.toJSON;
+    deepStrictEqual(actual, expected);
   });
 });

src/test/parser.test.mjs

@@ -13,21 +13,79 @@ describe('createParser', () => {
     const expected = [
       {
         api: 'test',
-        slug: 'test.html#test-heading',
-        sourceLink: undefined,
+        slug: 'test.html#',
         updates: [],
         changes: [],
         heading: {
-          text: 'Test Heading',
-          type: 'module',
-          name: 'Test Heading',
+          children: [
+            {
+              position: {
+                end: {
+                  column: 15,
+                  line: 1,
+                  offset: 14,
+                },
+                start: {
+                  column: 3,
+                  line: 1,
+                  offset: 2,
+                },
+              },
+              type: 'text',
+              value: 'Test Heading',
+            },
+          ],
+          data: {
+            depth: 1,
+            name: 'Test Heading',
+            text: 'Test Heading',
+            type: 'module',
+          },
           depth: 1,
+          position: {
+            end: {
+              column: 15,
+              line: 1,
+              offset: 14,
+            },
+            start: {
+              column: 1,
+              line: 1,
+              offset: 0,
+            },
+          },
+          type: 'heading',
+        },
+        sourceLink: undefined,
+        stability: { type: 'root', children: [] },
+        content: {
+          type: 'root',
+          children: [
+            {
+              type: 'paragraph',
+              children: [
+                {
+                  type: 'text',
+                  value: 'This is a test.',
+                  position: {
+                    start: { line: 3, column: 1, offset: 16 },
+                    end: { line: 3, column: 16, offset: 31 },
+                  },
+                },
+              ],
+              position: {
+                start: { line: 3, column: 1, offset: 16 },
+                end: { line: 3, column: 16, offset: 31 },
+              },
+            },
+          ],
         },
-        stability: undefined,
-        content: { type: 'root', children: [] },
+        tags: [],
       },
     ];
     const actual = await parser.parseApiDoc(apiDoc);
+    delete actual[0].heading.toJSON;
+    delete actual[0].stability.toJSON;
     delete actual[0].content.toJSON;
     deepStrictEqual(actual, expected);
   });
@@ -47,37 +105,121 @@ describe('createParser', () => {
     const expected = [
       {
         api: 'test1',
-        slug: 'test1.html#test-heading-1',
-        sourceLink: undefined,
+        slug: 'test1.html#',
         updates: [],
         changes: [],
         heading: {
-          text: 'Test Heading 1',
-          type: 'module',
-          name: 'Test Heading 1',
+          type: 'heading',
           depth: 1,
+          children: [
+            {
+              type: 'text',
+              value: 'Test Heading 1',
+              position: {
+                start: { line: 1, column: 3, offset: 2 },
+                end: { line: 1, column: 17, offset: 16 },
+              },
+            },
+          ],
+          position: {
+            start: { line: 1, column: 1, offset: 0 },
+            end: { line: 1, column: 17, offset: 16 },
+          },
+          data: {
+            text: 'Test Heading 1',
+            type: 'module',
+            name: 'Test Heading 1',
+            depth: 1,
+          },
+        },
+        sourceLink: undefined,
+        stability: { type: 'root', children: [] },
+        content: {
+          type: 'root',
+          children: [
+            {
+              type: 'paragraph',
+              children: [
+                {
+                  type: 'text',
+                  value: 'This is a test.',
+                  position: {
+                    start: { line: 3, column: 1, offset: 18 },
+                    end: { line: 3, column: 16, offset: 33 },
+                  },
+                },
+              ],
+              position: {
+                start: { line: 3, column: 1, offset: 18 },
+                end: { line: 3, column: 16, offset: 33 },
+              },
+            },
+          ],
         },
-        stability: undefined,
-        content: { type: 'root', children: [] },
+        tags: [],
       },
       {
         api: 'test2',
-        slug: 'test2.html#test-heading-2',
-        sourceLink: undefined,
+        slug: 'test2.html#',
         updates: [],
         changes: [],
         heading: {
-          text: 'Test Heading 2',
-          type: 'module',
-          name: 'Test Heading 2',
+          type: 'heading',
           depth: 1,
+          children: [
+            {
+              type: 'text',
+              value: 'Test Heading 2',
+              position: {
+                start: { line: 1, column: 3, offset: 2 },
+                end: { line: 1, column: 17, offset: 16 },
+              },
+            },
+          ],
+          position: {
+            start: { line: 1, column: 1, offset: 0 },
+            end: { line: 1, column: 17, offset: 16 },
+          },
+          data: {
+            text: 'Test Heading 2',
+            type: 'module',
+            name: 'Test Heading 2',
+            depth: 1,
+          },
         },
-        stability: undefined,
-        content: { type: 'root', children: [] },
+        sourceLink: undefined,
+        stability: { type: 'root', children: [] },
+        content: {
+          type: 'root',
+          children: [
+            {
+              type: 'paragraph',
+              children: [
+                {
+                  type: 'text',
+                  value: 'This is another test.',
+                  position: {
+                    start: { line: 3, column: 1, offset: 18 },
+                    end: { line: 3, column: 22, offset: 39 },
+                  },
+                },
+              ],
+              position: {
+                start: { line: 3, column: 1, offset: 18 },
+                end: { line: 3, column: 22, offset: 39 },
+              },
+            },
+          ],
+        },
+        tags: [],
       },
     ];
     const actual = await parser.parseApiDocs(apiDocs);
-    actual.forEach(entry => delete entry.content.toJSON);
+    actual.forEach(entry => {
+      delete entry.heading.toJSON;
+      delete entry.stability.toJSON;
+      delete entry.content.toJSON;
+    });
     deepStrictEqual(actual, expected);
   });
 });

src/test/queries.test.mjs

@@ -18,20 +18,20 @@ describe('createQueries', () => {
   it('should update type to reference correctly', () => {
     const queries = createQueries();
     const node = { value: 'This is a {string} type.' };
-    queries.updateTypeToReferenceLink(node);
+    queries.updateTypeReference(node);
     strictEqual(node.type, 'html');
     strictEqual(
       node.value,
-      'This is a [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) type.'
+      'This is a [`<string>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) type.'
     );
   });
 
   it('should update type to reference not correctly if no match', () => {
     const queries = createQueries();
     const node = { value: 'This is a {test} type.' };
-    queries.updateTypeToReferenceLink(node);
+    queries.updateTypeReference(node);
     strictEqual(node.type, 'html');
-    strictEqual(node.value, 'This is a test type.');
+    strictEqual(node.value, 'This is a {test} type.');
   });
 
   it('should add heading metadata correctly', () => {
@@ -43,14 +43,23 @@ describe('createQueries', () => {
     const apiEntryMetadata = {
       setHeading: heading => {
         deepStrictEqual(heading, {
-          text: 'Test Heading',
-          type: 'module',
-          name: 'Test Heading',
+          children: [
+            {
+              type: 'text',
+              value: 'Test Heading',
+            },
+          ],
+          data: {
+            depth: 2,
+            name: 'Test Heading',
+            text: 'Test Heading',
+            type: 'module',
+          },
           depth: 2,
         });
       },
     };
-    queries.addHeadingMetadata(node, apiEntryMetadata);
+    queries.setHeadingMetadata(node, apiEntryMetadata);
   });
 
   it('should update markdown link correctly', () => {
@@ -81,13 +90,13 @@ describe('createQueries', () => {
       ],
     };
     const apiEntryMetadata = {
-      setStability: stability => {
-        deepStrictEqual(stability.toJSON(), {
+      addStability: stability => {
+        deepStrictEqual(stability.data, {
           index: 2,
           description: 'Frozen',
         });
       },
     };
-    queries.addStabilityIndexMetadata(node, apiEntryMetadata);
+    queries.addStabilityMetadata(node, apiEntryMetadata);
   });
 });

src/utils/tests/parser.test.mjs

@@ -11,14 +11,14 @@ describe('transformTypeToReferenceLink', () => {
   it('should transform a JavaScript primitive type into a Markdown link', () => {
     strictEqual(
       transformTypeToReferenceLink('string'),
-      '[`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)'
+      '[`<string>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)'
     );
   });
 
   it('should transform a JavaScript global type into a Markdown link', () => {
     strictEqual(
       transformTypeToReferenceLink('Array'),
-      '[`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)'
+      '[`<Array>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)'
     );
   });
 });