@ogea12/eslint-config est un package permettant de bénéficier de la configuration ESLint utilisée dans les projets de l'OGEA 12. Cette configuration est compatible avec la version d'ESLint 9.x, elle utilise notamment le format de fichier flat config.

Premiers pas

Installation

Pour utiliser le package, vous devez d'abord l'intégrer dans votre projet.

npm install -D @ogea12/eslint-config

# Assurez-vous également d'installer le package suivant
npm install -D eslint

Utilisation

Une fois l'installation terminée, vous pouvez ajouter le fichier eslint.config.js dans votre projet. Ce-dernier doit contenir l'initialisation de la configuration, comme ci-dessous.

// eslint.config.js

import { configure } from '@ogea12/eslint-config'

export default configure()

La configuration peut être étendue avec vos propres règles, vos propres plugins, ...

// eslint.config.js

import { configure } from '@ogea12/eslint-config'

export default configure({
  name: "Ma config' personnalisée",
  rules: {
    // Désactive la règle suivante
    'jsdoc/require-description-complete-sentence': 'off',

    // Active la règle suivante
    'jsdoc/check-types': 'warn',
  },
})

Une liste par défaut de fichiers est exclue de la configuration, il n'est donc pas nécessaire de fournir un fichier .eslintignore. Cependant, si certains fichiers ne figurent pas dans cette liste, il peut être interessant de les ajouter dans un fichier .eslintignore.

Vous pouvez également ajouter deux scripts pour utiliser l'analyseur ESLint dans le fichier package.json. Après avoir ajouté les scripts, vous pouvez exécuter les commandes npm run lint et npm run lint:fix afin d'analyser les fichiers du projet.

// package.json

{
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "eslint . --fix",
  },
}