microsoft / microsoft/TypeScript

tsserver: saveto command should also save inferred ("virtual") tsconfig

Open
#39,071 1 comment 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

tsserver saveto tsconfig

Suggestion

I want to store the content of the "virtual" tsconfig.json that is used by the ts server.

The Saveto comand stores source files. One might aswell allow to store the tsconfig.

Use Cases

I work on a code analysis component. Before I started to implement it, I created a vscode project to adjust settings and declaration files. Once everything worked as expected, I implemented the component that communicates with the tsserver. My implementation does not use a "physical" tsconfig. It relies on the tsconfig the server infers, based on commandline parameters and CompilerOptionsForInferredProjects.

My component updates ts and d.ts files in this virtual project based on user input. This is where problems might appear which are hard to debug within my limited "client".

For debugging and suport purposes I want to take a "snapshot" of the files the tsserver uses, and use vscode for further analysis.

Examples

The request sent to the server would look something like this:

{"arguments":{"tmpfile":"C:\\TEMP\\tsconfig.json","file":"tsconfig.json"},"command":"saveto","seq":0,"type":"request"}

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.

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 with the Saveto command in src/server/protocol.ts and review CompilerOptionsForInferredProjects, both named in the issue. Trace how inferred projects and their virtual tsconfig are represented before determining how a saveto request could snapshot one. Done means the command can store the inferred tsconfig for the described request without changing existing source-file behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.