illuaminate

Illuaminate

Análise de código -fonte para Lua

Illuaminate é uma série de ferramentas para trabalhar com o código -fonte da Lua, fornecendo maneiras de tornar sua base de código mais clara e fácil de entender. Atualmente, é um pouco nu e ainda em um palco do POC, mas espero que se expanda e se torne mais útil à medida que continua a se desenvolver.

Características

• Muitos recursos básicos de análise estática (detecção de código morto, variáveis ​​não utilizadas, etc ...), bem como vários linheiros de formatação (espaço em branco, parênteses redundantes, etc ...).
• Fixador de código automático para muitos dos problemas detectados.
• Geração de documentação, usando sintaxe LDOC.

Prédio

Nota: Use o Packer executável da UPX para tornar os arquivos compilados um tamanho razoável (ele os reduz por 4x). Deve ser incluído na maioria dos gerentes de pacotes.

Usando Opam

• Instale o opam e configure um switch OCAML> = 4.08.1 (por exemplo, opam switch create 4.11.1 ).
• Instale todas as outras dependências: opam install --deps-only --with-test .
• Construa usando Dune: dune build @install @runtest
• Você pode instalar o Illuaminate no Opam usando dune install ou usar os arquivos no diretório _build/install/default/bin .

Usando ESY

• Instale ESY
• Execute esy na raiz do repositório.
• Illuaminate agora pode ser executado usando esy x illuaminate

Uso

• Construa illuaminate como acima ou faça o download de uma versão pré-criada:

   > 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
  

  Pode ser necessário chmod +x o arquivo baixado para torná -lo executável.

• Execute illuaminate lint para falhar o diretório atual ou illuaminate lint my/sub/directory para falhar um arquivo ou pasta específica. Você deve receber um relatório de todos os problemas detectados.

• Use illuaminate fix (ou illuaminate fix my/sub/directory ) para tentar corrigir quaisquer problemas detectados. Este comando modifica o arquivo no lugar, por isso é uma boa ideia verificar seus arquivos no controle da versão antes de corrigir e verifique se você está feliz com as alterações feitas.

• Você pode obter mais controle de granulação fina sobre o Illuaminate usando seus arquivos de configuração. illuamiante init-config illuaminate.sexp gerará um arquivo de configuração de modelo que pode ser ajustado para atender às suas necessidades.