Standard de codage

Le standard de codage est conçu de manière à respecter les différentes directives mis en place par Angular 4. Ces directives décrivent un ensemble cohérent de conventions de codage, de nommage et d'espaces dans le code.

1. Conventions de fichiers

1.1 Extensions de fichier

Les extensions .ts , .html, .spec.ts et .css ou .scss sont utilisés pour représenter les différents fichiers. Par exemple : login.component.ts, login.component.html, login.component.css

1.2 Conventions de nommage de fichier

Les conventions de nommage devraient simplement aider à trouver le code désiré plus rapidement et le rendre plus facile à comprendre. Les noms des dossiers et des fichiers doivent clairement exprimer leur intention. Angular 4 recommande un modèle qui décrit la fonction du symbole puis son type. Les symboles doivent utiliser des noms cohérents. Le modèle recommandé est fonctionnalité.type.extension.

Par exemple : app / login / login.component.ts peut contenir un composant qui gère la connexion des utilisateurs.

Fonctionnalité : est une description de la fonction qu’un fichier représente. Par exemple : login, admin, users, connexion, s’enregistrer, etc.

Type : le type fournit un moyen cohérent d'identifier rapidement ce qui se trouve dans le fichier. Les noms de type fournissent une correspondance de modèle pour les tâches automatisées. Notamment, Angular 4 recommande d'utiliser .service, .component, .pipe, .module et .directive. Aussi, il est possible d’inventer des noms de types supplémentaires mais de faire attention à ne pas en créer trop.

Extension : est un suffixe de nom de fichier fait pour identifier son format. Angular 4 recommande les extensions .ts, .html, .css, .scss.

2 Conventions de codage

Le code doit respecter les règles définies dans le fichier tslint.json. Pour l'interprétation des règles voir ce document. La commande ng lint ou ng lint --type-check permet de vérifier si les règles sont satisfaites.