TSServer protoco.d.ts refers to types from typescriptServices

[dbaeumer]

TypeScript Version: 2.0.6-insider
Code

The protocol.d.ts file refers to types from typeScriptServices. Since we pull the protocol.d.ts into VSCode to program against the proper version of the protocol the file should be fully self contained (the file is basically a specification). Types I recognized are missing:

TodoCommentDescriptor, EditorSettings, ScriptKind, TypingOptions, CompilerOptions, ts.TextChange,
ts.FormatCodeOptions

There is one additional type that is incorrectly referenced protocol.ProjectVersionInfo. Should only be ProjectVersionInfo

[dbaeumer]

@mhegazy @vladima can you please have a look. This makes it very hard to adopt the 2.0.6 branch.

[mhegazy]

I do not think we ever mean the protocle.d.ts to be a used in vacuum. It is easier and more maintainable for us to reuse definitions for common types instead of having to duplicate them all. not sure i see why this would be a blocker.

[vladima]

We can generate protocol.d.ts automatically by transitively pulling all referenced types into final .d.ts file. However I don't think it meets the bar to be fixed in 2.0.6 given that workaround exists - just copy all listed declarations from typescriptServices.

[dbaeumer]

It is a half blocker since it requires manual work on our end. With the work I did yesterday I consume the tsserver 'automatically' in our builds. But this only works nicely if I can consume the protocol.d.ts automatically as well.

I will handcraft a protocol.d.ts file for now. But please ping me when you guys make changes that are incompatible because it requires changing the protocol.d.ts file on our end.

We do have the same problem with our standalone editor as well and @alexandrudima wrote tooling to generate a single 'monaco.d.ts' file form n other files by selectively copying types. You might want to have a look at his tooling. May be you can borrow some code.

Alternatively you could think about specify the protocol in JSON schema and then clients can use tools to generate a protocol.d.ts. VS Code's debugger protocol is doing that and I have requests to do the same for the language server protocol.

[dbaeumer]

OK. I merged this by hand and it almost took me one hour.

To ensure that the protocol.d.ts is consistent (see the type mismatches I discovered reported in separate issues) and doesn't introduce any unwanted breakage I would like to ask you to make this clean for 2.0.6.

And I don't feel comfortable doing this by hand. If I mess something up VS Code will not work properly.

[mhegazy]

@vladima the enums in the protocol would not work for @dbaeumer, we need to make sure any enum in this file is a const enum.

[vladima]

ok, will do