Nimalyzer es un analizador de código estático para el lenguaje de programación NIM. Permite verificar un código fuente NIM contra reglas predefinidas. Su diseño está inspirado en Adacontrol. Nimalyzer se puede utilizar para hacer cumplir algunos patrones de diseño o garantizar que algunas construcciones de lenguaje estén presentes en un código, o no. Por ejemplo, puede verificar si todos los procedimientos han definido los pragmas adecuados. Además, se puede utilizar como una búsqueda avanzada a través de una herramienta de código, por ejemplo, encuentre todas las variables públicas tipo de int con el nombre que comienza con NewVar . Se controla mediante archivos de configuración que contienen un conjunto de reglas, sus parámetros y opciones relacionadas con el comportamiento del programa.
En este momento, el proyecto está en la etapa beta , se agregan la mayoría de sus características, pero aún debería tener una buena cantidad de errores.
Si lee este archivo en GitHub: no envíe solicitudes de extracción aquí . Todo se cerrará automáticamente. Cualquier propuesta de código debe ir al repositorio fósil.
IMPORTANTE: Si lee el archivo en el repositorio de código de proyecto: esta versión del archivo está relacionada con la versión futura del programa. Puede contener información no presente en las versiones publicadas del programa. Para obtener esa información, consulte el archivo ReadMe.md incluido en la versión.
Para usar Nimalyzer con su proyecto, primero debe crear un archivo de configuración para él. Para la sintaxis del archivo de configuración y la lista de reglas disponibles, consulte la documentación del proyecto, disponible como reestructuredText en el directorio DOC. En su archivo de configuración, deberá configurar al menos un archivo de origen para verificar y al menos una regla para usar.
Ejecute nimanalyzer con ruta a su archivo de configuración como argumento. Por ejemplo: nimalyzer config/nimalyzer.cfg y solo lee su salida. ;)
Los binarios independientes están disponibles para FreeBSD, Linux y Windows en versiones de 64 bits. Están disponibles en la página de descarga. Simplemente descargue y extraiga al directorio seleccionado.
Necesitarás:
Puede instalarlos manualmente o usando Nimble. En esa segunda opción, escriba nimble install nimalyzer para instalar el programa y todas las dependencias. En general, se recomienda utilizar nimble release para construir el proyecto en modo de lanzamiento (optimizado) o nimble debug para construirlo en el modo de depuración.
Para crear la versión HTML de la documentación del proyecto, ejecute el comando nimble docs en el directorio principal del proyecto.
Si desea actualizar la documentación del proyecto, generalmente no necesaria, debe usar la herramienta GENDOC incluida en el proyecto.
Construya la herramienta GENDOC . En el directorio del proyecto principal, ejecute nimble tools de comando. Creará las herramientas necesarias y las pondrá en el directorio bin .
En el directorio del proyecto del hombre, ejecute comando bin/gendoc . Actualizará la documentación del proyecto desde el archivo de configuración predeterminado y del código fuente del proyecto.
El proyecto publicado bajo la licencia BSD de 3 cláusula.
Eso es todo por ahora, como siempre, probablemente me haya olvidado de algo importante;)
Bartek Thindil Jasicki