dsherret / dsherret/ts-morph

Documentation: Auto-generate a structures reference?

Open
#1,394 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
6.2k
Forks
238
Avg merge
2m
Merged PRs (30d)
1

Description

I've been rummaging around the ts-morph.com website for months, and I just keep wanting to see a reference directory on the structures ts-morph uses. Say, at `docs/references/structures`, I would like to see a list of fields on the structures at a glance, with hyperlinks to other structures which each field references.

This might also be a good use case for dogfooding ts-morph: using it to scan its own source code after a build, in [packages/ts-morph/src/structures](https://github.com/dsherret/ts-morph/tree/latest/packages/ts-morph/src/structures) to create Markdown pages.

Usually, what I end up doing is abusing Visual Studio Code with tricks like this:
```typescript
export type ResolveTypeUnion = Pick;
type A = ResolveTypeUnion;
// ^?
```

... and then hovering over "A" to see what happens. It's not very efficient.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the structures in packages/ts-morph/src/structures and the existing ts-morph.com documentation layout. Define the reference format under docs/references/structures, including how fields link to referenced structures and whether generation should use ts-morph after a build. Done means the structures are discoverable with accurate fields and working hyperlinks.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.