Automatic COMMITs and PRs checkers and PRE-COMMIT script for local development.

[cavearr]

pre-commit.mp4

Hello everyone!

I have finished integrating the automatic workflows, thanks to @TimRudy who has done a great job of standardization and review to be able to face this autoformatting using Prettier with guarantees.

Now, when we do a commit or a PR, the workflow first reformats the code, this way, we now always have clean and formatted code, following the same guidelines.

In addition to formatting the code, the linter (jshint) is passed.

If the linter fails, the PR or the commit fails and the other automated workflows will stop, this is a big step forward for optimizing github share credits.

On the other hand, we need to ensure commits from the developer with a minimum of quality. So I created a pre-commit script.

With this pre-commit script for git, on each commit the code will be formatted (with the process implemented by @TimRudy ) and the linter will be passed. If something goes wrong, the commit will stop until the developer fixes it.

On your next code update (git pull), when you install dependencies (npm install --legacy-peer-deps) or start the development environment (npm start), your Icestudio git environment will be updated to support this pre-commit.

The script is in scripts/git/pre-commit and during the installation process it is copied as .git/hooks/pre-commit. If you want to add more useful checks until the commit, add them in it.

This effort goes in the direction of standardizing the code and minimizing bugs in the Github repository.

Many thanks to all contributors.

📣 @TimRudy @lmcapacho @jojo535275 @Obijuan @Democrito

[jojo535275]

Tanks to both of you! And lest "make code prettier again" ;-)

[TimRudy]

Hi @cavearr, I can do further confirmations on Windows. You have already tested Windows I think?
I am using Git Bash as mentioned in scripts\git\pre-commit, but I don't always get the right results.

=> 1. Do commit so the hook runs:

But cmd can run manually:

$ npx json -I -f package.json -e "if (this.dependencies) { delete this.dependencies['fs-xattr']; delete this.dependencies['grunt-appdmg']; }"
json: updated "package.json" in-place

and also with "/dev/null", same result - no error about path:

$ npx json -I -f package.json -e "if (this.dependencies) { delete this.dependencies['fs-xattr']; delete this.dependencies['grunt-appdmg']; }" 2>/dev/null

(silent)
(or I tried "2>&1" at the end, and it shows the json: updated "package.json" in-place but again - no path error).
So there is something about the context in which my hook is running, like npm.

=> 2. Earlier in "winico" you put back the -p here: mkdir -p so we were fighting about Git Bash accepting the "-p". For me it does not accept. Do you want me to investigate further? I was wondering why you need -p because that command only runs on Windows yes?

Cheers let me know

[cavearr]

Hi @TimRudy ! thanks for try and for the feedback. I'm testing in windows but maybe i need to do it in a clean installation (my windows is plenty of wsl, multiple node installations...). I'll try tomorrow and fix it doesn't worry.

The npx json, really is only needed in osx, i maintain for all OSs thinking in future dependencies but for the moment we could enable this check only in OSX.

about the mkdir -p i ned to investigate further because removing -p, it fails in OSX ( i think Gruntfile need a lot of rework because a lot of things are not well segmented and this is one of this) , i'll research both things count with it.

[TimRudy]

fails in OSX -> things are not well segmented

I see. Thanks, I hope you don't spend too much time.

[cavearr]

I'm opening an issue with this problems to thread this in the correct place (a bug)