Français SQF linter

  • Auteur de la discussion Auteur de la discussion I'm the Boss
  • Date de début Date de début

I'm the Boss

Leader
Membre du personnel
2/1/20
717
3
44
1 100
[En écriture]
* Définition
Un linter est un programme permettant de vérifier votre code sans l’exécuter.
* Introduction
Dans ce tutoriel je vous propose d'utiliser le linter de Lord Golias pour vous permettre de vérifier votre code fichiers par fichiers mais également pour un projet entier pour GitLab. Ce projet fonctionne aussi bien sur Linux que sur Mac ou Windows.
* Installation
- Installation de python
Rendez-vous sur le site officiel de Python pour y télécharger la dernière version (fonctionne pour Python 3.6.1 +)
- Installation de pip
Le système pip permet l'installation de modules pour python de façon rapide et simple. Pour vérifier que vous l'avez ouvrez votre cmd windows et entrez pip ou encore pip3. Si l'une des deux commandes fonctionne, vous pouvez passer à l'étape suivante.
Sinon voici la procédure:
Téléchargez le fichier get-pip.py et enregistrez le puis exécutez le sur votre ordinateur.
- Installation du module sqflint
Dans la cmd windows, entrez pip install sqflint ou encore pip3 install sqflint
- Installation du linter SQF
Téléchargez le projet gitLab SQF linter et enregistrez le sur votre ordinateur.
- Paramétrage GitLab
Si votre mission n'est pas sur gitLab, vous pouvez passer cette étape.
Sur votre projet gitlab, ajoutez un fichier .gitlab-ci.yml. Au prochain push, une documentation sera généré vous donnant les erreurs et les warnings:
1573839630216-7e46de3b-d95a-4b7d-a71b-b4d521911e03-image.png
1573839576507-72bb2103-9d67-42b3-9542-73abbfb5300b-image.png
1573839606019-8d2e359c-b686-4e94-88b1-4b0663c27373-image.png
- Paramétrage Notepad ++
Pour avoir la possibilité de taper F9 sur notepad++ puis avoir une console vous détaillant très rapidement les erreurs et les warnings de votre code actuel, il faut suivre la procédure suivante:
Sélectionnez le code linter.py et placez le dans un path connu de votre ordinateur C:\Users\Megaport\Desktop\sqf_linter\linter.py. Sur notepad++ faîtes F5 et entrez:
C:\Users\Megaport\AppData\Local\Programs\Python\Python36\python.exe -i C:\Users\Megaport\Desktop\sqf_linter\linter.py $(FULL_CURRENT_PATH) (Le chemin vers votre python sera surement différent du mien)
1573840142301-009c938e-2862-4855-8464-1f7b41b6e6f8-image.png
Le résultat est une console qui s'ouvre et donne les erreurs comme ceci:
1573840361256-9e42477b-8487-4ffc-bd08-1f3d090bc56d-image.png
Vous pouvez utilisez ce script pour vérifier les fichiers sans passer par notepad ++.
- Checkup global
Pour faire le scan de tous les fichiers de votre mission, placez simplement le dossier de mission dans votre mission et lancez le main.py