From 886acb621534979c58b5087edbc4da59e5419868 Mon Sep 17 00:00:00 2001 From: Roopesh Hiriyanna Date: Sun, 10 Nov 2024 22:32:02 +0100 Subject: [PATCH] chore: updated readme --- ReadMe.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/ReadMe.md b/ReadMe.md index d43a1cf..6774740 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -45,22 +45,38 @@ swapi-api-tests/ yarn test ``` - On completion of the tests, test report is generated in the folder `report`. You can open `report.html` to read the reports. +- We can also run the tests in debug mode which runs whenever the code is changed + ```bash + yarn test:watch + ``` ## Static checks - To make sure that the coding style remains the same for everyone, eslint and prettier rules have been set up in the project. - **ESLint**: Lints JavaScript and TypeScript code to catch errors and enforce coding standards. - **Prettier**: Automatically formats code to maintain a consistent style. +- To run the linting you can run the command: + ```bash + yarn lint + ``` +- To fix the linting errors, you can run the command: + ```bash + yarn lint:fix + ``` +- To format the code as per prettier settings, you can run: + ```bash + yarn format + ``` ## Continuous Integration - The project is integrated with GitHub Actions to automate test execution on each push and on creation of pull request. This provides immediate feedback on test results, ensuring code quality and functionality. - You can see the tests run on GitHub Actions [here](https://github.com/roopeshh/swapi-api-tests/actions). - We also have html reports for each test run uploaded as an artifact, that you can find in the example link [here](https://github.com/roopeshh/swapi-api-tests/actions/runs/11768412190) in the `Artifacts` section. -- Alternatively, we can also view the test results for each test runs in `API Test Report` section in the job itself like in this [example](https://github.com/roopeshh/swapi-api-tests/actions/runs/11768412190/job/32778212241). - +- Alternatively, we can also view the test results for each test runs in `API Test Report` section in the job itself like in this [example](https://github.com/roopeshh/swapi-api-tests/actions/runs/11768412190/job/32778212241). ## Note + - You can find more details on the project and test cases below: - - [description](https://github.com/roopeshh/swapi-api-tests/blob/main/Description.md) - - [testcases](https://github.com/roopeshh/swapi-api-tests/blob/main/TestCases.md) \ No newline at end of file + - [description](https://github.com/roopeshh/swapi-api-tests/blob/main/Description.md) + - [testcases](https://github.com/roopeshh/swapi-api-tests/blob/main/TestCases.md)