# brace_document_mocha

> A plugin for Brace Document which generates a document pages the project mocha unit tests.

Latest version **1.1.3** (published 2020-02-02) · MIT license · 0 weekly downloads

## Install

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

## 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 | 1.1.3 |
| Published | 2020-02-02 |
| First published | 2020-01-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 39.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Robert Steckroth |
| Maintainers | nickali |

## Links

- npm: https://www.npmjs.com/package/brace_document_mocha
- Repository: https://restarian@github.com/restarian/brace_document_mocha
- Homepage: https://github.com/restarian/brace_document_mocha#readme
- Issues: https://github.com/restarian/brace_document_mocha/issues
- npm.io page: https://npm.io/package/brace_document_mocha

## Dependencies (6)

- [mocha](https://npm.io/package/mocha.md) ^7.0.1
- [bracket_print](https://npm.io/package/bracket_print.md) ^0.10.4
- [brace_document](https://npm.io/package/brace_document.md) ^1.1.10
- [brace_document_link](https://npm.io/package/brace_document_link.md) ^1.1.10
- [brace_document_navlink](https://npm.io/package/brace_document_navlink.md) ^1.1.9
- [brace_document_specification](https://npm.io/package/brace_document_specification.md) ^1.2.3

## Recent versions

- 1.1.3 (latest) — 2020-02-02
- 1.1.1 — 2020-02-02
- 1.1.0 — 2020-01-29

## README

[![Build status](https://ci.appveyor.com/api/projects/status/4o60w86bofuqi592?svg=true)](https://ci.appveyor.com/project/restarian/brace-document-mocha) [![Downloads](https://img.shields.io/npm/dm/brace_document_mocha.svg?svg=true)](https://npmjs.org/package/brace_document_mocha)

| **The [Brace Suite]** | **[Ubuntu on Windows]**   |
|:---------------------:|:-------------------------:|
| ![Brace logo]         | ![Ubuntu on Windows logo] |         |

[Brace Suite]: https://github.com/restarian/restarian/tree/master/brace/
[Ubuntu on Windows]: https://www.microsoft.com/en-us/store/p/ubuntu/9nblggh4msv6?activetab=pivot%3aoverviewtab

[Ubuntu on Windows logo]: https://raw.githubusercontent.com/restarian/restarian/master/doc/image/ubuntu_windows_logo.png
[Brace logo]: https://raw.githubusercontent.com/restarian/restarian/master/brace/doc/image/brace_logo_small.png


------
### Brace Document Mocha help pages
* [Contributor code of conduct](https://github.com/restarian/brace_document_mocha/blob/master/docs/contributor_code_of_conduct.md)
* [Guidelines for contributing](https://github.com/restarian/brace_document_mocha/blob/master/docs/guidelines_for_contributing.md)
* **Synopsis**
* Specification
  * [License information](https://github.com/restarian/brace_document_mocha/blob/master/docs/specification/license_information.md)
  * [Package information](https://github.com/restarian/brace_document_mocha/blob/master/docs/specification/package_information.md)
  * [Unit test output](https://github.com/restarian/brace_document_mocha/blob/master/docs/specification/unit_test_output.md)

----

### What it is: 
Brace Document Mocha creates a superficial ouput of the currently enabled mocha unit tests to use for documentation purposes. It uses the overide script contained in the [Brace Maybe](https://github.com/restarian/brace_maybe) library to omit unit testing processes while recording the *describe* and *it* title strings. Brace Maybe also allows the plugin to recognize the [Mocha](https://github.com/search?q=mocha) *skip* and *only* mechanisms.

**Author**: Robert Steckroth, [*Bust0ut*] [<RobertSteckroth@gmail.com>](mailto:robertsteckroth@gmail.com)

**License: MIT**

Copyright (c) Restarian Technology 2020 - Robert Steckroth <RobertSteckroth@gmail.com>

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