# workshopper

> A terminal workshop runner framework

Latest version **2.7.0** (published 2015-07-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install workshopper
pnpm add workshopper
yarn add workshopper
bun add workshopper
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.7.0 |
| Published | 2015-07-09 |
| First published | 2013-08-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1107 |
| Author | Rod Vagg |
| Maintainers | rvagg, maxogden, julianduque, leichtgewicht |

## Links

- npm: https://www.npmjs.com/package/workshopper
- Repository: https://github.com/rvagg/workshopper
- Issues: https://github.com/rvagg/workshopper/issues
- npm.io page: https://npm.io/package/workshopper

## Dependencies (10)

- [msee](https://npm.io/package/msee.md) ~0.1.1
- [chalk](https://npm.io/package/chalk.md) ~0.4.0
- [xtend](https://npm.io/package/xtend.md) ~3.0.0
- [mkdirp](https://npm.io/package/mkdirp.md) ~0.3.5
- [optimist](https://npm.io/package/optimist.md) ~0.6.1
- [i18n-core](https://npm.io/package/i18n-core.md) ^1.3.2
- [map-async](https://npm.io/package/map-async.md) ~0.1.1
- [colors-tmpl](https://npm.io/package/colors-tmpl.md) ~0.1.0
- [visualwidth](https://npm.io/package/visualwidth.md) ~0.0.1
- [terminal-menu](https://npm.io/package/terminal-menu.md) ^2.1.1

## Recent versions

- 2.7.0 (latest) — 2015-07-09
- 2.6.0 — 2015-06-03
- 2.5.0 — 2015-04-16
- 2.4.0 — 2015-04-11
- 2.3.1 — 2015-02-16
- 2.3.0 — 2015-02-14
- 2.2.0 — 2015-01-26
- 2.1.1 — 2015-01-19
- 2.0.0 — 2015-01-19
- 1.4.1 — 2015-01-03
- 1.4.0 — 2015-01-03
- 1.3.3 — 2014-11-14
- 1.3.2 — 2014-07-21
- 1.3.0 — 2014-07-02
- 1.2.2 — 2014-06-30
- … 34 more at https://npm.io/package/workshopper/versions

## README

# Workshopper

**A terminal workshop runner framework**

[![NPM](https://nodei.co/npm/workshopper.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/workshopper/) [![NPM](https://nodei.co/npm-dl/workshopper.png?months=3&height=3)](https://nodei.co/npm/workshopper/)

![Learn You The Node.js For Much Win!](https://raw.github.com/rvagg/learnyounode/master/learnyounode.png)

**Workshopper** is used by **[learnyounode](https://github.com/rvagg/learnyounode)**, and other Node.js command-line workshop applications.

*Documentation is being written for the v1 rewrite right now! Ping @rvagg if you need anything. **learnyounode** is now using this new version, for now you can use it to see how this works.

For now, [@linclark](https://github.com/linclark) has written a good introduction on creating your own workshop, available [here](http://lin-clark.com/blog/2014/07/01/authoring-nodejs-workshopper-lessons/).

## High-level overview

Workshopper is essentially a *test-runner* with a fancy terminal UI. The Workshopper package itself is largely concerned with the menu system and some of the basic command-line parsing. Much of the work for executing the exercise validation is handled by [workshopper-exercise](http://github.com/rvagg/workshopper-exercise).




### Contributors

<b><code>workshopper</code></b> is proudly brought to you by the following hackers:

* [@rvagg](https://github.com/rvagg)
* [@substack](https://github.com/substack)
* [@maxogden](https://github.com/maxogden)
* [@cjb](https://github.com/cjb)
* [@wpreul](https://github.com/wpreul)
* [@davglass](https://github.com/davglass)
* [@Rowno](https://github.com/Rowno)
* [@wilmoore](https://github.com/wilmoore)
* [@evilpacket](https://github.com/evilpacket)
* [@bobholt](https://github.com/bobholt)
* [@jessmartin](https://github.com/jessmartin)
* [@braz](https://github.com/braz)
* [@timoxley](https://github.com/timoxley)
* [@dominictarr](https://github.com/dominictarr)
* [@dominhhai](https://github.com/dominhhai)
* [@minatu2d](https://github.com/minatu2d)

#### Maintainers

* [@rvagg](https://github.com/rvagg)
* [@substack](https://github.com/substack)
* [@maxogden](https://github.com/maxogden)
* [@cjb](https://github.com/cjb)
* [@timoxley](https://github.com/timoxley)
* [@dominictarr](https://github.com/dominictarr)
* [@braz](https://github.com/braz)


## License

**Workshopper** is Copyright (c) 2013-2015 Rod Vagg [@rvagg](https://twitter.com/rvagg) and licenced under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.

**Workshopper** builds on the excellent work by [@substack](https://github.com/substack) and [@maxogden](https://github.com/maxogden) who created **[stream-adventure](https://github.com/substack/stream-adventure)** which serves as the original foundation for **Workshopper** and **learnyounode**. Portions of **Workshopper** may also be Copyright (c) 2013 [@substack](https://github.com/substack) and [@maxogden](https://github.com/maxogden) given that it builds on their original code.

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