Configuration Eslint pour Météo-France

Ce paquet fournit une configuration pour eslint conformément aux règles de codage en vigueur chez Météo-France.

###Installation Pour utiliser cette configuration il est nécessaire d'installer ESLint en verison 2.0 minimum et d'inclure ce paquet comme dépendance de son projet

npm install eslint eslint-config-meteofrance --save-dev

Ensuite, créer un fichier .eslintrc à la racine du projet avec le contenu suivant :

{
  "extends": "meteofrance"
}

Vous pouvez aussi choisir de configurer eslint depuis le fichier package.json en ajoutant un champ eslintConfig :

{
  "eslintConfig": {
    "extends": "meteofrance"
  }
}

###Personnalisation des règles

Ce paquet propose une base de travail, selon votre projet il est possible de surcharger ces règles.

En effet certaines règles proposées peuvent ne pas correspondre à l'environnement du projet ou ne pas être justifiées. Dans ce cas il est possible de les modifier dans la configuration de eslint.

Par exemple, la règle 9 concernant l'utilisation obligatoire des points virgules peut être assouplie en utilisant no-unexpected-multiline. Pour la règle 4, le forçage du mode strict peut être implicite suivant l'outillage ( utilisation de modules, outils de build ). Dans ce cas, il est possible de désactiver la règle en spécifiant "impliedStrict" : true dans les options du parser.

Ces exemples sont commentés dans les sources du paquet.

D'autres options de configuration sont disponibles dans la documentation de ESLint

###Utilisation La méthode la plus directe pour linter son projet et de créer une tache dans le fichier package.json qui appelle eslint sur son dossier de sources.

{
  "name":"mon-projet",
  "version":"1.0.0",
  "scripts": {
    "lint" : "eslint dossiersource"
  }
}

npm run lint

###Intégration à l'IDE

Dès lors que vous avez votre projet configuré avec un .eslintrc il sera utilisable dans un IDE digne de ce nom.

L'exemple le plus commun est celui de sublime texte qui propose un plugin pour eslint .

Il en existe aussi pour atom et visualstudio

Voici la liste officielle des intégrations disponibles