nimalyzer

一般信息

Nimalyzer是NIM编程语言的静态代码分析仪。它允许根据预定义的规则检查NIM源代码。它的设计灵感来自Adacontrol。 Nimalyzer可用于执行某些设计模式或确保代码中是否存在某些语言结构。例如，它可以检查所有过程是否都定义了适当的陈列词。此外，它可以通过代码工具用作高级搜索，例如，以Newvar开头找到所有具有名称的INT类型。它通过包含一组规则，其参数和与程序行为相关的选项的配置文件来控制。

目前，该项目处于beta阶段，添加了大多数功能，但仍应有很多错误。

如果您在github上读取此文件：请不要在此处发送拉请请求。所有这些都将自动关闭。任何代码命题都应转到化石存储库。

重要：如果您在项目代码存储库中读取文件：该文件的此版本与程序的未来版本有关。它可能包含该程序发布版本中不存在的信息。有关此信息，请参阅版本中包含的readme.md文件。

用法

1. 要在项目中使用Nimalyzer，首先必须为其创建一个配置文件。有关配置文件语法和可用规则的​​列表，请参阅该项目的文档，在DOC目录中可用为重组文本。在您的配置文件中，您必须设置至少一个源文件以检查和至少一个规则要使用。

2. 运行带有配置文件路径的Nimanalyzer作为参数。例如： nimalyzer config/nimalyzer.cfg ，然后读取其输出。 ）

如何安装

独立的二进制文件

独立的二进制文件可用于64位版本的FreeBSD，Linux和Windows。它们可在下载页面上找到。只需下载并将其提取到选定的目录即可。

从源头建造

您将需要：

• NIM编译器及其源代码。如果您从网站或通过Choposenim安装了编译器，则应该已经安装了编译器。否则，您可能需要使用Nimble Install Compiler@[YourCompilerVersion]或使用软件包管理器手动安装它。
• 合同包
• colored_logger软件包

您可以手动或使用灵活安装它们。在第二个选项中，键入nimble install nimalyzer以安装程序和所有依赖项。通常，建议使用nimble release在发行版（优化）模式或nimble debug中构建项目以在调试模式下构建它。

构建项目的文档

为了创建项目文档的HTML版本，在主要项目目录中运行命令nimble docs 。

如果您想更新项目的文档（通常不需要），则必须使用项目中包含的Gendoc工具。

1. 构建工具gendoc 。在主项目的目录中，执行命令nimble tools 。它将创建所需的工具并将其放入bin目录。

2. 在MAN项目的目录中执行命令bin/gendoc 。它将从默认配置文件和项目的源代码更新项目文档。

执照

该项目根据BSD许可发布了3条规定。

---

就像往常一样，我可能已经忘记了重要的事情；）

Bartek Thindil Jasicki