📚 Document Biome Exit Codes

[NicolasCwy]

Documentation URL

https://biomejs.dev/recipes/git-hooks/#lint-staged

Description

Have a section in the documentation talking about the exit codes of Biome after running a command with different results

Expectations

Similar to Eslint, could we add a section on exit codes in Biome - this would be useful for scripts e.g pre-commit hooks that use the result of the Biome lint and block the process if necessary

I am still using a pre-commit hook as I am also using style-lint for CSS - and would like to keep it this way at least for now

Code of Conduct

• I agree to follow Biome's Code of Conduct

[ematipico]

We thought about having this section, but at the moment we have specific status codes, so the introduction of such section would be pointless, don't you think ?

[NicolasCwy]

@ematipico What do you mean status codes? Is there anything I could use to block a commit run in a commit hook after running biome check and there are lint errors present which are not safe fixes and require user intervention

[ematipico]

Sorry, I meant "exit codes". At the moment, we have 0 and 1. I believe we pondered this feature (having different exit codes like prettier and eslint), but we never managed to do it. You could create a task for it and help us implement it.

[sschneider-ihre-pvs]

What log level produces which exit code ?

[siketyan]

@sschneider-ihre-pvs Only error diagnostics will produce exit code 1 by default, 0 otherwise. If you provide the --errors-on-warnings option, warning and error diagnostics will produce exit code 1.

[ematipico]

This is documented here: https://biomejs.dev/reference/diagnostics/#diagnostic-severity