-
Notifications
You must be signed in to change notification settings - Fork 12.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update documentation in protocol.d.ts #11501
Conversation
content?: string; | ||
} | ||
|
||
/** | ||
* Represent an external project |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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..
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✔️
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few changes about project types and compile on save.
export interface SetCompilerOptionsForInferredProjectsRequest extends Request { | ||
arguments: SetCompilerOptionsForInferredProjectsArgs; | ||
} | ||
|
||
/** | ||
* Argument for SetCompilerOptionsForInferredProjectsRequest request. | ||
*/ | ||
export interface SetCompilerOptionsForInferredProjectsArgs { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should elaborate on what "InferredProjects" are, and how they are different from "external" projects, and normal projects.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✔️
@@ -754,23 +964,47 @@ declare namespace ts.server.protocol { | |||
export interface CloseRequest extends FileRequest { | |||
} | |||
|
|||
/** | |||
* Request to obtain the list of files that should be regenerated if target file is recompiled. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add a note, that this does not generate any outputs. and a reference to CompileOnSaveEmitFileRequest
for generation.,
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✔️
export interface CompileOnSaveAffectedFileListResponse extends Response { | ||
body: CompileOnSaveAffectedFileListSingleProject[]; | ||
} | ||
|
||
/** | ||
* Request to recompile the file. | ||
*/ | ||
export interface CompileOnSaveEmitFileRequest extends FileRequest { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i would make it clear that this actually writes files to disk.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✔️
@@ -966,6 +978,7 @@ declare namespace ts.server.protocol { | |||
|
|||
/** | |||
* 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
type: this is a query-only operation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✔️
@@ -992,7 +1005,7 @@ declare namespace ts.server.protocol { | |||
} | |||
|
|||
/** | |||
* Request to recompile the file. | |||
* Request to recompile the file. Result file is written on disk. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All generated outputs (e.g. .js
, .d.ts
, .js.map`) will be written to disk as a result of this request.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✔️
@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.