Normes et standards

JavaScript

• Pour l'écriture du code, utilisez le standard StandardJs.
• Utilisez la camelCase lorsque vous nommez vos variables, objets, fonctions et instances
• Utilisez la PascalCase lorsque vous nommez vos constructeurs ou vos classes
• Utilisez le suffixes Component ou Composant dans le nom d'une classe représentant un composant.

Variables

1. Utilisez des noms de variables significatifs et prononçables
2. Utilisez le même vocabulaire pour le même type de variable
3. Utilisez des valeurs nommées que l'on va pouvoir retrouver
4. Ne pas ajouter de contexte inutile
5. Utiliser des valeurs de variables par défaut au lieu de multiples if

Un nom de variable doit:

• Commencer par une lettre (alphabet ASCII)
• se composer de lettres, de chiffres et des caractères « _ » et « $ » (à l'exclusion de l’espace).
• Le nombre de caractères n'est pas précisé. => on essaie de rester court!
• JavaScript est sensible à la casse (majuscules et minuscules).

Un nom de constante doit:

• Commencer par une lettre (alphabet ASCII)
• se composer de lettres, de chiffres et des caractères « _ » et « $ » (à l'exclusion de l’espace).
• Le nombre de caractères n'est pas précisé. => on essaie de rester court!
• TOUT EN MAJUSCULE! => norme dans la plupart des langages

Fonctions

1. Pas plus de deux paramètres par fonction
2. Les fonctions doivent faire une seule chose (un seul rôle)
3. Les noms de fonction doivent dire ce qu'ils font
4. Supprimer le code en double (redondant)
5. Supprimer le code mort (ne pas mettre du code en commentaire au cas)

Tests

1. Un seul concept par test
2. Utilise le AAA (Arrange, Act et Assert)
3. Teste les cas limites
4. S'exécute rapidement
5. Comporte des tests qui ont des noms significatifs
6. Exécution simple et automatique
7. Couvre toutes les lignes de code
8. Indépendant
9. Lisible
10. Répétable

Français ou anglais ?

• L'écriture du code (classes, méthodes, variables, etc.) est soit en anglais ou soit en français, mais pas les deux.
• L'affichage dans le navigateur doit être en français.
• La description des tests doit être en français.
• Les commentaires dans le code, si nécessaires, doivent être en français.