🎯 Intention

Un Linter est un outil servant d’analyse statique de code afin de notifier les erreurs courantes et les mauvaises pratiques.

Chaque projet Captive doit utiliser les configurations partagées (open-source et sur hébergées sur github.com) et les maintenir à jour afin de bénéficier des meilleurs pratiques connues par Captive.

Les configuration Captive sont volontairement :

• Strictes : on cherche à éviter un maximum de problème en production
• “Opiniated” : certaines règles peuvent ne pas faire l’unanimité (ex: formattage), elle doivent être adoptées pour obtenir un code uniforme et standard en terme de qualité.

<aside> ✅ Pré-requis

• L’outil de Lint correspondant au langage est déjà installé sur le projet
• Connaitre la configuration d’un outil de Lint pour son projet (ESLint, Rubocop, etc) </aside>

✅ Points clés

<aside> ⌛ Temps indicatif : 30min

</aside>

Etape

Visuel / Exemple

🛠️ Configuration des outils Lint

Configurer le projet en utilisant la bonne configuration et en suivant les instructions du README.md

• ✓ Utiliser la configuration partagée de Captive

  Format	Outil
  ‣	‣ + ‣
  ‣
  ‣	‣ + ‣
  JSON, YAML	‣ + ‣
  SASS, SCSS, CSS	‣ + ‣

• ✓ Vérifier que la tâche lint (make / npm / bundle / …) affiche seulement les erreurs et n’écrit dans aucun fichier

• ✓ Vérifier que la tâche format (make / npm / bundle / …) affiche et corrige les erreurs

• ✓ Vérifier que la CI lance bien les jobs correspondant

• Raison

• ESLint / Stylelint

• Rubocop

🛠️ Configuration des githooks

Voir ‣

• ✓ S’assurer que les linters sont lancés en hook de pre-commit
  • Utiliser la combinaison husky + lint-staged si possible
• ✓ Le temps pris par les hooks doit être acceptable (de l’ordre de quelques secondes, il ne sera jamais instantané)
• Raison

{
  "scripts": {
    "postinstall": "npx run-p \\"prepare:*\\"",
    "postinstall:githooks": "[ -n \\"${CI:-}\\" ] || git config core.hooksPath .githooks"
  },
  "lint-staged": {
    "*.{mjs,cjs,js,jsx,ts,tsx,json,jsonc,json5,yml,yaml,vue}": "eslint",
    "*.{css,scss,vue}": "stylelint"
  }

  // Pas de devDependencies pour améliorer la CI
  // - uniquement utile en local
  // - installée à la volée via npx
}

#!/bin/sh

npm exec -- lint-staged

Exemple de projet:

❌ Erreurs type à éviter