<p align="center"> 🍃 ✨ Spearmint v14 ✨ 🍃 </p>

Spearmint helps developers easily create functional Accessibility, Endpoint, GraphQL, Puppeteer, React, Hooks, Redux, Svelte, Vue, Security, and Solid.js tests without writing any code. It dynamically converts user inputs into executable Jest test code by using DOM query selectors provided by @testing-library.

Installation

Please download Spearmint from our website

How to use in development mode

Please refer to README-dev.md

<br>

How it works

1. Open the folder of the repo you'd like to create tests for, then choose the framework/type of test you'd like to create. <picture> <source media="(prefers-color-scheme: dark)" srcset="public/openFolder.webp"> <source media="(prefers-color-scheme: light)" srcset="public/openFolder.webp"> <img alt="spearmint gif" src="public/openFolder.webp" width="800px"> </picture>

2. Utilize our auto-complete, drop-down options, and tooltips features to easily create arrangement, action, and assertion test statements for React, Vue, Svelte, and Solid; reducer, action creator, asynchronous action creator, and middleware test statements for Redux; and hooks, context, endpoint, and GraphQL test statements.

3. Spearmint will then convert user input to dynamically generate a test file in the Code Editor. <picture> <source media="(prefers-color-scheme: dark)" srcset="public/SpearmintGenerateTest.webp"> <source media="(prefers-color-scheme: light)" srcset="public/SpearmintGenerateTest.webp"> <img alt="spearmint gif" src="public/SpearmintGenerateTest.webp" width="800px"> </picture>

4. Follow the instructions in the recently added User Guide tab on the right to export and run your tests. <picture> <source media="(prefers-color-scheme: dark)" srcset="public/SpearmintRunTest.webp"> <source media="(prefers-color-scheme: light)" srcset="public/SpearmintRunTest.webp"> <img alt="spearmint gif" src="public/SpearmintRunTest.webp" width="800px"> </picture>

5. Don't forget to select your test file from the left panel in order to manually edit the test in the Test Editor; otherwise the changes won't be reflected in the test file. <picture> <source media="(prefers-color-scheme: dark)" srcset="public/saveTest.webp"> <source media="(prefers-color-scheme: light)" srcset="public/saveTest.webp"> <img alt="spearmint gif" src="public/saveTest.webp" width="800px"> </picture>

<!-- # Containerization with Docker Spearmint is now available as an OCI-compliant container image via Docker. Windows and Linux users may access Spearmint by running a Docker image. Please pull down the image from [Docker hub](https://hub.docker.com/repository/docker/spearmintoslabs/spearmint) if you would like to run Spearmint on Docker.  -->

For developers: README-dev.md. This containes more information specific to developers such as data systems, outlines of the application, turning on dev tools, etc.

New features with version 0.14.0

• Increased Typescript coverage – Spearmint is now majority Typescript!

• Greatly bolstered internal testing on the program and instituted testing coverage reports for completeness visibility

• Updated to latest version of electron

• Updated a variety of dependencies and libraries

• Added documentation for future developers

<br>

Iteration Roadmap

1. Continuing TypeScript Conversion:

• This will help with the maintainability and readability of Spearmint’s code, and move closer to 100% coverage

2. Persistent data:

• There is a framework for login, including GitHub and Google, however it is not implemented
• Adding more features to make login and user data more valuable, such as favorited or saved tests, saved templates, etc.

3. Adding more testing:

• Deeper testing of existing frameworks should probably be the main priority here as many frameworks are implemented already, but could use more fleshed-out features
• Adding additional frameworks is a possibility if there is a strong case for them, but adding more robustness to the current test suites is probably more important

4. Add functionality for exporting test files as Typescript

• Currently the only export option is vanilla Javascript

5. Continue to extend internal testing coverage

• A far greater amount of the application is tested now than it was previously, but there is more work to do on this

6. Update some dependencies and tools

• Consider removing MUI and switching to another component library or redoing styling in CSS in order to update the program to React v18+ as MUI is incompatible and seems not to be actively updating.
• Consider implementing React Dev Tools or react-dnd to restore the drag-drop functionality
• Monitor for other opportunities to update dependencies or otherwise improve the program with different libraries or tools.

7. Revamp UI for certain test cases:

• Some of test cases needs improvement on UI as they do not have any styling or optimal user experience

<br>

Known Bugs

1. Screen reader for Accessibilty can turn on and off but does not read.
2. Text to speech not functioning properly under Accessibility
3. Some elements of draggable remaining in Redux test case components

<br>

The Spearmint Team

Developed By
Alan Richardson
Alex Park
Alfred Sta. Iglesia
Anjanie McCoy
Annie Shin
Ben Kwak
Brandon Tran
Carter Long
Chacta Brice
Charlie Maloney
Chen 'Chloe' Lu
Chloe Aribo
Chris Cheng
Cornelius Phanthanh
Danny Wallace
Dave Franz
David Kim
DeriAnte Sinclair
Dieu 'Dieunity' Hyunh
Dylan Hawkins
Erik Komatsu
Erik Park
Erika Collins