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将生成一个模板配置文件，该文件可以调整以适合您的需求。