microsoft / microsoft/TypeScript
The Symbol interface of the compiler is undocumented
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: master
Search Terms: Symbol interface compiler
Code
The "Using the Compiler API" docs have examples which use Symbols, but they don't say what they are and neither do the API docs in the source.
It'd be incredibly helpful if the core compiler types were at least minimally documented, along with a few of the TypeChecker methods.
Context:
I'm trying to use the compiler API for linting and want to verify that an identifier references a particular declaration.
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 with src/services/types.ts at the linked Symbol interface, then compare it with the Using the Compiler API wiki examples and the API docs in the source. Identify the core compiler types and a few TypeChecker methods that need minimal explanations. Done means the Symbol interface and selected methods are documented clearly enough for compiler API users to understand identifier-to-declaration checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100