Error on mismatched $schema version

[jtannas]

Motivation

Due to automated dependency updates, I would like a built-in way to validate that the $schema version in the config matches the installed version.

This builds on the schema version warning added in #4147, but I need the ability to enforce this in CI/CD pipelines.

This would allow CI to catch configuration drift as soon as the update is made.

Current Situation

When the $schema version is mismatched, both biome migrate --error-on-warnings and biome rage --error-on-warnings still return 0 exit codes.

`biome migrate` Output

$ bun run biome migrate --error-on-warnings && echo "SUCCESS" || echo "FAILED"
/home/jtannas/tp2/biome.json migrate ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Configuration file can be updated.

     1  1 │   {
     2    │ - → "$schema":·"https://biomejs.dev/schemas/2.2.4/schema.json",
        2 │ + → "$schema":·"https://biomejs.dev/schemas/2.4.0/schema.json",
     3  3 │   	"vcs": {
     4  4 │   		"enabled": false,


configuration ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Migration results:

  - /home/jtannas/tp2/biome.json: configuration needs migration.

  ℹ Use --write to apply the changes.

  $ biome migrate --write


SUCCESS

`biome rage` Output

bun run biome rage --error-on-warnings && echo "SUCCESS" || echo "FAILED"
CLI:
  Version:                      2.4.0
  Color support:                true

Platform:
  CPU Architecture:             x86_64
  OS:                           linux

Environment:
  BIOME_LOG_PATH:                    unset
  BIOME_LOG_PREFIX_NAME:             unset
  BIOME_LOG_LEVEL:                   unset
  BIOME_LOG_KIND:                    unset
  BIOME_CONFIG_PATH:                 unset
  BIOME_THREADS:                     unset
  BIOME_WATCHER_KIND:                unset
  BIOME_WATCHER_POLLING_INTERVAL:    unset
  NO_COLOR:                     unset
  TERM:                         xterm-256color
  JS_RUNTIME_VERSION:           v20.19.6
  JS_RUNTIME_NAME:              node
  NODE_PACKAGE_MANAGER:         bun/1.3.9

Biome Configuration:
  Error:                        The configuration schema version does not match the CLI version 2.4.0
  Status:                       Loaded with errors
  Path:                         biome.json
  Formatter enabled:            true
  Linter enabled:               true
  Assist enabled:               true
  VCS enabled:                  false
  HTML full support enabled:    unset

Workspace:
  Open Documents:               0

SUCCESS

This led me to making a fragile hack of grep-ing the output to see if the config needs updates.

// package.json
"scripts": {
	"biomePrecheck": "bun run biome migrate | grep \"no migration needed\"",
	"format": "bun run biomePrecheck && biome format",
	"lint": "bun run biomePrecheck && biome lint",
	"check": "bun run biomePrecheck && biome check",
}

Possible Solutions

1. Add a config to biome.json to require an up-to-date schema.

"strictSchema": true,

I personally like this option since it doesn't change existing behavior and applies to all commands without further user-code needed.

2. Make biome migrate --error-on-warnings / biome rage --error-on-warnings return an error code if a migration is suggested (breaking change)

3. Make biome rage / biome migrate return an error code if a migration is suggested (breaking change)