Simple and complete CLI testing utilities that encourage good testing
practices.
[](https://github.com/crutchcorn/cli-testing-library/actions/workflows/validate.yml?query=branch%3Amain)
[](https://www.npmjs.com/package/cli-testing-library)
[](https://www.npmjs.com/package/cli-testing-library)
[](./LICENSE)
[](makeapullrequest.com)
[](./CODE_OF_CONDUCT.md)
[](#contributors-)
[](https://github.com/crutchcorn/cli-testing-library/watchers)
[](https://github.com/crutchcorn/cli-testing-library/stargazers)
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contributors ✨](#contributors-)
> This project is not affiliated with the
> ["Testing Library"](https://github.com/testing-library) ecosystem that this
> project is clearly inspired from. We're just big fans :)
## Installation
This module is distributed via [npm][npm] which is bundled with [node][node] and
should be installed as one of your project's `devDependencies`:
```
npm install --save-dev cli-testing-library
```
## Usage
> This is currently the only section of "usage" documentation. We'll be
> expanding it as soon as possible
Usage example:
```javascript
const { resolve } = require("path");
const { render } = require("cli-testing-library");
test("Is able to make terminal input and view in-progress stdout", async () => {
const { clear, findByText, queryByText, userEvent } = await render("node", [
resolve(__dirname, "./execute-scripts/stdio-inquirer.js"),
]);
const instance = await findByText("First option");
expect(instance).toBeInTheConsole();
expect(await findByText("❯ One")).toBeInTheConsole();
clear();
userEvent("[ArrowDown]");
expect(await findByText("❯ Two")).toBeInTheConsole();
clear();
userEvent.keyboard("[Enter]");
expect(await findByText("First option: Two")).toBeInTheConsole();
expect(await queryByText("First option: Three")).not.toBeInTheConsole();
});
```
For a API reference documentation, including suggestions on how to use this
library, see our
[documentation introduction with further reading](./docs/introduction.md).
> While this library _does_ work in Windows, it does not appear to function
> properly in Windows CI environments, such as GitHub actions. As a result, you
> may need to either switch CI systems or limit your CI to only run in Linux
>
> If you know how to fix this, please let us know in
> [this tracking issue](https://github.com/crutchcorn/cli-testing-library/issues/3)
