illuaminate

Illuaminat

Quellcodeanalyse für LUA

Illuaminat ist eine Reihe von Tools zum Arbeiten mit dem Lua -Quellcode, um Ihre Codebasis klarer und einfacher zu verstehen. Es sind derzeit ziemlich nackte Knochen und immer noch auf einer POC -Bühne, wird aber hoffentlich erweitert und nützlicher, wenn es sich weiterentwickelt.

Merkmale

• Viele grundlegende statische Analysefunktionen (Dead Code -Erkennung, nicht verwendete Variablen usw.) sowie mehrere Formatierungslinter (Whitespace, redundante Klammern usw.).
• Automatischer Codefixer für viele der erkannten Probleme.
• Dokumentationsgenerierung unter Verwendung der LDOC -Syntax.

Gebäude

HINWEIS: Verwenden Sie den upx ausführbaren Packer, um die kompilierten Dateien zu einer angemessenen Größe zu machen (es reduziert sie um 4x). Es sollte in den meisten Paketmanagern enthalten sein.

Mit opam

• Installieren Sie OPAM und richten Sie einen OCAML> = 4.08.1 Switch ein (z. B. opam switch create 4.11.1 ).
• Installieren Sie alle anderen Abhängigkeiten: opam install --deps-only --with-test .
• Erstellen Sie mit Dune: dune build @install @runtest
• Sie können Illuaminat entweder mit dune install in OPAM installieren oder die Dateien im Verzeichnis _build/install/default/bin verwenden.

Mit Esy

• Esy installieren
• Führen Sie esy in der Stammin des Repositorys aus.
• Illuaminat kann jetzt mit esy x illuaminate ausgeführt werden

Verwendung

• Erstellen Sie entweder illuaminate wie oben oder laden Sie eine vorgefertigte Version herunter:

   > 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
  

  Möglicherweise müssen Sie die heruntergeladene Datei chmod +x benötigen, um sie ausführbar zu machen.

• Führen Sie illuaminate lint aus, um das aktuelle Verzeichnis oder illuaminate lint my/sub/directory für eine bestimmte Datei oder einen bestimmten Ordner auszuführen. Sie sollten einen Bericht über alle erkannten Probleme erhalten.

• Verwenden Sie illuaminate fix (oder illuaminate fix my/sub/directory ), um alle erkannten Probleme zu beheben. Dieser Befehl ändert die vorhandene Datei. Daher ist es eine gute Idee, Ihre Dateien vor dem Beheben in der Versionskontrolle zu überprüfen und sicherzustellen, dass Sie mit den vorgenommenen Änderungen zufrieden sind.

• Mit den Konfigurationsdateien können Sie eine feinkörnige Kontrolle über Illuaminat erhalten. illuamiante init-config illuaminate.sexp generiert eine Vorlagenkonfigurationsdatei, die an Ihre Anforderungen angepasst werden kann.