microsoft / microsoft/TypeScript

[tsserver] documentation "about how to implement tsClient?"

Open
#5,923 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Docs
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

I'm implementing tsClient inside Eclipse, but it's very hard for me, because there are no documentation about protocol. So I study implementation with sublime, vim and vscode, but it's not my language, so it's a little hard.

So, it should be very cool if you could provide a documentation to implement tsClient, I mean request/response protocol.

We could take a simple sample:

  • open a document.
  • do a completion.
  • change the editor content to show how to synchronize editor with tsserver. There are 2 means to do that:
    • use "change" (I must study why it doesn't work for me, but if I have a documentation, it will help me a lot).
    • use "tmpfile"
  • do a completion again with the editor which have changed.
  • close the document.

To explain that, you could starts tsserver with Windows cmd, and shows request/response. So any user will able to play with your tsserver.

After that you could speak about advanced topic like validation with event.

Thanks for your help!

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 tsserver and its request/response protocol, using Windows cmd to observe the interaction. Document opening a document, requesting completion, synchronizing edits with change or tmpfile, requesting completion again, and closing the document; include validation events as an advanced topic. Done means a user can follow the example to implement a basic tsClient.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.