illuaminate

不理

LUA的源代碼分析

Illuaminate是一系列用於使用LUA源代碼的工具，提供了使您的代碼庫更清晰，更易於理解的方法。目前，它仍然是裸露的骨頭，並且仍處於POC階段，但希望隨著它的發展而擴大並變得更有用。

特徵

• 許多基本的靜態分析特徵（死亡代碼檢測，未使用的變量等）以及幾個格式的林格（whitespace，冗餘括號等）。
• 許多檢測到的問題的自動代碼修復程序。
• 使用LDOC語法生成文檔。

建築

注意：使用UPX可執行的包裝器，以使編譯的文件成為合理的大小（將其減少4倍）。它應該包含在大多數包裝管理人員中。

使用OPAM

• 安裝OPAM並設置OCAML> = 4.08.1開關（例如opam switch create 4.11.1 ）。
• 安裝所有其他依賴項： opam install --deps-only --with-test .
• 使用沙丘建造： dune build @install @runtest
• 您可以使用dune install安裝在OPAM中，或者在_build/install/default/bin目錄中使用文件。

使用esy

• 安裝esy
• 在存儲庫的根中運行esy 。
• 現在可以使用esy x illuaminate運行Illuaminate

用法

• 如上所述構建iLluaminate，或下載預製版本：

   > 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
  

  您可能需要chmod +x下載的文件以使其可執行。

• 運行illuaminate lint以填充當前目錄，或illuaminate lint my/sub/directory到特定文件或文件夾。您應該收到有關檢測到的所有問題的報告。

• 使用illuaminate fix （或illuaminate fix my/sub/directory ）嘗試解決任何檢測到的問題。此命令將文件修改到位，因此在修復之前將文件檢查到版本控件中是一個好主意，並確保對所做的更改感到滿意。

• 您可以使用其配置文件獲得對Illuaminate的更細粒度的控制。 illuamiante init-config illuaminate.sexp將生成一個模板配置文件，該文件可以調整以適合您的需求。