# guide-automation

> All the tools needed to build guides

Latest version **0.3.11** (published 2017-09-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install guide-automation
pnpm add guide-automation
yarn add guide-automation
bun add guide-automation
```

Provides the command `guide`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.11 |
| Published | 2017-09-20 |
| First published | 2015-11-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 22 |
| Known vulnerabilities | 0 (+13 in 5 direct dependencies) |
| Install scripts | no |
| Author | Bitovi |
| Maintainers | matthewp, phillipskevin |

## Links

- npm: https://www.npmjs.com/package/guide-automation
- npm.io page: https://npm.io/package/guide-automation

## Dependencies (22)

- [npm](https://npm.io/package/npm.md) ^3.3.10
- [tmp](https://npm.io/package/tmp.md) 0.0.28
- [chalk](https://npm.io/package/chalk.md) ^1.1.1
- [debug](https://npm.io/package/debug.md) ^2.2.0
- [mocha](https://npm.io/package/mocha.md) ^2.3.4
- [yargs](https://npm.io/package/yargs.md) ^3.29.0
- [jquery](https://npm.io/package/jquery.md) ^2.1.4
- [install](https://npm.io/package/install.md) ^0.2.3
- [minunit](https://npm.io/package/minunit.md) ^1.1.1
- [funcunit](https://npm.io/package/funcunit.md) 3.0.0
- [launchpad](https://npm.io/package/launchpad.md) ^0.4.9
- [tree-kill](https://npm.io/package/tree-kill.md) ^1.0.0
- [websocket](https://npm.io/package/websocket.md) ^1.0.22
- [log-update](https://npm.io/package/log-update.md) ^1.0.2
- [node-fetch](https://npm.io/package/node-fetch.md) ^1.3.3
- [pdenodeify](https://npm.io/package/pdenodeify.md) ^0.1.0
- [stream-when](https://npm.io/package/stream-when.md) ^1.0.0
- [answer-prompt](https://npm.io/package/answer-prompt.md) ^1.0.0
- [promise-child](https://npm.io/package/promise-child.md) ^1.0.0
- [elegant-spinner](https://npm.io/package/elegant-spinner.md) ^1.0.1
- [cross-spawn-async](https://npm.io/package/cross-spawn-async.md) ^2.0.0
- [promise-one-at-a-time](https://npm.io/package/promise-one-at-a-time.md) ^1.0.1

## Recent versions

- 0.3.11 (latest) — 2017-09-20
- 0.3.10 — 2017-09-20
- 0.3.9 — 2017-09-20
- 0.3.8 — 2017-09-19
- 0.3.7 — 2017-09-19
- 0.3.6 — 2017-03-27
- 0.3.5 — 2017-01-27
- 0.3.4 — 2017-01-27
- 0.3.3 — 2016-11-07
- 0.3.2 — 2016-03-29
- 0.3.1 — 2016-03-29
- 0.3.0 — 2016-03-28
- 0.2.6 — 2016-03-17
- 0.2.5 — 2016-03-17
- 0.2.3 — 2016-03-17
- … 23 more at https://npm.io/package/guide-automation/versions

## README

# guide-automation

A helper library for writing scripts to run through guides. Allows you to build an application and test it along the way.

## Install

```
npm install guide-automation
```

## Usage

**guide-automation** consists of helpers for testing parts of guides, as well as a queue to make sure tests are written in order. A typical usage looks like:

```js
var guide = require("guide-automation")();

guide.step("Install donejs", function(){
	return guide.runCommand("npm", "install donejs -g".split(" "));
});

guide.step("Start donejs develop", function(){
	process.chdir("donejs-chat");
	var child = this.canServe = guide.executeCommand("donejs", ["develop"]).childProcess;

	var server = streamWhen(child.stdout, /can-serve starting on/);
	var liveReload = streamWhen(child.stderr, /Live-reload server/);
	return Promise.all([server, liveReload]);
});

guide.test(function(){
	return guide.nodeTest(__dirname + "/steps/3-donejs-develop/test.js");
});
```

## API

## License

MIT

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