Linter

Outil utilisé

Pour le Linter de notre projet, nous avons décidé d'utiliser les correcteurs implémentés de base à nos éditeurs de texte. En complément à cela, nous utilisons également l'extension Kite, qui permet une auto-implémentation de grande qualité.
Egalement, Symfony est doté d'un linter de qualité qui permet de détecter n'importe quelle erreur qui aurait pu passer au delà du vérificateur de Visual Studio Code. Il s'agit de commande à entrer dans le terminal et qui permet de vérifier si tous les fichiers cités dans la commande sont correctement implémentés (pas de faute de syntaxe, pas de mauvaise conventions utilisées, ...)
Son utilisation est très simple, il suffit de se situer dans la racine du projet et d'exécuter en terminal la commande lint:twig <nom_fichier> ou lint:controller <nom_dossier>, la première commande permet de contrôler les bonnes conventions d'un controller dans un fichier spécifique, tandis que la seconde permet d'exécuter cette vérification directement dans un dossier (ex : lint:twig Template permet de vérifier les conventions normalement utilisées dans la création d'un fichier twig dans le dossier Template).
Cette méthode fonctionne également avec fichiers container, les xliff ainsi que les fichiers de configurations yaml.
Nous pouvons également demander une sortie sous format JSON si nous en avons besoin grâce au paramètre "--format=json".
Ce linter permet ainsi la bonne vérification de tout le code en plus de Visual Studio.

Règle de syntaxe

Nous avons décidé d'utiliser au maximum l'anglais dans nos codes, mettre toujours à jour la syntaxe de nos codes pour que ceux-ci soient agréables et simples à lire pour un autre élève du groupe. Nous avons également décidé, comme cité dans la déclaration de notre API, d'utiliser des règles de nommage dites "snake_case" c'est-à-dire que chaque mot composant nos méthodes devront être séparés d'un "_", quelques corrections seront à apporter à ce niveau dans le code.
Nous n'avons pas imposé la déclaration de commentaires bien que ceux-ci soient les bienvenus lors de portions de code complexes.