oxc-project/migrate-oxfmt

Was macht migrate-oxfmt?

Leitfaden zur Migration eines Projekts von Prettier oder Biome zu Oxfmt. Verwenden Sie dies, wenn Sie aufgefordert werden, den Formatierer eines JavaScript/TypeScript-Projekts von Prettier oder Biome zu Oxfmt zu migrieren, konvertieren oder umzustellen.

Übersicht

Oxfmt ist ein schneller und zuverlässiger Code-Formatierer für JavaScript, TypeScript und JSX, der in Rust geschrieben ist. Es dient als Drop-in-Ersatz für Prettier oder Biome und bietet eine deutlich höhere Formatierungsgeschwindigkeit.

Schritte zur Migration

1. Entfernen der alten Abhängigkeit

   npm uninstall prettier
   # oder
   npm uninstall @biomejs/biome
   

2. Installieren von oxfmt

   npm install --save-dev oxfmt
   

3. Editor-Integration konfigurieren

   • VS Code: Fügen Sie folgende Einstellungen in .vscode/settings.json hinzu:

     {
       "editor.defaultFormatter": "oxc-project.oxfmt",
       "editor.formatOnSave": true
     }
     

   • Neovim: Fügen Sie oxfmt zum formatprg hinzu oder verwenden Sie ein Plugin wie conform.nvim.
   • JetBrains: Konfigurieren Sie einen externen Tool-Dienst für oxfmt.

4. Projektkonfiguration aktualisieren

   • Entfernen Sie .prettierrc oder biome.json aus dem Projektstammverzeichnis.
   • Fügen Sie oxfmt.config.json mit Ihren Einstellungen hinzu:

     {
       "tabWidth": 2,
       "useTabs": false,
       "semicolons": true,
       "singleQuote": true,
       "trailingComma": "all"
     }
     

5. CI/CD-Pipeline aktualisieren Ersetzen Sie Prettier/Biome-Befehle durch Oxfmt in Ihren CI/CD-Konfigurationsdateien (z. B. .github/workflows/*.yml):

   - name: Format-Check
     run: npx oxfmt --check src/
   

6. Formatieren des gesamten Projekts

   npx oxfmt src/
   

Wichtige Hinweise

• Kompatibilität: Oxfmt zielt darauf ab, weitgehend kompatibel mit Prettier zu sein, aber es kann zu geringfügigen Unterschieden in der Ausgabe kommen. Überprüfen Sie immer die Änderungen nach der Migration.
• Ressourcen: Offizielle Dokumentation finden Sie unter oxc.rs.
• Unterstützte Sprachen: JavaScript, TypeScript, JSX, TSX.

Fehlerbehebung

• Problem: Oxfmt formatiert einige Konstrukte anders als Prettier. Lösung: Passen Sie die Konfiguration in oxfmt.config.json an, um die gewünschte Ausgabe zu erzielen. Öffnen Sie bei anhaltenden Problemen ein Issue im Oxc-Repository.

• Problem: Der Befehl npx oxfmt wird nicht gefunden. Lösung: Stellen Sie sicher, dass oxfmt im Projekt installiert ist (npm install --save-dev oxfmt) und dass Ihr node_modules/.bin im PATH enthalten ist.