Built-in support for pre-commit hooks

[kevinwolfcr]

Hello! I think it would be very helpful to have built-in support for running pre-commit hooks that checks code before applying a commit. For people like me, who likes abstracting as much as possible and reducing dependencies, could be very beneficial. Also, the Git Hooks documentation page would be more straightforward and offer a single alternative (and I personally think this aligns with Biome's philosophy of being an all-in-one toolchain.

My current setup

I currently use simple-git-hooks and set it up to run bun biome check --staged --apply --files-ignore-unknown=true --no-errors-on-unmatched && git update-index --again on pre-commit.

This is how my current package.json looks like:

{
  "scripts": {
    "postinstall": "simple-git-hooks install"
  },
  "devDependencies": {
    "@biomejs/biome": "1.7.3",
    "simple-git-hooks": "2.11.1"
  },
  "simple-git-hooks": {
    "pre-commit": "bun biome check --staged --apply --files-ignore-unknown=true --no-errors-on-unmatched && git update-index --again"
  }
}

My ideal setup

If this idea gets accepted, the package.json will look like this:

{
  "devDependencies": {
    "@biomejs/biome": "1.7.3"
  }
}

Proposed solution

1. Allow the user to specify if they want to enable pre-commit hooks on the biome.json file:

{
   // other biome configurations...
  "vcs": {
    "clientKind": "git",
    "defaultBranch": "main",
    "enabled": true,
    "useIgnoreFile": true,
    "precommit": true
  }
}

Note

That precommit property could be extended maybe with a configuration object depending on the user needs?

Tip

By putting this into the configuration file, then users could easily share and abstract their configs and have the same behavior on their different projects

2. Automatically setup the git hooks on @biomejs/biome's postinstall script.

---

Thanks!