tmp

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

Author: flakey5

src/generators/json-all/util/generateJsonSchema.mjs

@@ -7,7 +7,7 @@ const JSON_SCHEMA_URL = `https://nodejs.org/docs/${DOC_NODE_VERSION}/api/node-do
 
 export const generateJsonSchema = () => ({
   $schema: 'http://json-schema.org/draft-07/schema#',
-  $id: `nodejs-api-doc-all@${jsonAll.version}`,
+  $id: `nodejs-api-doc-all@v${jsonAll.version}`,
   title: 'Node.js API Documentation Schema (All)',
   readOnly: true,
 

src/generators/json/__tests__/utils/createPropertySection.test.mjs

@@ -0,0 +1,74 @@
+// @ts-check
+'use strict';
+
+import test, { describe } from 'node:test';
+import assert from 'node:assert';
+
+`
+#### \`url.username\`
+
+* Type: {string}
+
+Gets and sets the username portion of the URL.
+`;
+
+describe('extracts type correctly', () => {
+  const supportedFormats = [
+    '{integer} **Default:** 8192',
+    '{integer|boolean} bla bla bla',
+    '{boolean}',
+    'Type: {Function} bla bla bla',
+  ];
+
+  for (const format of supportedFormats) {
+    test(format, () => {
+      /**
+       * @type {import('../../utils/createSectionBase.mjs').HierarchizedEntry}
+       */
+      const entry = {
+        hierarchyChildren: [],
+        api: 'bla',
+        slug: 'asd',
+        api_doc_source: 'doc/api/something.md',
+        changes: [],
+        heading: {
+          type: 'heading',
+          depth: 1,
+          children: [],
+          data: {
+            text: '`asd.something`',
+            name: '`asd.something`',
+            depth: 3,
+            slug: '`asd.something`',
+            type: 'property',
+          },
+        },
+        stability: {
+          type: 'root',
+          children: [],
+        },
+        content: {
+          type: 'root',
+          children: [
+            {
+              type: 'list',
+              children: [
+                {
+                  type: 'listItem',
+                  children: [
+                    {
+                      type: 'paragraph',
+                      // children: 
+                    }
+                  ]
+                }
+              ]
+            }
+          ],
+        },
+        tags: [],
+        yaml_position: {},
+      };
+    });
+  }
+});

src/generators/json/__tests__/utils/createSectionBase.test.mjs

@@ -1,4 +1,6 @@
 // @ts-check
+'use strict';
+
 import test, { describe } from 'node:test';
 import assert from 'node:assert';
 import {

src/generators/json/utils/createMethodSection.mjs

@@ -1,7 +1,10 @@
 // @ts-check
 'use strict';
 
-import { assertAstType } from '../../../utils/assertAstType.mjs';
+import {
+  assertAstType,
+  assertAstTypeOptional,
+} from '../../../utils/assertAstType.mjs';
 import { GeneratorError } from '../../../utils/generator-error.mjs';
 import { METHOD_RETURN_TYPE_EXTRACTOR } from '../constants.mjs';
 import { findParentSection } from './findParentSection.mjs';
@@ -25,7 +28,7 @@ export const createMethodSectionBuilder = () => {
      * documented properties.
      */
     const paragraph = assertAstType(children[0], 'paragraph');
-    const list = children[1] ? assertAstType(children[1], 'list') : undefined;
+    const list = assertAstTypeOptional(children[1], 'list');
 
     /**
      * @type {import('../generated.d.ts').MethodParameter | import('../generated.d.ts').MethodReturnType}

src/generators/json/utils/createPropertySection.mjs

@@ -39,7 +39,7 @@ export const createPropertySectionBuilder = () => {
       return undefined;
     }
 
-    const firstListElement = listNode.children[0].children[0];
+    const firstListElement = structuredClone(listNode.children[0].children[0]);
 
     if (firstListElement.type !== 'paragraph') {
       throw new TypeError(
@@ -184,7 +184,7 @@ export const createPropertySectionBuilder = () => {
    * @param {import('../generated.d.ts').Property} section The method section
    */
   return (entry, section) => {
-    const listElement = parseType(structuredClone(entry), section);
+    const listElement = parseType(entry, section);
 
     if (listElement) {
       parseReferenceLink(listElement, section);

src/generators/json/utils/createSectionBase.mjs

@@ -34,7 +34,7 @@ export const createSectionBaseBuilder = () => {
    * @param {number} depth
    * @returns {typeof ENTRY_TO_SECTION_TYPE[string]}
    */
-  const determineType = (header, entry) => {
+  const determineType = header => {
     const fallback = header.depth === 1 ? 'module' : 'text';
 
     // doc/api/process.md's parent section shouldn't have a defined type, but
@@ -47,10 +47,6 @@ export const createSectionBaseBuilder = () => {
       return 'module';
     }
 
-    // if (header?.data.type === 'global') {
-    //   console.log(entry);
-    // }
-
     return ENTRY_TO_SECTION_TYPE[header?.data.type ?? fallback];
   };
 
@@ -202,7 +198,7 @@ export const createSectionBaseBuilder = () => {
   return entry => {
     const [, ...nodes] = entry.content.children;
 
-    const type = determineType(entry.heading, entry);
+    const type = determineType(entry.heading);
 
     /**
      * @type {import('../generated.d.ts').SectionBase}

src/utils/assertAstType.mjs

@@ -35,3 +35,18 @@ export function assertAstType(node, type) {
 
   return node;
 }
+
+/**
+ * @template {keyof NodeTypes} T
+ *
+ * @param {import('mdast').Node | undefined} node
+ * @param {T} type
+ * @returns {NodeTypes[T] | undefined}
+ */
+export function assertAstTypeOptional(node, type) {
+  if (!node) {
+    return undefined;
+  }
+
+  return assertAstType(node, type);
+}