Outils de développement: Difference between revisions

Outils de développement (view source)

Revision as of 10:31, 30 June 2024

88 bytes removed , 2 years ago

m

→‎Installer le hook git Pre-commit

VisualWikitext

Eldy

Bureaucrats, Interface administrators, Administrators

31,003

edits

@@ Line 113: / Line 113: @@
 ===Installer le hook git Pre-commit===
-L'utilisation de ce hook git est essentiel pour vérifier la syntaxe des fichiers qui sont commité et pouvoir annuler celui-ci si la syntaxe est mauvaise. Si phpcs et phpcbf sont installés, les erreurs de  formatage de code peuvent être modifiées automatiquement. Voici comment faire:
-Dans votre dépôt GIT local, copiez le fichier '''./dev/setup/git/hooks/pre-commit''' dans le dossier '''.git/hooks''' (à la racine de votre dépôt git local) et rendez-le exécutable.
+Vous pouvez utiliser des hooks git pour vérifier la syntaxe du fichier que vous validez et annuler (ou mieux corriger automatiquement) la validation si quelque chose ne va pas.
-Ensuite, il est nécessaire d'éditer le fichier '''pre-commit''' présent dans '''.git/hooks''' du projet Dolibarr pour modifier la variable DIRPHPCS afin d'ajouter le chemin des outils phpcs et phpcbf (le laisser vide si les outils sont déjà disponibles dans la variable PATH).
+Les instructions pour installer un tel hook de pré-validation sont disponibles sur ce fichier :
-Ce type de hook est utilisé lorsqu'on utilise l'invité de commande mais aussi lorsque qu'un commit est créé avec un IDE commun (exemple Eclipse et Virtual Studio Code). Une fois installé, le hook démarrera lors de votre prochain commit pour reformater votre code, pour que votre code corresponde toujours aux règles de syntaxe de codage. Si tout le monde active ce hook, tout le monde utilisera la même règle de syntaxe de codage, il est donc fortement recommandé de l'activer si vous le pouvez.
+https://github.com/Dolibarr/dolibarr/tree/develop/dev/setup/pre-commit
+De tels hooks fonctionneront lors d'une utilisation en ligne de commande, mais peuvent également fonctionner lors d'une validation à l'aide de votre IDE commun (il a été validé avec Eclipse et VSC).
+Une fois installé, le hook démarrera lors de votre prochain commit pour reformater votre code, afin que votre code corresponde toujours aux règles de syntaxe de codage. Si tout le monde active ce hook, tout le monde utilisera la même règle de syntaxe de codage, il est donc fortement recommandé de l'activer si vous le pouvez. Si quelque chose ne va pas dans la syntaxe, la validation sera immédiatement annulée. S'il peut être corrigé automatiquement, phpcbf, installé lors de l'installation du hook de pré-validation, le corrigera donc il vous suffira de réessayer le commit une seconde fois pour le valider.
 =[[File:Computer.png]] Optionnel=
 Vous pouvez aussi installer des composants optionnels pour avoir le support de technologies suplémentaires.
 Voir la page [[Outils de développement - Composants optionnels]].