Skip to content

Improve the project documentation and provide a better HowToGuide and simple code demo/test project for jsonrpc #914

@cmoulliard

Description

@cmoulliard

Proposition

Improve the project documentation and provide a better HowToGuide and simple code demo/test project for jsonrpc to let the users to better figure out what they should do

List of changes proposed

  • Review the json rpc and getting started md guides
  • Articulate the guide around a simple use case where the language server will by example search about a word in a dummy text packaged within the project and user will be able to query the language server to search about a text word
  • Create a demo project similar to this one implementing the different pieces; LanguageServer, LanguageClient, etc
  • Use JSON RPC annotations to create the user's request or get notification
  • Merge the README with the jsonrpc guides
  • Add/list some interesting blog posts

Remark: The code of this example project https://github.com/TypeFox/lsp4j-chat-app/blob/master/src/main/java/io/typefox/lsp4j/chat/server/ChatServerLauncher.java#L39C6-L39C54 is outdated and the following methid don't exist anymore launcher.startListening().thenRun(removeClient);

@akosyakov

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions