microsoft / microsoft/TypeScript
Document how (lazy) type checking works
Open
Nobody has claimed this yet.
Docs
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Before the whole compiler and its API is documented, could you add a few details about the type checker:
- What normally forces the type checking and inference of a name?
- How TSC forces all types to be checked?
- What are the options for an application using the compiler API to control/force type checking?
Potentially relevant wiki pages for this information:
- https://github.com/microsoft/TypeScript/wiki/Architectural-Overview
- https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API
- https://github.com/microsoft/TypeScript/wiki/Compiler-Internals
Search Terms
documentation, type check, laziness, architecture, compiler API
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 the TypeScript wiki pages Architectural Overview, Using the Compiler API, and Compiler Internals. Trace how lazy type checking is described there and document what normally triggers checking, how TSC forces checking, and how compiler API applications can control it; done means all three questions are answered in the relevant wiki documentation.
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