archive-gh-me/yew
1
0
Fork 0
mirror of https://github.com/yewstack/yew.git synced 2025-12-08 21:26:25 +00:00
Code Issues Projects Releases Wiki Activity

Fix typo in contrib instructions cargo make tests -> cargo make test (#2909)

Browse Source 
* Fix typo in contrib instructions `cargo make tests` -> `cargo make test`

* Use `cargo make test-flow` for running all tests

* Remove 'WebSocket service tests' section from CONTRIBUTING.md
This commit is contained in:
Nils Loewen 2022-10-19 03:46:35 -07:00 committed by GitHub
parent 5f6e094996
commit 730f25c46b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -27,12 +27,12 @@ The most important tasks are outlined below.
To run all tests, use the following command: To run all tests, use the following command:
```bash ```bash
cargo make tests cargo make test-flow
``` ```
### Browser tests ### Browser tests
`cargo make tests` will automatically download Geckodriver to a temporary location if it isn't in the PATH. `cargo make test` will automatically download Geckodriver to a temporary location if it isn't in the PATH.
Because Geckodriver looks for `firefox` in the path, if you use Because Geckodriver looks for `firefox` in the path, if you use
FireFox Developer Edition, you may get an error, because Developer Editions FireFox Developer Edition, you may get an error, because Developer Editions
@ -44,18 +44,10 @@ To fix this, either install the standard version of Firefox or symlink
The tests for the fetch service require a local [httpbin](https://httpbin.org/) server. The tests for the fetch service require a local [httpbin](https://httpbin.org/) server.
If you have [Docker](https://www.docker.com/) installed, If you have [Docker](https://www.docker.com/) installed,
`cargo make tests` will automatically run httpbin in a container for you. `cargo make test` will automatically run httpbin in a container for you.
Alternatively, you can set the `HTTPBIN_URL` environment variable to the URL you wish to run tests against. Alternatively, you can set the `HTTPBIN_URL` environment variable to the URL you wish to run tests against.
### WebSocket service tests
The tests for the web-socket service require an echo server.
If you have [Docker](https://www.docker.com/) installed,
`cargo make tests` will automatically run an [echo server](https://hub.docker.com/r/jmalloc/echo-server) in a container for you.
Alternatively, you can set the `ECHO_SERVER_URL` environment variable to the URL you wish to run tests against.
### Macro tests ### Macro tests
When adding or updating tests, please make sure to update the appropriate `stderr` file, which you can find [here](https://github.com/yewstack/yew/tree/master/packages/yew-macro/tests/macro) for the `html!` macro. When adding or updating tests, please make sure to update the appropriate `stderr` file, which you can find [here](https://github.com/yewstack/yew/tree/master/packages/yew-macro/tests/macro) for the `html!` macro.