Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/tomaskraus/hoohoo

Checks JavaScript/TypeScript examples in your Markdown document. It can also test the output of examples against assertions written in examples' comments.
https://github.com/tomaskraus/hoohoo

Last synced: 24 days ago
JSON representation

Checks JavaScript/TypeScript examples in your Markdown document. It can also test the output of examples against assertions written in examples' comments.

Awesome Lists containing this project

README

        

## hoohoo

```
Hoo Hoo |\__/|
<(o)(o)
+------| . .|
| js |__.\|
| //=> j j
+-------+
```

**hoohoo** is a command-line tool for code examples in your _markdown_ document.
It extracts, checks and tests code blocks of the Markdown file, based on the language syntax selected.

hoohoo can:

- extract code examples to the directory
- run _javascript_ code examples in your Markdown document and check them for errors
- test _javascript_ the output of code examples against assertions written in examples' comments

Hoohoo can also checks and tests _TypeScript_ code examples (or even others), as long as you are able to compile these examples to javascript. Even then, Hoohoo is able to show the problematic example lines right in the markdown file itself!