dsherret / dsherret/ts-morph

Add missing JSDoc classes and methods

Open
#753 4 comments 0 reactions 0 assignees View on GitHub
enhancement good first issue
Dominant language
TypeScript
Stars
6.2k
Forks
238
Avg merge
2m
Merged PRs (30d)
1

Description

There are some missing JSDoc methods as seen in [this report](https://github.com/dsherret/ts-morph/blob/latest/packages/ts-morph/wrapped-nodes.md).

Summary:

* JSDocAugmentsTag
* `class`
* JSDocSignature
* `typeParameters`
* `parameters`
* JSDocTypedefTag
* `fullName`
* `typeExpression`
* JSDocPropertyLikeTag - Missing methods in this mixin

Missing classes:

* JSDocAllType
* JSDocAuthorTag
* JSDocCallbackTag
* JSDocEnumTag
* JSDocNamepathType
* JSDocNamespaceDeclaration
* JSDocNonNullableType
* JSDocNullableType
* JSDocOptionalType
* JSDocTemplateTag
* JSDocThisTag
* JSDocTypeLiteral
* JSDocUnknownType
* JSDocVariadicType

This would be an easy issue for someone to implement if they feel up for it.

Contributor guide

Open the contributing guide

Research direction

Start with the linked wrapped-nodes.md report and compare its missing JSDoc classes and members with the existing ts-morph API. Work through the explicitly listed classes, methods, and JSDocPropertyLikeTag mixin gaps, then verify that the report's missing entries are represented in the generated wrapper API.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.