illuaminate

Иллюминация

Анализ исходного кода для LUA

Illuaminate - это серия инструментов для работы с исходным кодом LUA, предоставляя способы сделать вашу кодовую базу более четкой и проще для понимания. В настоящее время это довольно голые кости, и все еще на стадии POC, но, надеюсь, расширится и станет более полезным, поскольку он продолжает развиваться.

Функции

• Многие базовые функции статического анализа (обнаружение мертвого кода, неиспользованные переменные и т. Д.), А также несколько форматирования линтеров (пробелы, избыточная скобка и т. Д.).
• Автоматический фиксатор кода для многих обнаруженных проблем.
• Генерация документации, используя синтаксис LDOC.

Здание

ПРИМЕЧАНИЕ. Используйте исполняемый пакет UPX, чтобы сделать скомпилированные файлы разумным размером (он уменьшает их на 4x). Это должно быть включено в большинство менеджеров пакетов.

Используя Opam

• Установите OPAM и настройте переключатель OCAML> = 4.08.1 (например, opam switch create 4.11.1 ).
• Установите все другие зависимости: opam install --deps-only --with-test .
• Стройте с помощью Dune: dune build @install @runtest
• Вы можете либо установить Illuaminate в Opam, используя dune install , либо использовать файлы в каталоге _build/install/default/bin .

Использование ESY

• Установите ESY
• Запустите esy в корне репозитория.
• Иллюаминат теперь можно запускать с помощью esy x 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 ), чтобы попытаться решить любые обнаруженные проблемы. Эта команда изменяет файл на месте, поэтому рекомендуется проверить ваши файлы в управление версиями перед исправлением, и убедиться, что вы довольны внесенными изменениями.

• Вы можете получить более мелкозернистый контроль над иллюстрацией, используя его файлы конфигурации. illuamiante init-config illuaminate.sexp будет генерировать файл конфигурации шаблона, который можно скорректировать в соответствии с вашими потребностями.