/unist-util-lsp

utility to convert between unist and language server protocol

Primary LanguageJavaScriptMIT LicenseMIT

unist-util-lsp

Build Coverage Downloads Size Sponsors Backers Chat

unist utility to convert positional info between unist and language server protocol

Contents

What is this?

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

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. In Node.js (version 16+), install with npm:

npm install unist-util-lsp

In Deno with esm.sh:

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

In browsers with esm.sh:

<script type="module">
  import {fromPoint, fromPosition, toPoint, toPosition} from 'https://esm.sh/unist-util-lsp@2?bundle'
</script>

Use

Say we have the following example.md:

## Hello **World**!

…and next to it a module example.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:

{
  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, fromPoint, fromPosition, toPoint, and toPosition. There is no default export.

fromPlace(place)

Convert a unist point or position to an LSP range.

Parameters
Returns

The LSP range (Range).

fromPoint(point)

Turn a unist point into an LSP position.

Parameters
  • point (Point) — the unist point to convert
Returns

The LSP position (LspPosition).

fromPosition(unistPosition)

Convert a unist position to an LSP range.

Parameters
  • unistPosition (UnistPosition) — the unist position to convert
Returns

The LSP range (Range).

toPoint(lspPosition)

Convert a language server protocol position to a unist point.

Parameters
  • lspPosition (LspPosition) — the LSP position to convert
Returns

The unist point (Point).

toPosition(range)

Convert an LSP range to a unist position.

Parameters
  • range (Range) — the LSP range to convert
Returns

The range converted to a unist position (UnistPosition).

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

Contribute

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

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

License

MIT © Remco Haszing