Add pre-commit checks and fix its complaints

[egeakman]

Closes #497

We can change the maxkb argument to our needs.

Added some handy checks as well.

Since we are using pre-commit, we might want to add that to a requirements-dev.txt.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
ep2024	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 2, 2024 9:08pm

[egeakman]

It's currently set to 5MB

[patrick91]

@egeakman this is amazing, can we add some instructions to the readme for installing pre-commit?

Also, maybe it is worth adding https://pre-commit.ci/ to this repo, so we are sure we always run it 😊

we should also probably add prettier!

[egeakman]

I think it's a good idea to add pre-commit.ci here. I can't add it though, maybe a repository admin can?

[egeakman]

Prettier's result is pretty noisy, it changes ~43 files. I'll push the changes, but we probably should check the preview carefully.

[patrick91]

@artcz would you be ok with pre-commit ci? we could do a github action, but pre-commit ci is faster and free 😊

[egeakman]

Prettier somehow breaks it.

It turns;

{/* into {/\*

and

*/} into \*/}

Oh, and it works in dev build, but not in prod build

[egeakman]

Found lots of similar issues like this and this...

Turns out that prettier only supports MDX v1.

We can add an ignore flag to each problematic line, or we can simply skip all MDX files.

This is the final noise level, we can ignore some files such as pnpm-lock.yaml to reduce noise.

[egeakman]

@patrick91 hi! I reduced the amount of changed/affected files by ~half.

prettier now:

• doesn't touch the lock file,
• doesn't add a trailing comma everywhere,
• keeps the tab width consistently at 2 spaces

How should we proceed?

[patrick91]

Awesome, thanks!