File: README.md

package info (click to toggle)
rust-lsp-textdocument 0.4.2-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 148 kB
  • sloc: makefile: 2
file content (43 lines) | stat: -rw-r--r-- 1,408 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# `lsp-textdocument`

A LSP text documents manager that helps mapping of textual content.

## Introduction

You may not be able to manage your text documents comfortably when developing an LSP service. There are two reasons why we develop hard.

- Always given a URL variable only, so we need to read the contents of the file ourselves.
- Need map offsets from string index to text dimensional coordinates.

By listening to the notification from the LSP client, `lsp-textdocument` can help you automatically manage text documents.

This crate is base on [vscode-languageserver-textdocument](https://github.com/microsoft/vscode-languageserver-node/tree/main/textDocument).

## Example usage

### Basic usage

```rust
use lsp_textdocument::TextDocuments;

fn main() {
    let text_documents = TextDocument::new();
    ...


    let text = text_documents.get_document_content(&url, None);
}
```

### with [`lsp-server`](https://github.com/rust-analyzer/lsp-server)

[`examples/with_lsp_server.rs`](/examples/with_lsp_server.rs)

### with [`tower-lsp`](https://github.com/ebkalderon/tower-lsp)

**Contact us via [issues](https://github.com/GiveMe-A-Name/lsp-textdocument/issues) if you require this with `tower-lsp`**

## Attention

- The text documents [position-encoding](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#positionEncodingKind) only supports `UTF-16`