Eslint

Utilité

• Pour avoir du code uniforme et donc plus lisible
• Pour s'assurer de respecter les meilleures pratiques (ex. typage)
• Pour détecter des problèmes (ex. le retour ne correspond pas au type déclaré)

Utilisation

• Pour lancer Eslint sur le projet
  • ng lint
  • Si l'extension n'est pas installé, on vous proposera de le faire à ce moment
• Un rapport vous sera fourni indiquant les erreurs et avertissements
• Exécuter ng lint --fix peut permettre de régler de façon automatique certains problèmes
  • De préférence, exécuter ng lint en premier pour voir le type d'erreurs attrapées et ne pas les répéter

Configuration

• Le fichier de configuration contient les règles pour le projet (eslint.config.js)
• Le fichier de configuration peut faire appel à un ensemble prédéterminé de règles (extends) auquel on ajoute nos propres règles (rules)
• Pour modifier une règle ou pour l'ajouter
  • Noter le nom de la règle à modifier dans l'IDE
  • Trouver la règle dans la documentation : https://typescript-eslint.io/rules/
  • Ajouter la règle dans "rules"

Ressources

• Documentation officielle de Eslint pour TypeScript https://typescript-eslint.io/
• Règles disponibles pour TypeScript : https://typescript-eslint.io/rules/
• Règles disponibles pour Angular : https://github.com/angular-eslint/angular-eslint/tree/main/packages/eslint-plugin
• Règles disponibles pour HTML : https://github.com/angular-eslint/angular-eslint/tree/main/packages/eslint-plugin-template