# @rbxts/testez

> A fork of TestEZ with TypeScript typings

Latest version **0.4.2-ts.0** (published 2022-05-27) · Apache 2.0 license · 0 weekly downloads

## Install

```sh
npm install @rbxts/testez
pnpm add @rbxts/testez
yarn add @rbxts/testez
bun add @rbxts/testez
```

## Health

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

Positive: has types; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.2-ts.0 |
| Published | 2022-05-27 |
| First published | 2020-05-07 |
| Weekly downloads | 0 |
| License | Apache 2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 73.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Roblox |
| Maintainers | osyris, noahwillcrow |

## Links

- npm: https://www.npmjs.com/package/@rbxts/testez
- Repository: https://github.com/roblox-ts/testez
- Homepage: https://github.com/roblox-ts/testez#readme
- Issues: https://github.com/roblox-ts/testez/issues
- npm.io page: https://npm.io/package/@rbxts/testez

## Recent versions

- 0.4.2-ts.0 (latest) — 2022-05-27
- 0.3.1-ts.5 (beta) — 2020-07-20
- 0.3.1-ts.7 — 2021-11-08
- 0.3.1-ts.6 — 2020-07-20
- 0.3.1-ts.4 — 2020-07-20
- 0.3.1-ts.3 — 2020-07-20
- 0.3.1-ts.2 — 2020-07-20
- 0.3.1-ts.1 — 2020-07-20
- 0.3.1-ts.0 — 2020-07-20
- 0.0.1 — 2020-05-07

## README

<h1 align="center">TestEZ</h1>
<div align="center">
	<a href="https://github.com/Roblox/testez/actions?query=workflow%3ACI">
		<img src="https://github.com/Roblox/testez/workflows/CI/badge.svg" alt="GitHub Actions Build Status" />
	</a>
	<a href="https://roblox.github.io/testez">
		<img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
	</a>
</div>

<div align="center">
	BDD-style Roblox Lua testing framework
</div>

<div>&nbsp;</div>

TestEZ can run within Roblox itself, as well as inside [Lemur](https://github.com/LPGhatguy/Lemur) for testing on CI systems.

We use TestEZ at Roblox for testing our apps, in-game core scripts, built-in Roblox Studio plugins, as well as libraries like [Roact](https://github.com/Roblox/roact) and [Rodux](https://github.com/Roblox/rodux).

It provides an API that can run all of your tests with a single method call as well as a more granular API that exposes each step of the pipeline.

## Inspiration and Prior Work
The `describe` and `it` syntax in TestEZ is based on the [Behavior-Driven Development](https://en.wikipedia.org/wiki/Behavior-driven_development) methodology, notably as implemented in RSpec (Ruby), busted (Lua), Mocha (JavaScript), and Ginkgo (Go).

The `expect` syntax is based on Chai, a JavaScript assertion library commonly used with Mocha. Similar expectation systems are also used in RSpec and Ginkgo, with slightly different syntax.

## Contributing
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for information.

## License
TestEZ is available under the Apache 2.0 license. See [LICENSE](LICENSE) for details.

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