# unist-util-source

> unist utility to get the source of a value

Latest version **5.0.0** (published 2023-07-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install unist-util-source
pnpm add unist-util-source
yarn add unist-util-source
bun add unist-util-source
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2023-07-07 |
| First published | 2016-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 3 |
| Unpacked size | 10.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Titus Wormer |
| Maintainers | wooorm, kmck |
| Keywords | unist, unist-util, util, utility, node, position, source |

## Links

- npm: https://www.npmjs.com/package/unist-util-source
- Repository: https://github.com/syntax-tree/unist-util-source
- Homepage: https://github.com/syntax-tree/unist-util-source#readme
- Issues: https://github.com/syntax-tree/unist-util-source/issues
- Funding: https://opencollective.com/unified
- npm.io page: https://npm.io/package/unist-util-source

## Dependencies (3)

- [vfile](https://npm.io/package/vfile.md) ^6.0.0
- [@types/unist](https://npm.io/package/@types/unist.md) ^3.0.0
- [vfile-location](https://npm.io/package/vfile-location.md) ^5.0.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 5.0.0 (latest) — 2023-07-07
- 4.0.2 — 2023-01-23
- 4.0.1 — 2021-05-06
- 4.0.0 — 2021-05-02
- 3.0.0 — 2020-11-03
- 2.0.0 — 2020-02-10
- 1.0.5 — 2019-05-22
- 1.0.4 — 2018-11-01
- 1.0.3 — 2018-05-02
- 1.0.2 — 2017-06-13
- 1.0.1 — 2016-09-07
- 1.0.0 — 2016-09-04

## 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
<script type="module">
  import {source} from 'https://esm.sh/unist-util-source@5?bundle'
</script>
```

## 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]

<!-- Definitions -->

[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

---
_Source: https://npm.io/package/unist-util-source · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._