unified

Project: syntax-tree/unist-util-source

Package: unist-util-source@4.0.1

  1. Dependents: 0
  2. unist utility to get the source of a value
  1. util 147
  2. utility 143
  3. unist 133
  4. unist-util 25
  5. node 25
  6. position 9
  7. source 3

unist-util-source

Build Coverage Downloads Size Sponsors Backers Chat

unist utility to get the source code of a node or position.

Contents

What is this?

This is a tiny utility that lets you get the source code of a node or position.

When should I use this?

This is super tiny utility useful when you want to display the source code of something in a file.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install with npm:

npm install unist-util-source

In Deno with esm.sh:

import {source} from "https://esm.sh/unist-util-source@4"

In browsers with esm.sh:

<script type="module">
  import {source} from "https://esm.sh/unist-util-source@4?bundle"
</script>

Use

Say our document example.md contains:

> + **[Hello](./example)**
>   world.

…and our module example.js looks as follows:

import {read} from 'to-vfile'
import {fromMarkdown} from 'mdast-util-from-markdown'
import {source} from 'unist-util-source'

const file = await read('example.md')
const tree = fromMarkdown(String(file))

const strong = tree.children[0].children[0].children[0].children[0].children[0]
console.log(source(strong, file))

…now running node example.js yields:

**[Hello](./example)**

API

This package exports the identifier source. There is no default export.

source(value, file)

Get the source of a node or at a position.

Parameters
Returns

Source of value in doc, if available (string?).

Types

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

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer