unist-util-lsp

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

[unist][] utility to convert positional info between [unist][] and
[language server protocol][lsp]

Contents

* What is this?
* When should I use this?
* Install
* Use
* API
* fromPlace(place)
* fromPoint(point)
* fromPosition(unistPosition)
* toPoint(lspPosition)
* toPosition(range)
* Types
* Compatibility
* Security
* Related
* Contribute
* License

What is this?

This package is a utility that converts positional info between [unist][] and
[language server protocol][lsp].

When should I use this?

You can use this package when you are dealing with both unist ASTs and a
language server.

Install

This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:

``sh
npm install unist-util-lsp
`

In Deno with [esm.sh][esmsh]:

`js
import {fromPoint, fromPosition, toPoint, toPosition} from 'https://esm.sh/unist-util-lsp@2'
`

In browsers with [esm.sh][esmsh]:

`html

`

Use

Say we have the following example.md:

`markdown


Hello World!


`

…and next to it a module example.js:

`js
import fs from 'node:fs/promises'
import {fromMarkdown} from 'mdast-util-from-markdown'
import {
fromPlace,
fromPoint,
fromPosition,
toPoint,
toPosition
} from 'unist-util-lsp'

const markdown = String(await fs.readFile('example.md'))
const mdast = fromMarkdown(markdown)

console.log(mdast.position)

const range = fromPosition(mdast.position)

console.log(range)

const position = toPosition(range)

console.log(position)

const startPosition = fromPoint(mdast.position.start)

console.log(startPosition)

const startPoint = toPoint(startPosition)

console.log(startPoint)

const fullRange = fromPlace(mdast.position)

console.log(fullRange)

const startRange = fromPlace(mdast.position.start)

console.log(startRange)
`

…now running node example.js yields:

`js
{
start: { line: 1, column: 1, offset: 0 },
end: { line: 2, column: 1, offset: 20 }
}
{ start: { character: 0, line: 0 }, end: { character: 0, line: 1 } }
{ start: { column: 1, line: 1 }, end: { column: 1, line: 2 } }
{ character: 0, line: 0 }
{ column: 1, line: 1 }
{ start: { character: 0, line: 0 }, end: { character: 0, line: 1 } }
{ start: { character: 0, line: 0 }, end: { character: 0, line: 0 } }
`

API

This package exports the identifiers [fromPlace][api-from-place],
[fromPoint][api-from-point], [fromPosition][api-from-position],
[toPoint][api-to-point], and [toPosition][api-to-position].
There is no default export.

$3

Convert a unist point or position to an LSP range.

###### Parameters

* place ([UnistPoint][point] | [UnistPosition][unist-position])
— the unist point or position to convert

###### Returns

The LSP range ([Range][range]).

$3

Turn a unist point into an LSP position.

###### Parameters

* point ([Point][point])
— the unist point to convert

###### Returns

The LSP position ([LspPosition][lsp-position]).

$3

Convert a unist position to an LSP range.

###### Parameters

* unistPosition ([UnistPosition][unist-position])
— the unist position to convert

###### Returns

The LSP range ([Range][range]).

$3

Convert a language server protocol position to a unist point.

###### Parameters

* lspPosition ([LspPosition][lsp-position])
— the LSP position to convert

###### Returns

The unist point ([Point][point]).

$3

Convert an LSP range to a unist position.

###### Parameters

* range ([Range][range])
— the LSP range to convert

###### Returns

The range converted to a unist position ([UnistPosition][unist-position]).

Types

This package is fully typed with [TypeScript][].
It exports no additional types.

Compatibility

Projects maintained by the unified collective are compatible with maintained
versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, unist-util-lsp@^2,
compatible with Node.js 16.

Security

This package is safe.

Related

* [unist][unist]
— specification for abstract syntax trees
* [Language server protocol][lsp]
— protocol to communicate between editors and language servers

Contribute

See [contributing.md in syntax-tree/.github][contributing] for ways to get
started.
See [support.md`][support] for ways to get help.

This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

License

[MIT][license] © [Remco Haszing][author]

[build-badge]: https://github.com/syntax-tree/unist-util-lsp/workflows/main/badge.svg

[build]: https://github.com/syntax-tree/unist-util-lsp/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/unist-util-lsp.svg

[coverage]: https://codecov.io/github/syntax-tree/unist-util-lsp

[downloads-badge]: https://img.shields.io/npm/dm/unist-util-lsp.svg

[downloads]: https://www.npmjs.com/package/unist-util-lsp

[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=unist-util-lsp

[size]: https://bundlejs.com/?q=unist-util-lsp

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/syntax-tree/unist/discussions

[lsp]: https://microsoft.github.io/language-server-protocol

[license]: license

[npm]: https://docs.npmjs.com/cli/install

[author]: https://github.com/remcohaszing

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[typescript]: https://www.typescriptlang.org

[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md

[support]: https://github.com/syntax-tree/.github/blob/main/support.md

[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md

[unist]: https://github.com/syntax-tree/unist

[point]: https://github.com/syntax-tree/unist#point

[unist-position]: https://github.com/syntax-tree/unist#position

[lsp-position]: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position

[range]: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#range

[api-from-place]: #fromplaceplace

[api-from-point]: #frompointpoint

[api-from-position]: #frompositionunistposition

[api-to-point]: #topointlspposition

[api-to-position]: #topositionrange