Conventions de Développement et Tests

Conventions de Nom et de Style

Temps estimé :1 minute 31 views

Conventions de Nom et de Style

Pour assurer la maintenabilité, la lisibilité et la cohérence du code au sein de l’équipe de développement, voici les conventions suivies :

1. Conventions de Nom :

Composants Vue : Utiliser le PascalCase pour les noms des composants (Dashboard.vue, SignIn.vue).

Variables : Utiliser le camelCase pour les variables et fonctions (userProfile, fetchData).

Constantes : Utiliser SNAKE_CASE pour les constantes globales (API_BASE_URL, MAX_RETRY_COUNT).

Fichiers :

• Noms descriptifs en camelCase ou kebab-case pour les fichiers utilitaires (error-mapper.ts, jwt-service.ts).

• Utiliser des suffixes appropriés (store, service, component) pour identifier leur rôle (authStore.ts, categoryService.ts).

Routes : Les noms de route dans le routeur doivent être en camelCase (dashboard, signIn).

2. Conventions de Style :

• Respecter les règles de formatage définies dans ESLint et Prettier.

• Indentation par 2 espaces.

• Chaque fichier doit inclure une description en commentaire de son rôle au début, particulièrement pour les services et stores.

• Utiliser des commentaires JSDoc pour les fonctions complexes :

CONTENTS