add tests, fix edge case

Author: avivkeller

src/utils/queries/__tests__/index.test.mjs

@@ -110,4 +110,114 @@ describe('createQueries', () => {
     };
     queries.addStabilityMetadata(node, apiEntryMetadata);
   });
+
+  describe('UNIST', () => {
+    describe('isTypedList', () => {
+      it('returns false for non-list nodes', () => {
+        strictEqual(
+          createQueries.UNIST.isTypedList({ type: 'paragraph', children: [] }),
+          false
+        );
+      });
+
+      it('returns false for empty lists', () => {
+        strictEqual(
+          createQueries.UNIST.isTypedList({ type: 'list', children: [] }),
+          false
+        );
+      });
+
+      const cases = [
+        {
+          name: 'typedListStarters pattern match',
+          node: {
+            type: 'list',
+            children: [
+              {
+                children: [
+                  {
+                    children: [{ type: 'text', value: 'Returns: foo' }],
+                  },
+                ],
+              },
+            ],
+          },
+          expected: true,
+        },
+        {
+          name: 'direct type link pattern',
+          node: {
+            type: 'list',
+            children: [
+              {
+                children: [
+                  {
+                    children: [
+                      {
+                        type: 'link',
+                        children: [{ type: 'inlineCode', value: '<Type>' }],
+                      },
+                    ],
+                  },
+                ],
+              },
+            ],
+          },
+          expected: true,
+        },
+        {
+          name: 'inlineCode + space + type link pattern',
+          node: {
+            type: 'list',
+            children: [
+              {
+                children: [
+                  {
+                    children: [
+                      { type: 'inlineCode', value: 'foo' },
+                      { type: 'text', value: ' ' },
+                      {
+                        type: 'link',
+                        children: [{ type: 'text', value: '<Bar>' }],
+                      },
+                    ],
+                  },
+                ],
+              },
+            ],
+          },
+          expected: true,
+        },
+        {
+          name: 'non-matching content',
+          node: {
+            type: 'list',
+            children: [
+              {
+                children: [
+                  {
+                    children: [
+                      { type: 'inlineCode', value: 'not a valid prop' },
+                      { type: 'text', value: ' ' },
+                      {
+                        type: 'link',
+                        children: [{ type: 'text', value: '<Bar>' }],
+                      },
+                    ],
+                  },
+                ],
+              },
+            ],
+          },
+          expected: false,
+        },
+      ];
+
+      cases.forEach(({ name, node, expected }) => {
+        it(`returns ${expected} for ${name}`, () => {
+          strictEqual(createQueries.UNIST.isTypedList(node), expected);
+        });
+      });
+    });
+  });
 });

src/utils/queries/index.mjs

@@ -281,15 +281,15 @@ createQueries.UNIST = {
     const [node, ...contentNodes] =
       list?.children?.[0]?.children?.[0]?.children ?? [];
 
-    const possibleProperty = node?.value?.trimStart();
-
-    // Exit if no content in node (or if no node exists)
-    if (!possibleProperty) {
+    // Exit if no node
+    if (!node) {
       return false;
     }
 
+    const possibleProperty = node?.value?.trimStart();
+
     // Check for other starters
-    if (possibleProperty.match(createQueries.QUERIES.typedListStarters)) {
+    if (possibleProperty?.match(createQueries.QUERIES.typedListStarters)) {
       return true;
     }
 
@@ -301,7 +301,7 @@ createQueries.UNIST = {
     // Check for inline code + space + type link pattern
     if (
       node.type === 'inlineCode' &&
-      possibleProperty.match(VALID_JAVASCRIPT_PROPERTY) &&
+      possibleProperty?.match(VALID_JAVASCRIPT_PROPERTY) &&
       contentNodes[0]?.value?.trim() === '' &&
       contentNodes[1]?.type === 'link' &&
       contentNodes[1]?.children?.[0]?.value?.[0] === '<'