microsoft / microsoft/language-server-protocol

Add support for hashcode in open text document request.

Open
#202 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

document synchronization feature-request
Dominant language
TypeScript
Stars
13k
Forks
1k
Avg merge
6d 1h
Merged PRs (30d)
10

Description

It would be great if the protocol supports another way of submitting open text document requests where only a file path and hashcode is sent. The server can compute the hash on its side when it has opened the file, and send a response back indicating if the hashes are the same. If the hash is different, the client can send over the entire file content. This would be a performance improvement in that the client only sends over the whole content if it's necessary. For big files, this would make a difference.

Contributor guide

No contributing guide indexed for this repository

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 by reviewing the open text document request and the proposed path-and-hash exchange described in this issue. Define how the server reports matching or differing hashes and when the client sends full content; done means the protocol behavior is specified consistently for large files.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/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.