oxc-project/migrate-oxlint

Que fait migrate-oxlint ?

Guide pour migrer un projet d'ESLint vers Oxlint. À utiliser lorsqu'on demande de migrer, convertir ou basculer le linter d'un projet JavaScript/TypeScript d'ESLint vers Oxlint.

Présentation

Oxlint est un linter plus rapide et plus efficace écrit en Rust, conçu pour remplacer ESLint dans les projets JavaScript/TypeScript. Ce guide vous aide à effectuer la migration en minimisant les perturbations.

Prérequis

• Un projet JavaScript/TypeScript existant utilisant ESLint
• Node.js installé
• npm ou yarn

Étapes de migration

1. Installer Oxlint :

   npm install --save-dev oxlint
   # ou avec yarn
   yarn add --dev oxlint
   

2. Supprimer ESLint :

   npm uninstall eslint
   # Supprimez également les plugins et configurations ESLint
   npm uninstall @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-react
   

3. Configurer Oxlint : Créez un fichier oxlintrc.json à la racine du projet :

   {
     "rules": {
       "no-unused-vars": "error",
       "no-console": "warn"
     },
     "plugins": ["typescript", "react"]
   }
   

4. Exécuter Oxlint :

   npx oxlint
   

5. Adapter les scripts npm : Mettez à jour package.json pour remplacer "lint": "eslint ." par "lint": "oxlint".

Règles incompatibles

Oxlint ne supporte pas toutes les règles ESLint. Pour les règles manquantes, vous pouvez :

• Utiliser des alternatives natives proposées par Oxlint
• Créer des règles personnalisées via l'API Oxlint
• Utiliser un outil de migration automatique pour convertir les configurations

Ressources

• Documentation officielle d'Oxlint
• Comparaison des règles ESLint vs Oxlint
• Dépôt GitHub d'Oxlint