SNUTS.js: Sniffing Nasty Unit Test Smells in Javascript
GPL-3.0 License
This API is designed to detect test smells in JavaScript codebases. It provides endpoints to analyze JavaScript test files and identify common test smells.
To run this project locally, follow these steps:
Clone the repository:
git clone https://github.com/Jhonatanmizu/SNUTS.js.git
Install dependencies:
cd SNUTS.js
yarn
Start the API server:
yarn start
The API will be accessible at http://localhost:3001
.
POST /
repository
: a public github repository which have jest or jasmine.results
: Array of objects containing the detected test smells.GET /health
status
: Status of the API (e.g., "OK").You can use the API to detect test smells in your JavaScript test files by sending a POST request to the /detect
endpoint with the test files you want to analyze.
Example:
curl -X POST http://localhost:3000/ -H "Content-Type: application/json" -d '{"repository":"repo-url"}'
If you'd like to contribute to this project, please fork the repository and submit a pull request. You can also open an issue to report bugs or suggest new features.
Let me know if you need any further adjustments or additions!