microsoft / microsoft/TypeScript

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

Offen
#5,923 5 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Docs
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

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!

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit tsserver und seinem Request/Response-Protokoll und verwende Windows cmd, um die Interaktion zu beobachten. Dokumentiere das Öffnen eines Dokuments, das Anfordern von Vervollständigungen, das Synchronisieren von Änderungen mit change oder tmpfile, das erneute Anfordern von Vervollständigungen und das Schließen des Dokuments; beziehe Validierungsereignisse als fortgeschrittenes Thema ein. Als abgeschlossen gilt die Aufgabe, wenn ein Benutzer dem Beispiel folgen kann, um einen grundlegenden tsClient zu implementieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.