update documentation in protocol.d.ts#11501
Conversation
| } | ||
|
|
||
| /** | ||
| * Represent an external project |
There was a problem hiding this comment.
can you elaborate on what an external project is., and how it works, and the expectations in cases of having multiple tsconfig.json in it, etc..
mhegazy
left a comment
There was a problem hiding this comment.
A few changes about project types and compile on save.
| /** | ||
| * Argument for SetCompilerOptionsForInferredProjectsRequest request. | ||
| */ | ||
| export interface SetCompilerOptionsForInferredProjectsArgs { |
There was a problem hiding this comment.
we should elaborate on what "InferredProjects" are, and how they are different from "external" projects, and normal projects.
|
|
||
| /** | ||
| * Request to obtain the list of files that should be regenerated if target file is recompiled. | ||
| */ |
There was a problem hiding this comment.
I would add a note, that this does not generate any outputs. and a reference to CompileOnSaveEmitFileRequest for generation.,
| * Request to recompile the file. | ||
| */ | ||
| export interface CompileOnSaveEmitFileRequest extends FileRequest { | ||
| args: CompileOnSaveEmitFileRequestArgs; |
There was a problem hiding this comment.
i would make it clear that this actually writes files to disk.
|
|
||
| /** | ||
| * Request to obtain the list of files that should be regenerated if target file is recompiled. | ||
| * NOTE: this us query only operation and does not generate any output on disk. |
There was a problem hiding this comment.
type: this is a query-only operation
|
|
||
| /** | ||
| * Request to recompile the file. | ||
| * Request to recompile the file. Result file is written on disk. |
There was a problem hiding this comment.
All generated outputs (e.g. .js, .d.ts, .js.map`) will be written to disk as a result of this request.
|
@vladima can you port this to release-2.0.5 branch |
update documentation in protocol.d.ts
update documentation in protocol.d.ts
…ation ports #11501 into release-2.0.5
fixes #11486
NOTE: seems that we lack response types for majority of new messages, I'll add them in the follow-up PR.