nimalyzer

Общая информация

Nimalyzer является статическим анализатором кода для языка программирования NIM. Это позволяет проверять исходный код NIM против предопределенных правил. Его дизайн вдохновлен Adacontrol. Nimalyzer может использоваться для обеспечения соблюдения некоторых шаблонов проектирования или обеспечения того, чтобы некоторые языковые конструкции присутствовали в коде или нет. Например, он может проверить, определяют ли все процедуры надлежащие прагмы. Кроме того, его можно использовать в качестве расширенного поиска через инструмент кода, например, найти все публичные переменные типа Int с именем, которое начинается с Newvar . Он управляется файлами конфигурации, содержащими набор правил, их параметры и параметры, связанные с поведением программы.

В этот момент проект находится на бета -стадии, большая часть его функций добавлена, но он все еще должен иметь хорошее количество ошибок.

Если вы прочитали этот файл на GitHub: не отправляйте здесь запросы на привлечение . Все будет автоматически закрыто. Любые кодовые предложения должны перейти в ископаемое хранилище.

Важно: если вы читаете файл в хранилище кода проекта: эта версия файла связана с будущей версией программы. Он может содержать информацию, отсутствующую в выпущенных версиях программы. Для этой информации, пожалуйста, обратитесь к файлу readme.md, включенному в релиз.

Использование

1. Чтобы использовать Nimalyzer с вашим проектом, сначала вам нужно создать для него файл конфигурации. Для синтаксиса файла конфигурации и списка доступных правил, пожалуйста, обратитесь к документации проекта, доступной в качестве реструктурированного текста в Doc Directory. В вашем файле конфигурации вам придется установить хотя бы один исходный файл для проверки и хотя бы одно правило для использования.

2. Запустите Nimanalyzer с Path to Your Configuration File в качестве аргумента. Например: nimalyzer config/nimalyzer.cfg и просто прочитайте его вывод. ;)

Как установить

Автономные двоичные файлы

Автономные двоичные файлы доступны для FreeBSD, Linux и Windows в 64-битных версиях. Они доступны на странице загрузки. Просто загрузите и извлеките их в выбранную каталог.

Построить из источника

Вам понадобится:

• NIM Компилятор и его исходный код. Если вы установили компилятор с веб -сайта или через выпивший , вы должны были его установить. В противном случае, вам может потребоваться установить его вручную с помощью ловкого установки Compiler@[yourcompilerversion] или с вашим менеджером пакетов.
• Пакет контрактов
• Colored_logger Package

Вы можете установить их вручную или с помощью ловкости. Во втором варианте введите nimble install nimalyzer для установки программы и всех зависимостей. Как правило, рекомендуется использовать nimble release для создания проекта в режиме выпуска (оптимизированный) или nimble debug для его создания в режиме отладки.

Создать документацию проекта

Чтобы создать HTML -версию команды Documentation Run Project, nimble docs в основном каталоге проекта.

Если вы хотите обновить документацию проекта, обычно не требуется, вы должны использовать Gendoc Tool, включенный в проект.

1. Создайте инструмент Gendoc . В каталоге главного проекта выполните командные nimble tools . Это создаст необходимые инструменты и поместит их в каталог бин .

2. В каталоге «Исполнить командный bin/gendoc . Он обновит документацию проекта из файла конфигурации по умолчанию и исходного кода проекта.

Лицензия

Проект опубликовал по 3-й лицензии BSD.

---

На данный момент, как обычно, я, вероятно, забыл о чем -то важном;)

Бартек Тиндил Джасицки