git-hooks.nix VS lint-staged

> Good luck getting answers on those questions other than "read the source code" and then followed by "no, not that source code, this branch here".

I experienced a similar situation last week with git-hooks.nix[1], a pre-commit integration for Nix.

I wanted to run biome[2] checks on my repository during pre-push so I wrote a custom hook because git-hooks.nix has pre-defined integrations with prettier and rome, but not biome.

Or that's what I thought. I eventually found out that the rome hook is actually referred as "rome" everywhere but calls biome instead[3]. This wasn't documented anywhere, so I opened an issue[4] suggesting to rename the hook to "biome" and keep the former for backwards compatibility reasons.

As of today, this has been acknowledged by one of the maintainers, whose sole feedback has been to "thumb down" the issue.

TL;DR: It's not just the documentation, but also the code not doing what you would expect. It also seems there's no means to improve the situation other than just forking the project since there's also clearly some kind of communication problem.

[1] https://github.com/cachix/git-hooks.nix

Anyone who already uses Nix and Flakes can use this integration. Anyone who doesn't use Nix can just ignore me, because I'm not here to try converting unconvinced folks.

I don't think it does. I might look into implementimg it though, because I use pre-commit-hooks.nix in my own projects' CI.

> My least favourite bug is that it doesn't always play nicely with NixOS [1], and the maintainer locked me out of the issue for pointing it out.

Oof. Does this solve the problem https://github.com/cachix/pre-commit-hooks.nix (using Nix to manage dependencies)?

I was looking at pre-commit the other day, and wanted to incorporate it into the Nix setup of my projects.

Was it not possible to use something like this? https://github.com/cachix/pre-commit-hooks.nix

Maybe consider adding this to https://github.com/cachix/pre-commit-hooks.nix once you feel it's mature enough.

Lint Staged: https://github.com/lint-staged/lint-staged

lint-staged is the second important tools we need here, install it via NPM.

We were already using lint-staged and have a pre-commit hook in place using Husky in our project for linter and prettier. So it made sense to add a check here.

Now you can config it in your package.json, here is the guide doc:

In the world of software development, maintaining consistent code quality and ensuring that the codebase adheres to predefined patterns and guidelines is crucial. However, manually enforcing these standards can be time-consuming and error-prone. This is where automation tools like Husky, Lint-Staged, Commitlint, and Commitizen come to the rescue. In this post, we will explore how these tools can be combined to streamline your development workflow.

This is wasted work that can and should be automated. Adding a linter and formatter on CI and a pre-commit hook such as lint-staged can do wonders.

lint-staged is a package that can be used to run formatting and linting commands on staged files in a Git repo.

To answer your next question: I lint and format on save, and I use Git hooks installed by Husky and executed through Lint-Staged (this tool helps ensure your Git hooks only run on modified files, etc) to ensure there are no lint or formatting errors whenever making a commit or pushing code. This is helpful for teams, as some developers tend to forget to run lint tasks, or don't have the Prettier extension installed in their IDE. If there are lint errors, the commit is rejected until fixed. YMMV - you'll need to fine-tune the strictness of this based on the team's needs.

Uses Husky Git hooks and Lint-staged pre-commit hooks.

Something else to consider is applying linting and formatting before every git commit. A package like Lint-staged only lints and formats on staged items, ensuring all pushed code follows the standards in the repo. This allows developers to have their own formatting preferences when developing, while the code homogenizes on push. Linting pre-commit also avoids strict rules like no-console or no-unused-vars restricting a developer when writing code, when it should only apply in production. Imagine not being able to console log anything during development!