Exposing structured JSDoc for TypeScript declarations in oxc-parser / Node.js

[EliteUser]

Hi, I’m trying to use oxc-parser in Node.js for extracting documentation from TypeScript type declarations.

My very simplified target use case is something like:

export type ButtonProps = {
  /**
   * Button size.
   *
   * @default m
   */
  size?: ButtonSize;
}

What I want is a structured, easy-to-traverse result that includes both:

the original TypeScript declaration structure
the structured JSDoc attached to the relevant property

For example, for size I’d like to get something like:

• property name: size
• optional: true
• type: ButtonSize
• description: Button size.
• tags: @default m

From what I understand so far:

• oxc-parser can parse the TypeScript AST
• comments are returned separately in parsed.comments
• there is also JSDoc parsing logic in Rust internally

So my question is:

Can this be done out of the box by oxc-parser today, especially in Node.js, or is the intended approach to manually match comments to AST nodes by spans/ranges and then parse the JSDoc separately?

More specifically:

Is there already a supported way to get structured JSDoc for TS properties/interfaces/type literals from oxc-parser?
If not, is manual comment attachment by span/range the recommended approach today?
Are there plans to expose a unified structure where TS declaration nodes can have attached structured JSDoc, at least for common documentation-extraction use cases?

My goal is to build a prop/type documentation extractor, so having this available directly from the parser would be very useful.

Thanks.

[camc314]

Can this be done out of the box by oxc-parser today, especially in Node.js, or is the intended approach to manually match comments to AST nodes by spans/ranges and then parse the JSDoc separately?

Hi, unfortunately we do not parse jsdoc comments yet.

The best solution to your problem at present it probably to use oxc-parser to parse the ast + get all comments, then use a jsdoc parsing library to parse the content within the comment.

Is there already a supported way to get structured JSDoc for TS properties/interfaces/type literals from oxc-parser?
no

If not, is manual comment attachment by span/range the recommended approach today?
yes
Are there plans to expose a unified structure where TS declaration nodes can have attached structured JSDoc, at least for common documentation-extraction use cases?

not at present (this may change if we see increased demand for this requirement)