illuaminate

Iluminar

Análisis del código fuente para LUA

Illuaminate es una serie de herramientas para trabajar con el código fuente de Lua, que proporciona formas de hacer que su base de código sea más clara y fácil de entender. Actualmente es bastante básico, y aún así en una etapa de POC, pero con suerte se expandirá y se volverá más útil a medida que continúa desarrollándose.

Características

• Muchas características básicas de análisis estático (detección de códigos muertos, variables no utilizadas, etc.), así como varias revestimientos de formato (espacio en blanco, paréntesis redundante, etc.).
• Correctador de código automático para muchos de los problemas detectados.
• Generación de documentación, utilizando la sintaxis LDOC.

Edificio

Nota: Use el Packer ejecutable de UPX para que los archivos compilados sean un tamaño razonable (los reduce por 4x). Debe incluirse en la mayoría de los gerentes de paquetes.

Usando Opam

• Instale OPAM y configure un interruptor OCAML> = 4.08.1 (por ejemplo, opam switch create 4.11.1 ).
• Instale todas las demás dependencias: opam install --deps-only --with-test .
• Construir usando dune: dune build @install @runtest
• Puede instalar Illuaminate en OPAM usando dune install o usar los archivos en el directorio _build/install/default/bin .

Usando ESY

• Instalar ESY
• Ejecute esy en la raíz del repositorio.
• Illuaminate ahora se puede ejecutar usando esy x illuaminate

Uso

• Ya sea construir iluaminate como se indicó anteriormente, o descargue una versión preconstruida:

   > 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
  

  Es posible que necesite chmod +x el archivo descargado para que sea ejecutable.

• Ejecute illuaminate lint para vincular el directorio actual, o illuaminate lint my/sub/directory a la pelusa o una carpeta específica. Debe recibir un informe de todos los problemas detectados.

• Use illuaminate fix (o illuaminate fix my/sub/directory ) para intentar solucionar cualquier problema detectado. Este comando modifica el archivo en su lugar, por lo que es una buena idea verificar sus archivos en el control de versiones antes de arreglar, y asegúrese de que esté satisfecho con los cambios realizados.

• Puede obtener más control de grano fino sobre Illuaminate utilizando sus archivos de configuración. illuamiante init-config illuaminate.sexp generará un archivo de configuración de plantilla que se puede ajustar para satisfacer sus necesidades.