microsoft / microsoft/TypeScript

Review the project setup experience

Open
#41,580 13 comments 35 reactions 1 assignee View on GitHub

@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, tsconfig naming)
  • "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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.