Skip to content
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

Merged
merged 3 commits into from
Oct 10, 2016
Merged

Conversation

vladima
Copy link
Contributor

@vladima vladima commented Oct 10, 2016

fixes #11486

NOTE: seems that we lack response types for majority of new messages, I'll add them in the follow-up PR.

content?: string;
}

/**
* Represent an external project
Copy link
Contributor

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..

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✔️

Copy link
Contributor

@mhegazy mhegazy left a 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 {
Copy link
Contributor

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.

Copy link
Contributor Author

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.
Copy link
Contributor

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.,

Copy link
Contributor Author

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 {
Copy link
Contributor

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.

Copy link
Contributor Author

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.
Copy link
Contributor

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

Copy link
Contributor Author

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.
Copy link
Contributor

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✔️

@vladima vladima merged commit 997acae into master Oct 10, 2016
@vladima vladima deleted the vladima/update-documentation branch October 10, 2016 23:04
@mhegazy
Copy link
Contributor

mhegazy commented Oct 10, 2016

@vladima can you port this to release-2.0.5 branch

vladima added a commit that referenced this pull request Oct 11, 2016
update documentation in protocol.d.ts
vladima added a commit that referenced this pull request Oct 12, 2016
update documentation in protocol.d.ts
vladima added a commit that referenced this pull request Oct 12, 2016
@microsoft microsoft locked and limited conversation to collaborators Jun 19, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2.0.6 TSServer protocol.d.ts: new features are missing documentation
3 participants