Force local linting

[mrsimpson]

Motivation

Linting as in #367 is essential for concise PRs.
Linting should be enforced prior to merging, latest in CI.

However, it's a bad contributor experience and a waste of resources if a contributor pushes his changes, considers things done and only a pipeline fail tells him that his IDE forgot to prettify for him/her ;)

What's in this PR

This PR adds a pre-commit-hook which lints the code and fixes easy fixes (such as blanks or semicolons) on the contributor's machine. As the name suggests, this process runs prior to completing the commit, meaning the developer can't commit with linting issues.

Considerations

• This PS is based upon Linting #367 and should be merged 🔜 after this PR
• Inexperienced developers may not understand that the linting happens pre-commit. I added a section to the contributions-guidelines to make this clear. Those who don't read this, well ...
• Once there's a CI/CD in place, we could relax the check in various ways (e. g. that it only lints but doesn't fail), but I'd not recommend to do that now.

[mrsimpson]

Give me a second with the actual merge, I figured that lint:fix might not be the best experience: If there are linting errors and the pre-commit fixes them, those changes will stay in the staging area but will not be automatically commited.
Thus, a subsequent pre-commit check will succeed without adding those to the commit.

Thus, I prefer some script which just checks and informs the developer about what he's got to do. I'll add that in a few

[mrsimpson]

I added a small shell script which informs the developer what's going on.
Here's how it looks like

I do think this is better DX than linted files that are stuck in the staging area 😬

Edit: Added a space after the ❌ which looked ugly.

[wonderwhy-er]

Soo. I did checkout, I use webstorm and it seems it ignores it and commits without it :D
I kinda view this as connivance.
In the end its repo rules that do not allow to merge that really enforce this.
I don't mind merging if it makes contributors life better.

[wonderwhy-er]

Looks like two people like it.
I guess let's go.

[mrsimpson]

Soo. I did checkout, I use webstorm and it seems it ignores it and commits without it 🫥

This is not a feature of the IDE, but if git itself. Even webstorm can't ignore it 😬

The hook is installed on first pnpm i . Did you perform it?

[wonderwhy-er]

In the end what I feared happend for me
This failed for me in WebStorm...

In terminal its ok

When I run IDE Git related things I get this

I just spent 15 minutes trying to make it work and I give up lol...
If you have ideas or desire to help I can give it a try....

But until then I at least disable precomit hook for myself.
And I am wondering how many may have such problem as well...
I am kinda not a fan of precomit hooks due to this additional dependency that fails in various situations.

[mrsimpson]

@wonderwhy-er it was not the typecheck that failed, but the subsequent linting.
If you run pnpm lint on the command-line, you'd see the same error.
Also, if you committed on the command-line, you'd get the same error.

The error also says "❌ Linting failed".

How could we improve verboseness?

But as the error also says: all of them should be fixable. Simply run pnpm lint:fix

[mrsimpson]

edit: @wonderwhy-er added a fix to the error message to better help you ;)