microsoft / microsoft/TypeScript

Include types for TSConfig

Open
#38,674 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Search Terms

types for tsconfig

Suggestion

Include types for TSConfig.

Use Cases

Automation and code generation

Examples

I'd like an extensible way to create and modify TSConfig files, and to represent these files as objects.

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

@webstrand came up with a demo earlier today, that's somewhat manually extracted: https://gist.github.com/webstrand/68e33abe8073a1e6f56d25b722ea0db9

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.

Research direction

Start by reviewing the issue's linked gist and the requested automation and code-generation use cases. Define the scope of the TSConfig representation and the supported create and modify operations; done means the agreed configuration surface has usable TypeScript types and coverage for the stated use cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.