test(__tests__ dir): added vitest and coverage reporting GitHub Actions workflow

KemingHe commented 3 months ago

Deliverables

Mon. 07/29 Update

@ad1992 Git hard reset to only implement testing, refactored naming 3rd time in e3264f8.

Sun. 07/28 Update

~~@ad1992 , done 10~~

~~Added query result caching via private cache: { [query: string]: Result };.~~ ~~Added and maintained 100% test coverage of cache hit and miss.~~

~~For details, see: c476214~~

Fri. 07/26 Update

@ad1992 , done #3

[x] Unittest 100% statement coverage for utils.ts and Fuzzy.ts.
[x] Vitest benchmarking utils.ts performance (see package.json and __tests__/benchmark.json)
[x] GitHub Actions workflow node-ci.yml to auto yarn install and test per push/PR.

MOST IMPORTANT

[x] ZERO functional code changes.

Screenshot of GitHub (auto-trigger) Actions run output:

Screenshot from 2024-07-26 16-01-44

vercel[bot] commented 3 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
fuzzify	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 29, 2024 4:40pm

KemingHe commented 3 months ago

@ad1992 Let me know how you like the yarn test:bench:compare feature. I will let you decide how to incorporate it into the contrib workflow (prob an edit to README.md) so that future devs doesn't break performance on top of functionality. ☀️

ad1992 commented 3 months ago

Ohh wow, this PR looks great @KemingHe, very happy to see the tests being added so soon! I will be reviewing this PR tomorrow

KemingHe commented 3 months ago

Thanks @KemingHe for the PR ✨

I am thinking should we just add coverage instead of benchmarks ? wdyt ? This one I mean. - https://github.com/davelosert/vitest-coverage-report-action

@ad1992

[x] Removed all benchmark test and script in 9bfc05c.
[x] Impletemented coverage reporting in 9bfc05c, see screenshot below:

KemingHe commented 3 months ago

[x] 100% coverage in global Lines, Statements, Functions, and Branches.

KemingHe commented 3 months ago

Looks great @KemingHe! Let's remove caching related stuff from this PR as discussed in the issue

@ad1992

[x] Hard reset to only testing in e3264f8.

KemingHe commented 3 months ago

Also @ad1992 , since >90% of our conversation has been about naming preferences, I propose that you provide the exact software specifications in ALL future instances BEFORE I start coding.

I can understand that this project is your world and everything and it must be perfect. However, I'm also just an unpaid volunteer and doing this out of my own free will.

[!WARNING] If the micro-management continues, this will be my last commit to the project.

ad1992 commented 3 months ago

Also @ad1992 , since >90% of our conversation has been about naming preferences, I propose that you provide the exact software specifications in ALL future instances BEFORE I start coding.

I can understand that this project is your world and everything and it must be perfect. However, I'm also just an unpaid volunteer and doing this out of my own free will.

Warning

If the micro-management continues, this will be my last commit to the project.

Also @ad1992 , since >90% of our conversation has been about naming preferences, I propose that you provide the exact software specifications in ALL future instances BEFORE I start coding.

I can understand that this project is your world and everything and it must be perfect. However, I'm also just an unpaid volunteer and doing this out of my own free will.

Warning

If the micro-management continues, this will be my last commit to the project.

Thank you for sharing your concerns. I understand that discussing naming preferences can be annoying, but they are important to ensure consistency, clarity, and maintenance. However not all naming changes are necessary, some are good to have, so feel free to comment where you have a different opinion and we can learn from each other.

As mentioned in Readme, this library is at a very early stage and it will take me some time to bring everything in the documentation.

I acknowledge and appreciate the voluntary effort you are putting into this project and I am a volunteer as well so I hope we both have the same goals to improve the library and at the same time keep it maintainable as well.

From my side, I will try to add details and document as much as possible but as I mentioned it will take me some time as well, until then I will jump in and take care of those undocumented changes as well.

I hope we can continue working together smoothly and improve the library :). Thanks again for your contributions so far ✨

ad1992 / fuzzify