You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP
Socket
Book a DemoInstallSign in
Socket

text-runner-engine

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

text-runner-engine

Tests documentation written in MarkDown

7.1.2
latest
Source
npmnpm
Version published
Weekly downloads
235
47.8%
Maintainers
1
Weekly downloads
 
Created
Source

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: know whether a product change affects documented behavior
  • readme-driven development: documentation becomes your product prototype and drives the implementation

More information about:

FAQs

Package last updated on 20 Mar 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts