Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add a note about TypeScript and Cypress integration tests #157

Merged
merged 1 commit into from
Jul 3, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions documentation/for-developers/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ having trouble.
- <https://github.com/stevearc/conform.nvim> which formats your code on save.
Configure it to use stylua and prettier using the instructions in its README
file
- <https://www.lazyvim.org/extras/lang/typescript> or similar tooling for
working with integration tests

## Running tests

Expand Down Expand Up @@ -99,6 +101,15 @@ for some ideas.

![integration tests](https://github.com/mikavilpas/yazi.nvim/assets/300791/817ccb3f-725b-4830-b5e0-d99a9b87ad26)

This project includes a custom setup for running integration tests. The setup
shows Neovim running in a web based terminal and allows simulating pressing keys
and checking that the correct output is shown. Because the real applications are
being run in a real environment, almost all features that Neovim and yazi
support can be tested.

The tests are written in TypeScript using the [Cypress](https://www.cypress.io/)
browser testing framework.

Optional, but recommended: install
[Node Version Manager](https://github.com/nvm-sh/nvm) to install the correct
version of node.
Expand Down
Loading