illuaminate

Illuaminer

Analyse du code source pour Lua

Illuamine est une série d'outils pour travailler avec le code source LUA, fournissant des moyens de rendre votre base de code plus claire et plus facile à comprendre. Il est actuellement plutôt nu, et toujours à un stade POC, mais nous espérons se développer et deviendra plus utile à mesure qu'il continue de se développer.

Caractéristiques

• De nombreuses caractéristiques d'analyse statique de base (détection de code morts, variables inutilisées, etc ...) ainsi que plusieurs linteurs de formatage (espace blanc, parenthèse redondante, etc ...).
• Fixeur de code automatique pour de nombreux problèmes détectés.
• Génération de documentation, en utilisant la syntaxe LDOC.

Bâtiment

Remarque: Utilisez le packer exécutable UPX afin de faire des fichiers compilés une taille raisonnable (cela les réduit de 4x). Il doit être inclus dans la plupart des gestionnaires de package.

Utilisation d'Opam

• Installez OPAM et configurez un commutateur OCAML> = 4.08.1 (par exemple, opam switch create 4.11.1 ).
• Installez toutes les autres dépendances: opam install --deps-only --with-test .
• Construire à l'aide de Dune: dune build @install @runtest
• Vous pouvez soit installer illuaminé dans OPAM à l'aide dune install , soit utiliser les fichiers dans le répertoire _build/install/default/bin .

Utilisation d'Esy

• Installer ESY
• Exécutez esy dans la racine du référentiel.
• L'illuamin peut désormais être exécuté en utilisant esy x illuaminate

Usage

• Soit créer illuaminer comme ci-dessus, soit télécharger une version prédéfinie:

   > wget https://squiddev.cc/illuaminate/bin/latest/illuaminate-linux-x86_64 # A x86-64 Linux static binary
  > wget https://squiddev.cc/illuaminate/bin/latest/illuaminate-windows-x86_64.exe # A x86-64 Windows binary
  

  Vous devrez peut-être chmod +x le fichier téléchargé pour le rendre exécutable.

• Exécutez illuaminate lint pour peluchez le répertoire actuel, ou illuaminate lint my/sub/directory pour peluchez un fichier ou un dossier spécifique. Vous devriez recevoir un rapport de tous les problèmes détectés.

• Utilisez illuaminate fix (ou illuaminate fix my/sub/directory ) pour tenter de résoudre tout problème détecté. Cette commande modifie le fichier en place, c'est donc une bonne idée de vérifier vos fichiers dans le contrôle de version avant de réparer, et assurez-vous que vous êtes satisfait des modifications apportées.

• Vous pouvez obtenir un contrôle plus fin sur l'illuamin à l'aide de ses fichiers de configuration. illuamiante init-config illuaminate.sexp générera un fichier de configuration de modèle qui peut être ajusté en fonction de vos besoins.