Nimalyzer est un analyseur de code statique pour le langage de programmation NIM. Il permet de vérifier un code source NIM contre des règles prédéfinies. Sa conception est inspirée par Adacontrol. Nimalyzer peut être utilisé pour appliquer certains modèles de conception ou s'assurer que certaines constructions de langue sont présentes dans un code, ou non. Par exemple, il peut vérifier si toutes les procédures ont défini des pragas appropriés. De plus, il peut être utilisé comme recherche avancée via un outil de code, par exemple trouver tous les variables publiques type d' intre avec le nom qui commence par NewVar . Il est contrôlé par des fichiers de configuration contenant un ensemble de règles, leurs paramètres et options liés au comportement du programme.
En ce moment, le projet est en scène bêta , la plupart de ses fonctionnalités sont ajoutées, mais elle devrait toujours avoir une belle quantité de bugs.
Si vous lisez ce fichier sur GitHub: veuillez ne pas envoyer de demandes de traction ici . Tout sera automatiquement fermé. Toutes les propositions de code doivent aller au référentiel fossile.
IMPORTANT: Si vous lisez le fichier dans le référentiel de code de projet: cette version du fichier est liée à la future version du programme. Il peut contenir des informations non présentes dans les versions publiées du programme. Pour cette information, veuillez consulter le fichier readme.md inclus dans la version.
Pour utiliser Nimalyzer avec votre projet, vous devez d'abord créer un fichier de configuration pour cela. Pour la syntaxe du fichier de configuration et la liste des règles disponibles, veuillez vous référer à la documentation du projet, disponible sous forme de texte restructuré dans le répertoire DOC. Dans votre fichier de configuration, vous devrez définir au moins un fichier source à vérifier et au moins une règle à utiliser.
Exécutez Nimanalyzer avec le chemin d'accès à votre fichier de configuration comme argument. Par exemple: nimalyzer config/nimalyzer.cfg et lisez simplement sa sortie. ;)
Des binaires autonomes sont disponibles pour FreeBSD, Linux et Windows dans des versions 64 bits. Ils sont disponibles sur la page de téléchargement. Il suffit de les télécharger et de les extraire dans le répertoire sélectionné.
Vous aurez besoin:
Vous pouvez les installer manuellement ou en utilisant Nimble. Dans cette deuxième option, tapez nimble install nimalyzer pour installer le programme et toutes les dépendances. Généralement, il est recommandé d'utiliser nimble release pour construire le projet en mode (optimisé) ou nimble debug pour le construire en mode de débogage.
Pour créer une version HTML de la documentation du projet, exécutez la commande nimble docs dans le répertoire principal du projet.
Si vous souhaitez mettre à jour la documentation du projet, généralement pas nécessaire, vous devez utiliser l'outil Gendoc inclus dans le projet.
Construisez l'outil Gendoc . Dans le répertoire du projet principal, exécutez nimble tools de commande. Il créera les outils nécessaires et les mettra dans le répertoire bac .
Dans le répertoire de l'homme, exécutez la commande bin/gendoc . Il mettra à jour la documentation du projet à partir du fichier de configuration par défaut et du code source du projet.
Le projet publié en vertu de la licence BSD 3-CLAUSE.
C'est tout pour l'instant, comme d'habitude, j'ai probablement oublié quelque chose d'important;)
Bartek Thindil Jasicki