microsoft / microsoft/TypeScript
Review the project setup experience
Open
@DanielRosenwasser is already working on this.
Since Nov 18, 2020.
Needs Proposal
Rescheduled
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Today, tsc --init creates a big-ol' file that is super intimidating. We try to provide comments and blocks of sections to give people a clear separation of config concerns. We also provide a link to https://aka.ms/tsconfig.json.
We also have a belief that most people don't even use tsc --init.
That said, there are problems, and tsc --init doesn't make it totally clear what the "best practices" are for starting a project. Things that are missing:
- Project layout guidance (e.g.
src,tsconfignaming) - "well known"/"blessed" flags as opposed to just ONE BIG PAGE of ALL THE FLAGS 😨
- Easy way to find the information regardless of whether a user used
tsc --init
In short:
- Docs for tsconfig.json "getting started"
- Link to that in generated tsconfig.json
- Re-evaluate generated tsconfig content.
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.
Assessment
This issue has not been assessed yet.