# muchi-ts

> Annotation based test runner for JavaScript and TypeScript, written in TypeScript.

Latest version **2.3.8** (published 2019-09-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install muchi-ts
pnpm add muchi-ts
yarn add muchi-ts
bun add muchi-ts
```

Provides the command `muchi`.

## 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.3.8 |
| Published | 2019-09-14 |
| First published | 2019-02-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Manyanda Chitimbo |
| Maintainers | machi27 |
| Keywords | test, test-runner, typescript, javascript, test-framework, unit-test, tdd |

## Links

- npm: https://www.npmjs.com/package/muchi-ts
- Repository: https://github.com/machi1990/muchi-ts
- npm.io page: https://npm.io/package/muchi-ts

## Dependencies (9)

- [nyc](https://npm.io/package/nyc.md) 14.1.1
- [assert](https://npm.io/package/assert.md) 2.0.0
- [colors](https://npm.io/package/colors.md) 1.3.3
- [commander](https://npm.io/package/commander.md) 3.0.1
- [typescript](https://npm.io/package/typescript.md) 3.6.3
- [@types/node](https://npm.io/package/@types/node.md) 12.7.5
- [@types/muchi-ts](https://npm.io/package/@types/muchi-ts.md) https://github.com/machi1990/muchi-ts-types.git
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) 0.1.13
- [source-map-support](https://npm.io/package/source-map-support.md) 0.5.13

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 2.3.8 (latest) — 2019-09-14
- 2.3.7 — 2019-07-04
- 2.3.6 — 2019-06-19
- 2.3.5 — 2019-06-07
- 2.3.4 — 2019-05-09
- 2.3.3 — 2019-05-02
- 2.3.2 — 2019-04-13
- 2.3.1 — 2019-03-30
- 2.3.0 — 2019-03-17
- 2.2.1 — 2019-03-10
- 2.2.0 — 2019-03-07
- 2.1.2 — 2019-03-02
- 2.1.1 — 2019-02-28
- 2.1.0 — 2019-02-26
- 2.0.2 — 2019-02-24
- … 2 more at https://npm.io/package/muchi-ts/versions

## README

# muchi-ts

muchi-ts is an annotation (decorator) based test runner for TypeScript and JavaScript languages.

# Installation

1. Install test runner.

   - npm: `npm install --save-dev muchi-ts`
   - yarn: `yarn add --dev muchi-ts`

2. Install annotation type definition.
   - yarn: `yarn add --dev https://github.com/machi1990/muchi-ts-types.git`
   - npm: `npm install --save-dev https://github.com/machi1990/muchi-ts-types.git`

# How to use
- To run test files execute the runner with `--tests` or its short form `-t` options: `muchi-ts --tests <path/to/test/files>` or `muchi --tests <regex-to-test-files->`. 
- Watch mode is available using the `--watch true` or its short form `-w true` options. The default value is `false`.
- `-s time` or its long form `--timeOut time`, provides a timeout option of stopping test execution if it depasses the provided time. The passed value represents time in milliseconds. The default value is `1000ms`. 
- `-h` or `--help` is for how to use information
- `--version` provides the version of the executable.

# Coverage
muchi-ts integrates easily with `nyc` for coverage reports. Install `nyc` from npm (`npm install --save-dev nyc`) and run `nyc muchi -t <your tests>` to see the coverage reports. See [Istanbul](https://istanbul.js.org/) for more information on how to generate different formats of coverage reports.

# Examples
Some sample tests are available here: https://github.com/machi1990/muchi-ts-samples

# Author

Manyanda Chitimbo <manyanda.chitimbo@gmail.com>

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