haxe checkstyle

Haxe Checkstyle est un outil d'analyse statique pour aider les développeurs à écrire du code HAXE qui adhère à une norme de codage.

Il automatise le processus de vérification du code haxe pour épargner les développeurs de cette tâche ennuyeuse (mais importante).

Les conventions de code améliorent la lisibilité, permettant aux membres de l'équipe de mieux comprendre le code de chacun.

Idéal pour tout projet qui souhaite appliquer les conventions de codage.

L'analyse statique est généralement effectuée dans le cadre d'une revue de code.

CODE CLIMATE

Haxe CheckStyle est disponible sur la plate-forme Code Climate (GRATUIT pour les projets open source). Il nécessite un fichier .codeclimate.yml et un fichier checkstyle.json en option mais recommandé à ajouter à la racine de votre référentiel - voir ici pour plus de détails.

Lorsque tout est configuré, Code Climate exécute automatiquement Haxe CheckStyle pour vous sur chaque nouvel engagement (également sur les demandes de traction si elle est configurée de cette façon).

Le nombre actuel de problèmes peut être suivi via un badge:

Résultats immédiats, directement dans vos demandes de traction.

Installation

haxelib install checkstyle

Utilisation de base

haxelib run checkstyle -s src

Détection automatique de votre style de codage (expérimental)

haxelib run checkstyle -s src --detect detectedCheckstyle.json

Intégration VScode

Il existe une extension VScode pour Haxe-Checkstyle disponible dans le marché VScode. Il est actuellement construit avec Haxe-Checkstyle V2.4.1 et Tokenree V1.0.1. Vous pouvez afficher la version de développement ici: vscode-checkstyle

Compilation

git clone https://github.com/HaxeCheckstyle/haxe-checkstyle.git
npm install
lix download
haxe buildAll.hxml # for Neko and NodeJS version + run Unittests and create schema
haxe buildCpp.hxml # for C++ version

Compilation avec haxe 3

git clone https://github.com/HaxeCheckstyle/haxe-checkstyle.git
mv haxe_libraries haxe4_libraries
mv haxe3_libraries haxe_libraries
npm install
lix use haxe 3.4.7
lix download
haxe buildAll.hxml # for Neko and NodeJS version + run Unittests and create schema
haxe buildCpp.hxml # for C++ version

Référence

Plus d'informations et de référence.

Problèmes

Vous avez trouvé un bug? Veuillez créer un nouveau problème.

Couverture

Informations sur l'octroi de licences

Ce contenu est publié sous la licence MIT.

Ce projet a été dérivé de Haxelint créé par @mcheshkov.

Code de conduite des contributeurs

Le code de conduite est adapté de Contributeur Covenant, version 1.4