🐛 Point to locally installed schema definition by default

[nikoheikkila]

Environment information

CLI:
  Version:                      2.3.1
  Color support:                true

Platform:
  CPU Architecture:             aarch64
  OS:                           macos

Environment:
  BIOME_LOG_PATH:               unset
  BIOME_LOG_PREFIX_NAME:        unset
  BIOME_CONFIG_PATH:            unset
  BIOME_THREADS:                unset
  NO_COLOR:                     unset
  TERM:                         xterm-256color
  JS_RUNTIME_VERSION:           v20.11.1
  JS_RUNTIME_NAME:              node
  NODE_PACKAGE_MANAGER:         bun/1.3.1

Biome Configuration:
  Error:                        The configuration schema version does not match the CLI version 2.3.1
  Status:                       Loaded with errors
  Path:                         biome.json
  Formatter enabled:            true
  Linter enabled:               true
  Assist enabled:               true
  VCS enabled:                  true

Workspace:
  Open Documents:               0

What happened?

I have configured Renovate bot to automatically update Biome along with other packages. After merging the Renovate update, I consistently hit a warning about Biome installation drifting from the configuration schema.

biome.json:2:13 deserialize ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ The configuration schema version does not match the CLI version 2.3.1
  
    1 │ {
  > 2 │ 	"$schema": "https://biomejs.dev/schemas/2.3.0/schema.json",
      │ 	           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    3 │ 	"vcs": {
    4 │ 		"enabled": true,
  
  ℹ   Expected:                     2.3.1
      Found:                        2.3.0
  
  
  ℹ Run the command biome migrate to migrate the configuration file.

Expected result

Since Biome is shipping the schema in path node_modules/@biomejs/biome/configuration_schema.json I suggest it's used as the default for new projects. If necessary, biome init script could provide a flag or interactively ask for this.

Code of Conduct

• I agree to follow Biome's Code of Conduct

[ematipico]

There are pros and cons to both:

Schema pros:

• portable
• it doesn't require node_modules
• Since Biome can be installed as a binary, it's a good alternative

Schema cons:

• requires migration
• doesn't work without an internet connection

Local pros:

• works without an internet connection
• doesn't need migration

Local cons:

• depends on node_modules, so for binary installations, it wouldn't work
• if biome is installed via pnpm (which uses symbolic links), there IDE that aren't able to resolve the schema from a symbolic links

Initially, we chose node_modules, and changed to the web schema.

[dyc3]

We could check for node_modules and prefer the local schema in that case.

[nikoheikkila]

Fair enough, I see the points.

Would it make sense then to additionally publish a major version schema via https://biomejs.dev/schemas/2/schema.json, which would proxy to the latest available schema version for Biome 2? Provided people keep their Biome installations up-to-date, migrations could potentially become easier.

[ematipico]

We have it already. Replace the version number with latest