👩‍💻 Add pre-commit hooks

[Aeris1One]

Ajout de quelques pre-commit hooks.

Ce sont des vérifications qui tournent côté développeur et empêchent le commit si elles ne passent pas.

Ces vérifications sont :

• la validité des fichiers .json et .yaml
• le style via Black (avec autocorrection, si un commit est refusé par Black, il suffit de refaire le commit)
• les sauts de lignes en fin de fichier (idem)
• le message de commit correspond au format Gitmoji + Conventional Commit (:emoji: [type](scope): <message>)

---

Si cette PR est merge, il sera nécessaire pour tous les développeurs d'utiliser la commande pre-commit install après avoir installé les dépendances de Gipsy (dans le venv le cas échéant) afin d'installer les hooks dans leur .git local.

[ascpial]

Est-ce que les commits au format 👩‍💻 docs(misc): documented things passe ?

De la même manière est-ce que les vérifications sont faites pour les commits créés sur Github ?

[Aeris1One]

Pardon, j'aurais dû la mettre en draft, je n'ai pas terminé

[Aeris1One]

J'ai oublié de le commit en séparé mais je viens d'ajouter un hook PyLint.

⚠️ ATTENTION
Une fois cette PR merge, un commit sur un fichier sera refusé tant que des erreurs seront soulevées par PyLint sur celui-ci

---

Je viens également d'ajouter une configuration pour https://pre-commit.ci qui s'occupera de faire tourner les hooks sur les PRs et d'autoupdate les hooks chaque mois.
Il faut pour cela qu'un administrateur de l'organisation Gunivers autorise à https://pre-commit.ci l'accès (restreint) au dépôt Gipsy, j'en ais fait la demande, il ne manque que l'autorisation.

[VForiel]

Une fois cette PR merge, un commit sur un fichier sera refusé tant que des erreurs seront soulevées par PyLint sur celui-ci

Chiant/20 ça

[ZRunner]

Une fois cette PR merge, un commit sur un fichier sera refusé tant que des erreurs seront soulevées par PyLint sur celui-ci

Chiant/20 ça

Yup, même avis. Autant c’est un bon point pour refuser une MR, autant selon moi ça ne devrait pas empêcher de commit

Deuxièmement, y a-t-il un hook permettant de s’assurer qu’un commit ne contienne pas de token d’authentification (peu importe de quel service) ? Ça ne devrait pas arriver mais ça pourrait nous sauver un jour ou l’autre.

[ascpial]

Tant qu'on y est, il faudra aussi ajouter la commande pour installer les dépendances du pre-commit hook dans le fichier setup.py

[Aeris1One]

Je ne pense pas que ce soit souhaitable. Les pre-commits hooks sont pour les contributeurs là où le setup.py est prévu pour ceux qui veulent utiliser le bot.
Sans compter qu'il est possible d'utiliser le bot hors de git (en téléchargeant les sources en .zip tout simplement) et donc la commande ne servirait à rien et sortirai une erreur.

[ascpial]

Yup, même avis. Autant c’est un bon point pour refuser une MR, autant selon moi ça ne devrait pas empêcher de commit

@Aeris1One, y a-t-il moyen d'afficher seulement une alerte si il y a des erreurs pylint ?
Je penses aussi que bloquer le commit n'est pas une bonne idée.

[ascpial]

Au moment de merge, je conseilles que l'on recréé une PR avant de merge, puisque l'auto fix empêche de merge.

[Aeris1One]

Je propose de retirer le bloquage des linters (retirer PyLint) et ajouter un check regex pour empêcher de push un token par erreur

---

Yup, même avis. Autant c’est un bon point pour refuser une MR, autant selon moi ça ne devrait pas empêcher de commit

Cela dit je pense que bloquer les commits est une bonne idée pour être sûr que tout l'historique est propre, pas seulement les derniers commits de chaque PR ce qui permettrait quand nous remontons dans le temps de ne pas avoir à choisir avec 4 commits sur 5 qui sont "sales"

[ascpial]

Je suis d'accord, mais il faut indiquer les erreurs pylint et demander confirmation si les checks pylint échouent.
Dans mon cas, pylint met 20s à vérifier start.py, et je ne peux pas l'utiliser avec vscode car sinon il crash, il faut donc qu'ils soient tout de même affiché.

Je propose aussi de créer une page dans la documentation dédiée à la mise en place de l'environnement de développement.

[ascpial]

Les linters ne sont plus dans les actions github mais sont inclus directement avec pre-commit ?