feat: json, json-all generators by flakey5 · Pull Request #287 · nodejs/doc-kit

flakey5 · 2025-05-31T18:21:03Z

Closes #214

TODO:

Dedupe code for type list parsing (re feat: json, json-all generators #287 (comment))

codecov-commenter · 2025-05-31T18:21:34Z

❌ 14 Tests Failed:

Tests completed	Failed	Passed	Skipped
347	14	333	0

View the top 3 failed test(s) by shortest run time

test::`something.regexExtractedReturnType()`

Stack Traces | 0.000296s run time

[Error [ERR_TEST_FAILURE]: Cannot read properties of undefined (reading 'type')] {
  code: 'ERR_TEST_FAILURE',
  failureType: 'testCodeFailure',
  cause: TypeError: Cannot read properties of undefined (reading 'type')
      at handleStarter (file:.../src/utils/parseParameterList.mjs:42:23)
      at parseParameter (file:.../src/utils/parseParameterList.mjs:185:21)
      at Array.map (<anonymous>)
      at parseParameterList (file:.../src/utils/parseParameterList.mjs:211:6)
      at parseParameters (file:.../utils/sections/method.mjs:38:3)
      at parseSignatures (file:.../utils/sections/method.mjs:152:25)
      at TestContext.<anonymous> (file:.../sections/__tests__/method.test.mjs:192:5)
      at Test.runInAsyncScope (node:async_hooks:214:14)
      at Test.run (node:internal/test_runner/test:1106:25)
      at Suite.processPendingSubtests (node:internal/test_runner/test:788:18)
}

test::[<boolean>](https://mdn-link) | [<string>](https://mdn-link)

Stack Traces | 0.000398s run time

Error [ERR_TEST_FAILURE]: Expected values to be strictly deep-equal:
�[32m+ actual�[39m �[31m- expected�[39m

�[39m  [
�[39m    {
�[32m+�[39m     '@name': undefined,
�[31m-�[39m     '@name': 'value',
�[39m      '@type': [
�[39m        'boolean',
�[39m        'string'
�[39m      ],
�[32m+�[39m     description: undefined
�[39m    }
�[39m  ]

    at async Promise.all (index 0) {
  code: 'ERR_TEST_FAILURE',
  failureType: 'testCodeFailure',
  cause: AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
  �[32m+ actual�[39m �[31m- expected�[39m
  
  �[39m  [
  �[39m    {
  �[32m+�[39m     '@name': undefined,
  �[31m-�[39m     '@name': 'value',
  �[39m      '@type': [
  �[39m        'boolean',
  �[39m        'string'
  �[39m      ],
  �[32m+�[39m     description: undefined
  �[39m    }
  �[39m  ]
  
      at TestContext.<anonymous> (file:.../sections/__tests__/event.test.mjs:688:14)
      at Test.runInAsyncScope (node:async_hooks:214:14)
      at Test.run (node:internal/test_runner/test:1106:25)
      at Suite.processPendingSubtests (node:internal/test_runner/test:788:18)
      at Test.postRun (node:internal/test_runner/test:1235:19)
      at Test.run (node:internal/test_runner/test:1163:12)
      at async Promise.all (index 0)
      at async Suite.run (node:internal/test_runner/test:1518:7)
      at async Suite.processPendingSubtests (node:internal/test_runner/test:788:7) {
    generatedMessage: true,
    code: 'ERR_ASSERTION',
    actual: [ [Object] ],
    expected: [ [Object] ],
    operator: 'deepStrictEqual',
    diff: 'simple'
  }
}

test::`paramName` {boolean} description bla bla bla

Stack Traces | 0.000421s run time

[Error [ERR_TEST_FAILURE]: Expected values to be strictly deep-equal:
�[32m+ actual�[39m �[31m- expected�[39m

�[32m+�[39m []
�[31m-�[39m [
�[31m-�[39m   {
�[31m-�[39m     '@name': 'paramName',
�[31m-�[39m     '@type': 'boolean',
�[31m-�[39m     description: 'description bla bla bla'
�[31m-�[39m   }
�[31m-�[39m ]
] {
  code: 'ERR_TEST_FAILURE',
  failureType: 'testCodeFailure',
  cause: AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
  �[32m+ actual�[39m �[31m- expected�[39m
  
  �[32m+�[39m []
  �[31m-�[39m [
  �[31m-�[39m   {
  �[31m-�[39m     '@name': 'paramName',
  �[31m-�[39m     '@type': 'boolean',
  �[31m-�[39m     description: 'description bla bla bla'
  �[31m-�[39m   }
  �[31m-�[39m ]
  
      at TestContext.<anonymous> (file:.../sections/__tests__/event.test.mjs:378:14)
      at Test.runInAsyncScope (node:async_hooks:214:14)
      at Test.run (node:internal/test_runner/test:1106:25)
      at Suite.processPendingSubtests (node:internal/test_runner/test:788:18)
      at Test.postRun (node:internal/test_runner/test:1235:19)
      at Test.run (node:internal/test_runner/test:1163:12)
      at async Suite.processPendingSubtests (node:internal/test_runner/test:788:7) {
    generatedMessage: true,
    code: 'ERR_ASSERTION',
    actual: [],
    expected: [ [Object] ],
    operator: 'deepStrictEqual',
    diff: 'simple'
  }
}

test::[<boolean>](https://mdn-link) description bla bla bla

Stack Traces | 0.000487s run time

[Error [ERR_TEST_FAILURE]: Expected values to be strictly deep-equal:
�[32m+ actual�[39m �[31m- expected�[39m

�[39m  [
�[39m    {
�[32m+�[39m     '@name': undefined,
�[31m-�[39m     '@name': 'value',
�[39m      '@type': 'boolean',
�[39m      description: 'description bla bla bla'
�[39m    }
�[39m  ]
] {
  code: 'ERR_TEST_FAILURE',
  failureType: 'testCodeFailure',
  cause: AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
  �[32m+ actual�[39m �[31m- expected�[39m
  
  �[39m  [
  �[39m    {
  �[32m+�[39m     '@name': undefined,
  �[31m-�[39m     '@name': 'value',
  �[39m      '@type': 'boolean',
  �[39m      description: 'description bla bla bla'
  �[39m    }
  �[39m  ]
  
      at TestContext.<anonymous> (file:.../sections/__tests__/event.test.mjs:744:14)
      at Test.runInAsyncScope (node:async_hooks:214:14)
      at Test.run (node:internal/test_runner/test:1106:25)
      at Suite.processPendingSubtests (node:internal/test_runner/test:788:18)
      at Test.postRun (node:internal/test_runner/test:1235:19)
      at Test.run (node:internal/test_runner/test:1163:12)
      at async Suite.processPendingSubtests (node:internal/test_runner/test:788:7) {
    generatedMessage: true,
    code: 'ERR_ASSERTION',
    actual: [ [Object] ],
    expected: [ [Object] ],
    operator: 'deepStrictEqual',
    diff: 'simple'
  }
}

test::`something.doThingWithUndefinedReturnType()`

Stack Traces | 0.000555s run time

[Error [ERR_TEST_FAILURE]: Expected values to be strictly deep-equal:
�[32m+ actual�[39m �[31m- expected�[39m

�[39m  {
�[39m    signatures: [
�[39m      {
�[39m        '@returns': {
�[32m+�[39m         '@type': 'any'
�[31m-�[39m         '@type': 'undefined'
�[39m        },
�[39m        parameters: undefined
�[39m      }
�[39m    ]
�[39m  }
] {
  code: 'ERR_TEST_FAILURE',
  failureType: 'testCodeFailure',
  cause: AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
  �[32m+ actual�[39m �[31m- expected�[39m
  
  �[39m  {
  �[39m    signatures: [
  �[39m      {
  �[39m        '@returns': {
  �[32m+�[39m         '@type': 'any'
  �[31m-�[39m         '@type': 'undefined'
  �[39m        },
  �[39m        parameters: undefined
  �[39m      }
  �[39m    ]
  �[39m  }
  
      at TestContext.<anonymous> (file:.../sections/__tests__/method.test.mjs:262:12)
      at Test.runInAsyncScope (node:async_hooks:214:14)
      at Test.run (node:internal/test_runner/test:1106:25)
      at Suite.processPendingSubtests (node:internal/test_runner/test:788:18)
      at Test.postRun (node:internal/test_runner/test:1235:19)
      at Test.run (node:internal/test_runner/test:1163:12)
      at async Suite.processPendingSubtests (node:internal/test_runner/test:788:7) {
    generatedMessage: true,
    code: 'ERR_ASSERTION',
    actual: { signatures: [Array] },
    expected: { signatures: [Array] },
    operator: 'deepStrictEqual',
    diff: 'simple'
  }
}

test::Type: [<boolean>](https://mdn-link) description bla bla bla

Stack Traces | 0.000558s run time

[Error [ERR_TEST_FAILURE]: Expected values to be strictly deep-equal:
�[32m+ actual�[39m �[31m- expected�[39m

�[39m  [
�[39m    {
�[32m+�[39m     '@name': undefined,
�[31m-�[39m     '@name': 'value',
�[39m      '@type': 'boolean',
�[39m      description: 'description bla bla bla'
�[39m    }
�[39m  ]
] {
  code: 'ERR_TEST_FAILURE',
  failureType: 'testCodeFailure',
  cause: AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
  �[32m+ actual�[39m �[31m- expected�[39m
  
  �[39m  [
  �[39m    {
  �[32m+�[39m     '@name': undefined,
  �[31m-�[39m     '@name': 'value',
  �[39m      '@type': 'boolean',
  �[39m      description: 'description bla bla bla'
  �[39m    }
  �[39m  ]
  
      at TestContext.<anonymous> (file:.../sections/__tests__/event.test.mjs:567:14)
      at Test.runInAsyncScope (node:async_hooks:214:14)
      at Test.run (node:internal/test_runner/test:1106:25)
      at Suite.processPendingSubtests (node:internal/test_runner/test:788:18)
      at Test.postRun (node:internal/test_runner/test:1235:19)
      at Test.run (node:internal/test_runner/test:1163:12)
      at async Suite.processPendingSubtests (node:internal/test_runner/test:788:7) {
    generatedMessage: true,
    code: 'ERR_ASSERTION',
    actual: [ [Object] ],
    expected: [ [Object] ],
    operator: 'deepStrictEqual',
    diff: 'simple'
  }
}

test::`paramName` {boolean}

Stack Traces | 0.000587s run time

[Error [ERR_TEST_FAILURE]: Expected values to be strictly deep-equal:
�[32m+ actual�[39m �[31m- expected�[39m

�[32m+�[39m []
�[31m-�[39m [
�[31m-�[39m   {
�[31m-�[39m     '@name': 'paramName',
�[31m-�[39m     '@type': 'boolean'
�[31m-�[39m   }
�[31m-�[39m ]
] {
  code: 'ERR_TEST_FAILURE',
  failureType: 'testCodeFailure',
  cause: AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
  �[32m+ actual�[39m �[31m- expected�[39m
  
  �[32m+�[39m []
  �[31m-�[39m [
  �[31m-�[39m   {
  �[31m-�[39m     '@name': 'paramName',
  �[31m-�[39m     '@type': 'boolean'
  �[31m-�[39m   }
  �[31m-�[39m ]
  
      at TestContext.<anonymous> (file:.../sections/__tests__/event.test.mjs:328:14)
      at Test.runInAsyncScope (node:async_hooks:214:14)
      at Test.run (node:internal/test_runner/test:1106:25)
      at Suite.processPendingSubtests (node:internal/test_runner/test:788:18)
      at Test.postRun (node:internal/test_runner/test:1235:19)
      at Test.run (node:internal/test_runner/test:1163:12)
      at async Suite.processPendingSubtests (node:internal/test_runner/test:788:7) {
    generatedMessage: true,
    code: 'ERR_ASSERTION',
    actual: [],
    expected: [ [Object] ],
    operator: 'deepStrictEqual',
    diff: 'simple'
  }
}

test::[<boolean>](https://mdn-link)

Stack Traces | 0.000615s run time

Error [ERR_TEST_FAILURE]: Expected values to be strictly deep-equal:
�[32m+ actual�[39m �[31m- expected�[39m

�[39m  [
�[39m    {
�[32m+�[39m     '@name': undefined,
�[31m-�[39m     '@name': 'value',
�[39m      '@type': 'boolean',
�[32m+�[39m     description: undefined
�[39m    }
�[39m  ]

    at new Promise (<anonymous>)
    at Array.map (<anonymous>) {
  code: 'ERR_TEST_FAILURE',
  failureType: 'testCodeFailure',
  cause: AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
  �[32m+ actual�[39m �[31m- expected�[39m
  
  �[39m  [
  �[39m    {
  �[32m+�[39m     '@name': undefined,
  �[31m-�[39m     '@name': 'value',
  �[39m      '@type': 'boolean',
  �[32m+�[39m     description: undefined
  �[39m    }
  �[39m  ]
  
      at TestContext.<anonymous> (file:.../sections/__tests__/event.test.mjs:622:14)
      at Test.runInAsyncScope (node:async_hooks:214:14)
      at Test.run (node:internal/test_runner/test:1106:25)
      at Test.start (node:internal/test_runner/test:1003:17)
      at node:internal/test_runner/test:1516:71
      at node:internal/per_context/primordials:466:82
      at new Promise (<anonymous>)
      at new SafePromise (node:internal/per_context/primordials:435:3)
      at node:internal/per_context/primordials:466:9
      at Array.map (<anonymous>) {
    generatedMessage: true,
    code: 'ERR_ASSERTION',
    actual: [ [Object] ],
    expected: [ [Object] ],
    operator: 'deepStrictEqual',
    diff: 'simple'
  }
}

test::Type: [<boolean>](https://mdn-link) | [<string>](https://mdn-link)

Stack Traces | 0.000619s run time

Error [ERR_TEST_FAILURE]: Expected values to be strictly deep-equal:
�[32m+ actual�[39m �[31m- expected�[39m

�[39m  [
�[39m    {
�[32m+�[39m     '@name': undefined,
�[31m-�[39m     '@name': 'value',
�[39m      '@type': [
�[39m        'boolean',
�[39m        'string'
�[39m      ],
�[32m+�[39m     description: undefined
�[39m    }
�[39m  ]

    at async Promise.all (index 0) {
  code: 'ERR_TEST_FAILURE',
  failureType: 'testCodeFailure',
  cause: AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
  �[32m+ actual�[39m �[31m- expected�[39m
  
  �[39m  [
  �[39m    {
  �[32m+�[39m     '@name': undefined,
  �[31m-�[39m     '@name': 'value',
  �[39m      '@type': [
  �[39m        'boolean',
  �[39m        'string'
  �[39m      ],
  �[32m+�[39m     description: undefined
  �[39m    }
  �[39m  ]
  
      at TestContext.<anonymous> (file:.../sections/__tests__/event.test.mjs:507:14)
      at Test.runInAsyncScope (node:async_hooks:214:14)
      at Test.run (node:internal/test_runner/test:1106:25)
      at Suite.processPendingSubtests (node:internal/test_runner/test:788:18)
      at Test.postRun (node:internal/test_runner/test:1235:19)
      at Test.run (node:internal/test_runner/test:1163:12)
      at async Promise.all (index 0)
      at async Suite.run (node:internal/test_runner/test:1518:7)
      at async Suite.processPendingSubtests (node:internal/test_runner/test:788:7) {
    generatedMessage: true,
    code: 'ERR_ASSERTION',
    actual: [ [Object] ],
    expected: [ [Object] ],
    operator: 'deepStrictEqual',
    diff: 'simple'
  }
}

test::Type: [<boolean>](https://mdn-link)

Stack Traces | 0.000952s run time

Error [ERR_TEST_FAILURE]: Expected values to be strictly deep-equal:
�[32m+ actual�[39m �[31m- expected�[39m

�[39m  [
�[39m    {
�[32m+�[39m     '@name': undefined,
�[31m-�[39m     '@name': 'value',
�[39m      '@type': 'boolean',
�[32m+�[39m     description: undefined
�[39m    }
�[39m  ]

    at new Promise (<anonymous>)
    at Array.map (<anonymous>) {
  code: 'ERR_TEST_FAILURE',
  failureType: 'testCodeFailure',
  cause: AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
  �[32m+ actual�[39m �[31m- expected�[39m
  
  �[39m  [
  �[39m    {
  �[32m+�[39m     '@name': undefined,
  �[31m-�[39m     '@name': 'value',
  �[39m      '@type': 'boolean',
  �[32m+�[39m     description: undefined
  �[39m    }
  �[39m  ]
  
      at TestContext.<anonymous> (file:.../sections/__tests__/event.test.mjs:437:14)
      at Test.runInAsyncScope (node:async_hooks:214:14)
      at Test.run (node:internal/test_runner/test:1106:25)
      at Test.start (node:internal/test_runner/test:1003:17)
      at node:internal/test_runner/test:1516:71
      at node:internal/per_context/primordials:466:82
      at new Promise (<anonymous>)
      at new SafePromise (node:internal/per_context/primordials:435:3)
      at node:internal/per_context/primordials:466:9
      at Array.map (<anonymous>) {
    generatedMessage: true,
    code: 'ERR_ASSERTION',
    actual: [ [Object] ],
    expected: [ [Object] ],
    operator: 'deepStrictEqual',
    diff: 'simple'
  }
}

test::`paramName` [<boolean>](https://mdn-link)

Stack Traces | 0.00128s run time

Error [ERR_TEST_FAILURE]: Expected values to be strictly deep-equal:
�[32m+ actual�[39m �[31m- expected�[39m

�[39m  [
�[39m    {
�[39m      '@name': 'paramName',
�[39m      '@type': 'boolean',
�[32m+�[39m     description: undefined
�[39m    }
�[39m  ]

    at async Promise.all (index 0) {
  code: 'ERR_TEST_FAILURE',
  failureType: 'testCodeFailure',
  cause: AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
  �[32m+ actual�[39m �[31m- expected�[39m
  
  �[39m  [
  �[39m    {
  �[39m      '@name': 'paramName',
  �[39m      '@type': 'boolean',
  �[32m+�[39m     description: undefined
  �[39m    }
  �[39m  ]
  
      at TestContext.<anonymous> (file:.../sections/__tests__/event.test.mjs:139:14)
      at Test.runInAsyncScope (node:async_hooks:214:14)
      at Test.run (node:internal/test_runner/test:1106:25)
      at Suite.processPendingSubtests (node:internal/test_runner/test:788:18)
      at Test.postRun (node:internal/test_runner/test:1235:19)
      at Test.run (node:internal/test_runner/test:1163:12)
      at async Promise.all (index 0)
      at async Suite.run (node:internal/test_runner/test:1518:7)
      at async Suite.processPendingSubtests (node:internal/test_runner/test:788:7) {
    generatedMessage: true,
    code: 'ERR_ASSERTION',
    actual: [ [Object] ],
    expected: [ [Object] ],
    operator: 'deepStrictEqual',
    diff: 'simple'
  }
}

test::`paramName` [<boolean>](https://mdn-link) | [<string>](https://mdn-link)

Stack Traces | 0.00218s run time

[Error [ERR_TEST_FAILURE]: Expected values to be strictly deep-equal:
�[32m+ actual�[39m �[31m- expected�[39m

�[39m  [
�[39m    {
�[39m      '@name': 'paramName',
�[39m      '@type': [
�[39m        'boolean',
�[39m        'string'
�[39m      ],
�[32m+�[39m     description: undefined
�[39m    }
�[39m  ]
] {
  code: 'ERR_TEST_FAILURE',
  failureType: 'testCodeFailure',
  cause: AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
  �[32m+ actual�[39m �[31m- expected�[39m
  
  �[39m  [
  �[39m    {
  �[39m      '@name': 'paramName',
  �[39m      '@type': [
  �[39m        'boolean',
  �[39m        'string'
  �[39m      ],
  �[32m+�[39m     description: undefined
  �[39m    }
  �[39m  ]
  
      at TestContext.<anonymous> (file:.../sections/__tests__/event.test.mjs:213:14)
      at Test.runInAsyncScope (node:async_hooks:214:14)
      at Test.run (node:internal/test_runner/test:1106:25)
      at Suite.processPendingSubtests (node:internal/test_runner/test:788:18)
      at Test.postRun (node:internal/test_runner/test:1235:19)
      at Test.run (node:internal/test_runner/test:1163:12)
      at async Suite.processPendingSubtests (node:internal/test_runner/test:788:7) {
    generatedMessage: true,
    code: 'ERR_ASSERTION',
    actual: [ [Object] ],
    expected: [ [Object] ],
    operator: 'deepStrictEqual',
    diff: 'simple'
  }
}

test::`paramName`

Stack Traces | 0.0032s run time

Error [ERR_TEST_FAILURE]: Expected values to be strictly deep-equal:
�[32m+ actual�[39m �[31m- expected�[39m

�[32m+�[39m []
�[31m-�[39m [
�[31m-�[39m   {
�[31m-�[39m     '@name': 'paramName',
�[31m-�[39m     '@type': 'any'
�[31m-�[39m   }
�[31m-�[39m ]

    at new Promise (<anonymous>)
    at Array.map (<anonymous>) {
  code: 'ERR_TEST_FAILURE',
  failureType: 'testCodeFailure',
  cause: AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
  �[32m+ actual�[39m �[31m- expected�[39m
  
  �[32m+�[39m []
  �[31m-�[39m [
  �[31m-�[39m   {
  �[31m-�[39m     '@name': 'paramName',
  �[31m-�[39m     '@type': 'any'
  �[31m-�[39m   }
  �[31m-�[39m ]
  
      at TestContext.<anonymous> (file:.../sections/__tests__/event.test.mjs:79:14)
      at Test.runInAsyncScope (node:async_hooks:214:14)
      at Test.run (node:internal/test_runner/test:1106:25)
      at Test.start (node:internal/test_runner/test:1003:17)
      at node:internal/test_runner/test:1516:71
      at node:internal/per_context/primordials:466:82
      at new Promise (<anonymous>)
      at new SafePromise (node:internal/per_context/primordials:435:3)
      at node:internal/per_context/primordials:466:9
      at Array.map (<anonymous>) {
    generatedMessage: true,
    code: 'ERR_ASSERTION',
    actual: [],
    expected: [ [Object] ],
    operator: 'deepStrictEqual',
    diff: 'simple'
  }
}

test::`something.doThingWithReturnType()`

Stack Traces | 0.00343s run time

Error [ERR_TEST_FAILURE]: Expected values to be strictly deep-equal:
�[32m+ actual�[39m �[31m- expected�[39m

�[39m  {
�[39m    signatures: [
�[39m      {
�[39m        '@returns': {
�[32m+�[39m         '@type': 'any'
�[31m-�[39m         '@type': 'string',
�[31m-�[39m         description: 'A description bla bla bla'
�[39m        },
�[39m        parameters: undefined
�[39m      }
�[39m    ]
�[39m  }

    at async Promise.all (index 0) {
  code: 'ERR_TEST_FAILURE',
  failureType: 'testCodeFailure',
  cause: AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
  �[32m+ actual�[39m �[31m- expected�[39m
  
  �[39m  {
  �[39m    signatures: [
  �[39m      {
  �[39m        '@returns': {
  �[32m+�[39m         '@type': 'any'
  �[31m-�[39m         '@type': 'string',
  �[31m-�[39m         description: 'A description bla bla bla'
  �[39m        },
  �[39m        parameters: undefined
  �[39m      }
  �[39m    ]
  �[39m  }
  
      at TestContext.<anonymous> (file:.../sections/__tests__/method.test.mjs:114:12)
      at Test.runInAsyncScope (node:async_hooks:214:14)
      at Test.run (node:internal/test_runner/test:1106:25)
      at Suite.processPendingSubtests (node:internal/test_runner/test:788:18)
      at Test.postRun (node:internal/test_runner/test:1235:19)
      at Test.run (node:internal/test_runner/test:1163:12)
      at async Promise.all (index 0)
      at async Suite.run (node:internal/test_runner/test:1518:7)
      at async startSubtestAfterBootstrap (node:internal/test_runner/harness:358:3) {
    generatedMessage: true,
    code: 'ERR_ASSERTION',
    actual: { signatures: [Array] },
    expected: { signatures: [Array] },
    operator: 'deepStrictEqual',
    diff: 'simple'
  }
}

To view more test analytics, go to the Test Analytics Dashboard
_{📋 Got 3 mins? Take this short survey to help us improve Test Analytics.}

avivkeller · 2025-09-30T01:14:13Z

@flakey5 is this still in progress? Need any help?

flakey5 · 2025-09-30T01:54:04Z

Still in progress just haven't been committing, I do wanna get this ready for review within the next coming weeks though

vercel · 2025-10-06T20:16:35Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
api-docs-tooling	Ready	Preview	Jan 10, 2026 4:32am

flakey5 · 2025-11-10T16:47:17Z

Bulk of this is done, with only two main things left:

Couple of failing tests for createParameterGroupings
Adding the @constructor property to class sections

I'm leaving this as a draft until those are done, but the rest is ready for review

avivkeller

the rest is ready for review

I've left a first round of reviews. Thank you so much for this effort!

src/utils/generator-error.mjs

src/generators/json/utils/stringifyNode.mjs

src/generators/json/utils/createSectionBase.mjs

src/generators/json/utils/createMethodSection.mjs

src/generators/json/utils/createModuleSection.mjs

src/generators/json/constants.mjs

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

src/generators/json-all/index.mjs

src/generators/index.mjs

tools/generate-json-types.mjs

flakey5 · 2025-11-29T02:49:36Z

Marking ready for review, should be all there minus #287 (comment)

src/generators/json-all/index.mjs

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

src/generators/json/constants.mjs

src/generators/json/index.mjs

src/generators/json/utils/sections/index.mjs

src/utils/generator-error.mjs

src/generators/json/utils/sections/event.mjs

Copilot

Pull request overview

This PR introduces new JSON generators (json and json-all) for the Node.js documentation toolkit, providing machine-readable JSON representations of API documentation.

Key Changes:

New json generator that outputs individual JSON files for each API module with comprehensive type information, method signatures, properties, and events
New json-all generator that combines all JSON outputs into a single file
Comprehensive JSON schema definition with TypeScript type generation support

Reviewed changes

Copilot reviewed 39 out of 44 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
`src/generators/json/index.mjs`	Main JSON generator implementation
`src/generators/json-all/index.mjs`	Aggregator generator for combined JSON output
`src/generators/json/schema.jsonc`	JSON schema definition for documentation structure
`src/generators/json/utils/sections/*.mjs`	Section parsers for modules, classes, methods, properties, and events
`src/generators/json/utils/parseTypeList.mjs`	Type list parsing utility
`src/generators/json/utils/createParameterGroupings.mjs`	Method signature parameter grouping logic
`src/utils/buildHierarchy.mjs`	Shared utility for building hierarchical entry structures
`src/utils/assertAstType.mjs`	AST node type assertion utilities
`src/utils/generator-error.mjs`	Custom error class for generator errors
`src/utils/unist.mjs`	Enhanced node transformation with support for break, delete, and link nodes
`scripts/generate-json-types.mjs`	Script to generate TypeScript definitions from JSON schema
`package.json`	New dependencies for JSON parsing and schema validation
`.github/workflows/generate.yml`	CI workflow integration for JSON generator

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

scripts/generate-json-types.mjs

src/generators/json/utils/sections/method.mjs

src/generators/json/utils/sections/__tests__/base.test.mjs

src/generators/json/schema.jsonc

src/generators/json/utils/sections/index.mjs

src/generators/json/schema.jsonc

avivkeller

More comments :-)

src/generators/json/utils/sections/base.mjs

src/generators/json/utils/sections/index.mjs

src/generators/json/constants.mjs

src/generators/json-all/index.mjs

src/generators/json/utils/findParentSection.mjs

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

flakey5 · 2026-01-08T01:58:46Z

src/generators/json/utils/sections/index.mjs

+
+  return {
+    $schema: `${BASE_URL}docs/${version}/api/${SCHEMA_FILENAME}`,
+    source: head.api_doc_source,


Currently this is something like doc/api/buffer.md, I wonder if it'd be more useful to give an actual link to the source file like https://nodejs.org/docs/v25.0.0/api/buffer.md

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

Co-authored-by: Aviv Keller <me@aviv.sh>

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

Co-authored-by: Aviv Keller <me@aviv.sh>

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

avivkeller · 2026-02-03T14:45:56Z

(Re-requesting my review as a reminder to myself to review this later today)

avivkeller

Keep up the good work!

avivkeller · 2026-02-04T22:10:10Z

src/generators/json/utils/sections/base.mjs

+  if (typeof index !== 'number') {
+    index = Number(index);
+  }


When will this not be a number?

avivkeller · 2026-02-04T22:10:42Z

src/generators/json/utils/sections/base.mjs

+  if (entry.changes.length > 0) {
+    section.changes = entry.changes.map(change => ({
+      description: change.description,
+      prUrl: change['pr-url'],
+      version: enforceArray(change.version),
+    }));
+  }
+
+  if (entry.added_in) {
+    section['@since'] = enforceArray(entry.added_in);
+  }
+
+  if (entry.n_api_version) {
+    section.napiVersion = enforceArray(entry.n_api_version);
+  }
+
+  if (entry.removed_in) {
+    section.removedIn = enforceArray(entry.removed_in);
+  }
+
+  if (entry.deprecated_in) {
+    section['@deprecated'] = enforceArray(entry.deprecated_in);
+  }


I think we should get in the habit of always supplying these prompts, even if they are empty/undefined

wdyt @ovflwod

avivkeller · 2026-02-04T22:12:08Z

src/generators/json/utils/sections/method.mjs

+    } else {
+      // Put static methods in `staticMethods` property and non-static methods
+      // in the `methods` property
+      property = entry.heading.data.text.startsWith('Static method:')


This should be picked up by the classMethod RegEx, right? Do we need to check it here as well?

avivkeller mentioned this pull request Jun 24, 2025

feat(web): add web generator #285

Merged

6 tasks

flakey5 force-pushed the flakey5/20240909/new-json-gen branch from a4cd425 to d711fee Compare October 6, 2025 20:16

vercel bot deployed to Preview October 6, 2025 20:19 View deployment

vercel bot deployed to Preview October 6, 2025 23:19 View deployment

flakey5 mentioned this pull request Oct 11, 2025

Making it easier for DTS consumers #441

Open

flakey5 force-pushed the flakey5/20240909/new-json-gen branch from 2d10df1 to e4dbbe4 Compare October 23, 2025 04:17

vercel bot deployed to Preview October 23, 2025 04:20 View deployment

vercel bot deployed to Preview October 23, 2025 18:16 View deployment

vercel bot deployed to Preview October 27, 2025 00:44 View deployment

flakey5 force-pushed the flakey5/20240909/new-json-gen branch from 6bfc555 to 1bcf93d Compare November 10, 2025 16:42

vercel bot deployed to Preview November 10, 2025 16:45 View deployment

avivkeller reviewed Nov 12, 2025

View reviewed changes

vercel bot deployed to Preview November 16, 2025 08:02 View deployment

vercel bot deployed to Preview November 29, 2025 01:15 View deployment

flakey5 force-pushed the flakey5/20240909/new-json-gen branch from ee1684d to b37daee Compare November 29, 2025 02:34

vercel bot deployed to Preview November 29, 2025 02:36 View deployment

flakey5 force-pushed the flakey5/20240909/new-json-gen branch from b37daee to 8ebb3d6 Compare November 29, 2025 02:44

vercel bot deployed to Preview November 29, 2025 02:46 View deployment

flakey5 marked this pull request as ready for review November 29, 2025 02:49

flakey5 requested a review from a team as a code owner November 29, 2025 02:49

avivkeller reviewed Nov 29, 2025

View reviewed changes

vercel bot deployed to Preview November 30, 2025 05:19 View deployment

vercel bot deployed to Preview November 30, 2025 06:33 View deployment

ovflowd reviewed Nov 30, 2025

View reviewed changes

src/generators/json/utils/sections/event.mjs Outdated Show resolved Hide resolved

Copilot finished reviewing on behalf of avivkeller December 3, 2025 22:54

Copilot AI reviewed Dec 3, 2025

View reviewed changes

avivkeller added this to the Web Generator Migration milestone Dec 3, 2025

avivkeller reviewed Dec 4, 2025

View reviewed changes

avivkeller mentioned this pull request Dec 23, 2025

Intertwined JavaScript + Markdown Parsing #530

Open

feat: json, json-all generators

0ec318d

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

flakey5 force-pushed the flakey5/20240909/new-json-gen branch from 1cf5261 to 0ec318d Compare January 7, 2026 23:54

vercel bot had a problem deploying to Preview January 7, 2026 23:54 Failure

flakey5 commented Jan 8, 2026

View reviewed changes

review, some things broken

b5d67be

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

vercel bot had a problem deploying to Preview January 8, 2026 02:03 Failure

Apply suggestions from code review

db2ce37

Co-authored-by: Aviv Keller <me@aviv.sh>

vercel bot had a problem deploying to Preview January 8, 2026 02:05 Failure

(hopefully) fix ci

fc0bde9

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

vercel bot had a problem deploying to Preview January 8, 2026 02:30 Failure

actual fix ci

e684db8

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

vercel bot deployed to Preview January 8, 2026 03:45 View deployment

actually fix ci

557b9b6

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

vercel bot deployed to Preview January 8, 2026 04:56 View deployment

little bit more coverage for methods

ae34640

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

vercel bot deployed to Preview January 8, 2026 05:24 View deployment

Update src/generators/json/utils/sections/base.mjs

5bf3c64

Co-authored-by: Aviv Keller <me@aviv.sh>

vercel bot deployed to Preview January 9, 2026 23:32 View deployment

fix schema tests

5689d4c

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

vercel bot deployed to Preview January 10, 2026 00:20 View deployment

dedupe things, still some todos left tho

8fd003d

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

vercel bot deployed to Preview January 10, 2026 04:32 View deployment

avivkeller self-requested a review February 3, 2026 14:45

avivkeller reviewed Feb 4, 2026

View reviewed changes

Conversation

flakey5 commented May 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented May 31, 2025 • edited by codecov bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ 14 Tests Failed:

Uh oh!

avivkeller commented Sep 30, 2025

Uh oh!

flakey5 commented Sep 30, 2025

Uh oh!

vercel bot commented Oct 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

flakey5 commented Nov 10, 2025

Uh oh!

avivkeller left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

flakey5 commented Nov 29, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

avivkeller left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

flakey5 Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

avivkeller commented Feb 3, 2026

Uh oh!

avivkeller left a comment

Choose a reason for hiding this comment

Uh oh!

avivkeller Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

flakey5 commented May 31, 2025 •

edited

Loading

codecov-commenter commented May 31, 2025 •

edited by codecov bot

Loading

vercel bot commented Oct 6, 2025 •

edited

Loading