Running script before each commit to auto format and test - Githubissues

BrandonArmand / Binari

Interactive code editor with a live binary tree visual designed to teach new developers the fundamentals of Data Structures.

https://binari.dev

MIT License

181 stars 113 forks source link

Running script before each commit to auto format and test #85

Open PengVidDev opened 1 year ago

PengVidDev commented 1 year ago

[ ] Bug
[ ] Clean up
[ ] Question
[x] Enhancement
[ ] Suggestion
[ ] Other

What needs to be done.

Writing a script to run before each commit to automatically:
- Run lint:fix to ensure that files are being formatted correctly
- Run tests to ensure that behavior of code is validated

Why

Sometimes we forget to run tests or fix linter issues after working on the code, good to have an automated way to do all of this because we are lazy and are eager to work on next task 😄.

How

Using Husky and git hooks (pre-commit) to run script when committing changes
More about Husky

github-actions[bot] commented 1 year ago

Welcome to your first issue! A maintainer will review the Issue and get back to you as soon as possible.

PengVidDev commented 1 year ago

Currently working on this at the moment, and doing some testing.

Sukhacoder02 commented 1 year ago

Can I take this up, @PengVidDev ?

PengVidDev commented 1 year ago

Can I take this up, @PengVidDev ?

yes please, been busy.

rielAsh24 commented 1 year ago

Hey @PengVidDev ! I tried working with this and was able to add a pre-commit hook using husky. It performs both linting and tests on the codebase.

https://github.com/BrandonArmand/Binari/assets/89381263/291eda92-68b1-4195-bffe-5d07f396561e