Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/syntax-tree/unist-util-source

utility to get the source of a node or position
https://github.com/syntax-tree/unist-util-source

source syntax-tree unist unist-util util

Last synced: 3 months ago
JSON representation

utility to get the source of a node or position

Awesome Lists containing this project

README 

        
# unist-util-source



[![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 get the source code of a node or position.



## Contents



*   [What is this?](#what-is-this)

*   [When should I use this?](#when-should-i-use-this)

*   [Install](#install)

*   [Use](#use)

*   [API](#api)

    *   [`source(file[, value])`](#sourcefile-value)

*   [Types](#types)

*   [Compatibility](#compatibility)

*   [Contribute](#contribute)

*   [License](#license)



## 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][esm].

In Node.js (version 16+), install with [npm][]:



```sh

npm install unist-util-source

```



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



```js

import {source} from 'https://esm.sh/unist-util-source@5'

```



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



```html



  import {source} from 'https://esm.sh/unist-util-source@5?bundle'



```



## Use



Say our document `example.md` contains:



```markdown

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

>   world.

```



…and our module `example.js` looks as follows:



```js

import {fromMarkdown} from 'mdast-util-from-markdown'

import {read} from 'to-vfile'

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(file, strong))

```



…now running `node example.js` yields:



```markdown

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

```



## API



This package exports the identifier [`source`][source].

There is no default export.



### `source(file[, value])`



Get the source of a node or at a position.



###### Parameters



*   `file` ([`VFile`][vfile] or `string`)

    — file in which `value` exists

*   `value` ([`Node`][node], [`Position`][position], optional)

    — value to get



###### Returns



Source of `value` in `doc`, if available (`string` or `undefined`).



## 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-source@^5`,

compatible with Node.js 16.



## Contribute



See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] 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, organisation, or community you agree to

abide by its terms.



## License



[MIT][license] © [Titus Wormer][author]



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



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



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



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



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



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



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



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



[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



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



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



[esmsh]: https://esm.sh



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



[license]: license



[author]: https://wooorm.com



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



[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



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



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



[vfile]: https://github.com/vfile/vfile



[source]: #sourcefile-value