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