microsoft / microsoft/TypeScript
expose API for --explainFiles
Open
Nobody has claimed this yet.
In Discussion
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Suggestion
Add an API to query the information that is already available for --explainFiles.
Use Cases
My tool needs to know why certain files are in the program to apply special handling to "user code" while leaving foreign code alone.
This would also close #26684 which asks for a subset of the information only.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing --explainFiles implementation and the API surface that exposes program file information. Read #26684 for the related subset request and determine how the API should provide the explanation data needed by tools. Done means the requested information is available through a usable API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100