Microsoft/TypeScript

Document --incremental and composite project APIs

Open

#31,849 opened on Jun 10, 2019

View on GitHub
 (50 comments) (6 reactions) (2 assignees)TypeScript (48,455 stars) (6,726 forks)batch import
DocsDomain: APIFix AvailableHelp Wanted

Description

Follow-up from #29978, suggested by @MLoughry at https://github.com/microsoft/TypeScript/issues/29978#issuecomment-499674541

Contributor guide

Tech stack
typescript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript basicsincremental compilation concept
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Review the discussion in #29978, particularly the comment at https://github.com/microsoft/TypeScript/issues/29978#issuecomment 499674541. Look at the TypeScript compiler codebase for ` incremental` and composite project APIs. Focus on documenting these APIs as outlined in the referenced issue.