Biome npm-scripts Konfiguration

Dies ist das Muster für npm-scripts, das Sie fast immer einrichten, wenn Sie Biome in ein Projekt einführen. Es behandelt sowohl Lint als auch Format einheitlich mit dem biome check-Befehl.

Grundkonfiguration

{
  "scripts": {
    "lint": "biome check .",
    "format": "biome check . --write"
  }
}

Gruppierung mit Präfixen

In Projekten mit vielen npm-scripts erleichtert die Gruppierung mit Präfixen die Organisation.

{
  "scripts": {
    "code:lint": "biome check .",
    "code:format": "biome check . --write"
  }
}

Unterschiede zwischen den Befehlen

Befehl	Verhalten
biome check .	Erkennt Probleme und meldet sie, Exit-Code ist bei Fehler ungleich Null
biome check . —write	Behebt automatisch behebbare Probleme
biome format .	Führt nur Formatierung aus
biome lint .	Führt nur Linting aus

check führt sowohl Lint als auch Format aus. Es ist üblich, in CI check . zu verwenden und während der Entwicklung --write.

Verwendungsbeispiel in CI

Konfigurationsbeispiel in GitHub Actions:

- name: Code prüfen
  run: npm run lint

- name: Formatierung prüfen
  run: npx biome format . --check

Oder verwenden Sie check --changed, um nur geänderte Dateien zu validieren:

{
  "scripts": {
    "lint:changed": "biome check --changed ."
  }
}

Dadurch können Sie sich nur auf den Diff konzentrieren und die Verarbeitungszeit reduzieren.

Beziehung zu Konfigurationsdateien

Konfigurieren Sie Details in biome.json:

{
  "formatter": {
    "indentStyle": "space",
    "indentWidth": 2
  },
  "linter": {
    "enabled": true,
    "rules": {
      "recommended": true
    }
  }
}

Es ist am besten, npm-scripts als einfache Einstiegspunkte zu halten und die detaillierte Konfiguration an die Konfigurationsdatei zu delegieren.