# text-runner-engine

> Tests documentation written in MarkDown

Latest version **7.5.1** (published 2026-10-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install text-runner-engine
pnpm add text-runner-engine
yarn add text-runner-engine
bun add text-runner-engine
```

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 7.5.1 |
| Published | 2026-10-06 |
| First published | 2025-03-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 9 |
| Unpacked size | 152.3 KB |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 43 |
| Author | Kevin Goslar |
| Maintainers | kevingoslar |

## Links

- npm: https://www.npmjs.com/package/text-runner-engine
- Repository: https://github.com/kevgo/text-runner
- Issues: https://github.com/kevgo/text-runner/issues
- npm.io page: https://npm.io/package/text-runner-engine

## Dependencies (9)

- [got](https://npm.io/package/got.md) 14.6.6
- [globby](https://npm.io/package/globby.md) 16.1.0
- [parse5](https://npm.io/package/parse5.md) 8.0.0
- [is-glob](https://npm.io/package/is-glob.md) 4.0.3
- [markdown-it](https://npm.io/package/markdown-it.md) 14.1.0
- [tmp-promise](https://npm.io/package/tmp-promise.md) 3.0.3
- [humanize-string](https://npm.io/package/humanize-string.md) 3.1.0
- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) 3.0.0
- [anchor-markdown-header](https://npm.io/package/anchor-markdown-header.md) 0.7.0

## Recent versions

- 7.5.1 (latest) — 2026-10-06
- 7.5.0 — 2026-01-05
- 7.4.0 — 2025-10-16
- 7.3.0 — 2025-10-15
- 7.2.1 — 2025-10-11
- 7.2.0 — 2025-10-06
- 7.1.2 — 2025-03-20
- 7.1.1 — 2025-03-18
- 7.1.0 — 2025-03-07

## README

<!-- logo is from: https://icons8.com/icon/40886/test -->
<img src="../documentation/logo2.png" align="right" valign="bottom">

# Text-Runner

> Test runner for text

Text-Runner makes rich text executable. An example is the documentation you are
reading right now. Text-Runner executes certain parts of it to verify that it
correctly describes how Text-Runner works. Text-Runner allows you to

- test your natural-language documentation
- make your end-to-end tests completely human-readable prose
- write computer programs in natural language

There are no limitations on the type of text that TextRunner can execute. It can
read and understand (if you tell it how) any form of plain text in any human
language as well as complex data in tables, bullet point lists, or embedded
images. This can be useful for things like

- **agile documentation:** your documentation always matches the behavior of the
  product it describes
- **[semantic versioning](http://semver.org):** know whether a product change
  affects documented behavior
- **[readme-driven development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html):**
  documentation becomes your product prototype and drives the implementation

More information about:

- [how it works](../documentation/how-it-works.md)
- [installation](../documentation/installation.md)
- [built-in actions](../documentation/built-in-actions.md)
- [user-defined actions](../documentation/user-defined-actions.md)
- [external actions](../documentation/external-actions.md)
- [questions and answers](../documentation/qna.md)
- [related tools](../documentation/related-tools.md)

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