How to keep code within coding standards?

[pakricard]

Hi @timschofield:

I realized you manage to remove the trailing spaces at the end of each line, and I keep forgetting them there ;-)

I am testing the prompt "cleanup the code following the standards of https://weberp.org/CodingStandards.html" in VSC Copilot, with inconsistent results.

Do you have a script you can share to perform a “clean up” after editing?

As these days we are checking most of the code now to make it v5-ready, should we update the https://weberp.org/CodingStandards.html so we clean it up at the same time?

Thanks,
R

[timschofield]

Hi Ricard, I have some git hooks that are run just before a commit is made. One of them runs the script through the dos2unix utility (https://dos2unix.sourceforge.io/) which standardises all line endings to Unix style (Git can get funny about mixed line endings). Along the way it removes any trailing white space.
I also have hooks that check for any syntax errors, checks some variable names are capitalised properly, and produces a commit message that uses my own commit message template.
I am out for pretty much the whole day today, but I will try to post these hooks along with instructions for use this evening.

Thanks
Tim

[timschofield]

Hi Ricard (and anyone else who is interested. I have put my hooks here:

https://github.com/timschofield/hooks

These need to be installed in your .git/hooks folder for every repository you want to use them. All the files need to be given executable permissions. They do depend on the dos2unix utility which I linked to earlier. There are windows versions, and all Linux distros will have it in their repositories.

Once they are installed you should find they are run when you issue a commit command. If errorrs are found the commit will abort, otherwise it will continue the commit.

There is a script called prepare-commit-msg which produces a formatted commit message that is in a style I like. Feel free to adapt it, and if you don't care just delete it. For some reason when I wrote it I used command line PHP which you will need installed for it to work.

Hope this helps,
Tim

[pakricard]

Thanks, Tim. Sure it helps!
Will set these up ASAP and come back if I face any issue.
Thanks,
R

[pakricard]

After a few hiccups due to Windows, and with the help of Copilot, I got the pre-commit working. Thanks!