This repository provides Biome hooks for pre-commit.
The following section assumes that you installed pre-commit and run pre-commit install
in your repository.
Biome provides four hooks:
hook id |
description |
---|---|
biome-ci |
Check formatting, check if imports are organized, and lints |
biome-check |
Format, organize imports, lint, and apply safe fixes to the committed files |
biome-format |
Format the committed files |
biome-lint |
Lint and apply safe fixes to the committed files |
For example, if you want to use the biome-check
hook,
add the following pre-commit configuration to the root of your project in a file named .pre-commit-config.yaml
:
repos:
- repo: https://github.com/biomejs/pre-commit
rev: "" # Use the sha / tag you want to point at
hooks:
- id: biome-check
additional_dependencies: ["@biomejs/biome@1.4.1"]
Note that you must specify which version of Biome to use thanks to the additional_dependencies
option.
If Biome is already installed as a npm
package in your local repository,
then it can be a burden to update both package.json
and .pre-commit-config.yaml
when you update Biome.
Instead of using the provided Biome hooks, you can specify your own local hook.
For example, if you use npm
, you can write the following hook in .pre-commit-config.yaml
:
repos:
- repo: local
hooks:
- id: local-biome-check
name: biome check
entry: npx biome check --write --files-ignore-unknown=true --no-errors-on-unmatched
language: system
types: [text]
files: "\\.(jsx?|tsx?|c(js|ts)|m(js|ts)|d\\.(ts|cts|mts)|jsonc?|css|svelte|vue|astro|graphql|gql)$"
The pre-commit option files
is optional,
because Biome is able to ignore unknown files (using the option --files-ignore-unknown=true
).