Forces linter check before commit

[ccolorado]

Forces linter (npx prettier) check to pass before git commit

Requires installation
$ npm install && npm run prepare

more options for npm and yarn @
https://typicode.github.io/husky/getting-started.html

[ccolorado]

Please review @omarespejel

[omarespejel]

Hey @ccolorado,

This is truly valuable, thank you!

Before merging, could you clarify: What steps do contributors need to follow to comply with this new process? The simpler the better. We want to ensure it's straightforward for them to contribute to the Book.

[ccolorado]

After husky is installed and prepared (npm install && npm run prepare). Whenever a commit is attempted a lint check will be trigger.
If the lint check succeeds, the commit will proceed as usual.
If it fails the commit will be aborted.

Users can opt out of this helper by:
a) Not running the prepare command
b) uninstalling husky instructions for both npm and yarn @ https://typicode.github.io/husky/getting-started.html

Usage Video

[dalmasonto]

Hello @ccolorado seems prettier failed on your side too, kindly run

npm i
npm run format

That way prettier problems will be evaded

[ccolorado]

Hello @ccolorado seems prettier failed on your side too, kindly run

npm i
npm run format

That way prettier problems will be evaded

Yeah I notice it failed on CI, but wierdly "works on my machine".
Forgot to mark pr as draft until i figure It out

[dalmasonto]

It will work locally but that does not pass when you push to github since it will try run its checks. Some files might be having issues within the code you pushed. Just formatting issues ie not formatted correctly that is why i was suggesting you run npm run format before pushing.

[omarespejel]

Thanks, @ccolorado! Your explanation clarified everything for me. Could you address the conflict in the foundry forge chapter update? It is because the chapter was badly formatted and we recently updated it, it is not fault of your PR. That would be all.

And a big thanks to @dalmasonto for the review!

[omarespejel]

Hey @ccolorado! Thank you for your contribution. Anything that makes the Book work and look better is very important! let me know if you want to contribute further, I know your abilities!
Thanks @dalmasonto for reviewing!