Simple and complete CLI testing utilities that encourage good testing\npractices.
\n\n
\n\n\n\n[](https://github.com/crutchcorn/cli-testing-library/actions/workflows/validate.yml?query=branch%3Amain)\n[](https://www.npmjs.com/package/cli-testing-library)\n[](https://www.npmjs.com/package/cli-testing-library)\n[](./LICENSE)\n[](makeapullrequest.com)\n[](./CODE_OF_CONDUCT.md)\n\n\n[](#contributors-)\n\n\n[](https://github.com/crutchcorn/cli-testing-library/watchers)\n[](https://github.com/crutchcorn/cli-testing-library/stargazers)\n\n\n\n## Table of Contents\n\n\n\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Contributors ✨](#contributors-)\n\n\n\n> This project is not affiliated with the\n> [\"Testing Library\"](https://github.com/testing-library) ecosystem that this\n> project is clearly inspired from. We're just big fans :)\n\n## Installation\n\nThis module is distributed via [npm][npm] which is bundled with [node][node] and\nshould be installed as one of your project's `devDependencies`:\n\n```\nnpm install --save-dev cli-testing-library\n```\n\n## Usage\n\n> This is currently the only section of \"usage\" documentation. We'll be\n> expanding it as soon as possible\n\nUsage example:\n\n```javascript\nconst {resolve} = require('path')\nconst {render} = require('cli-testing-library')\n\ntest('Is able to make terminal input and view in-progress stdout', async () => {\n const {cleanup, findByText, queryByText, userEvent} = await render('node', [\n resolve(__dirname, './execute-scripts/stdio-inquirer.js'),\n ])\n\n const instance = await findByText('First option')\n\n expect(instance).toBeInTheConsole()\n\n expect(await findByText('❯ One')).toBeInTheConsole()\n\n cleanup()\n\n userEvent('[ArrowDown]')\n\n expect(await findByText('❯ Two')).toBeInTheConsole()\n\n cleanup()\n\n userEvent.keyboard('[Enter]')\n\n expect(await findByText('First option: Two')).toBeInTheConsole()\n expect(await queryByText('First option: Three')).not.toBeInTheConsole()\n})\n```\n\nFor a API reference documentation, including suggestions on how to use this\nlibrary, see our\n[documentation introduction with further reading](./docs/introduction.md).\n\n> While this library _does_ work in Windows, it does not appear to function\n> properly in Windows CI environments, such as GitHub actions. As a result, you\n> may need to either switch CI systems or limit your CI to only run in Linux\n>\n> If you know how to fix this, please let us know in\n> [this tracking issue](https://github.com/crutchcorn/cli-testing-library/issues/3)\n\n## Contributors ✨\n\nThanks goes to these wonderful people\n([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\n\n\n
\n\n\n\n\n\n\nThis project follows the\n[all-contributors](https://github.com/all-contributors/all-contributors)\nspecification. Contributions of any kind welcome!\n","_attachments":{},"homepage":"https://github.com/crutchcorn/cli-testing-library#readme","bugs":{"url":"https://github.com/crutchcorn/cli-testing-library/issues"},"license":"MIT"}
![\"\"/](\"https://avatars.githubusercontent.com/u/9100169?v=4?s=100\")
![\"\"/](\"https://avatars.githubusercontent.com/u/1880749?v=4?s=100\")
![\"\"/](\"https://avatars.githubusercontent.com/u/1443499?v=4?s=100\")