Академии Бэкенда 2024

Проект представялет собой конвеер :

• user input (file names, URL, etc) => Stream => LogReport => текстовый отчёт в формате .md/.ad

Проект состоит из следующих директорий и файлов:

• pom.xml – дескриптор сборки, используемый maven, или Project Object Model. В нем описаны зависимости проекта и шаги по его сборке
• src/ – директория, которая содержит исходный код приложения и его тесты:
  • src/main/ – здесь находится код вашего приложения
  • src/test/ – здесь находятся тесты вашего приложения
• mvnw и mvnw.cmd – скрипты maven wrapper для Unix и Windows, которые позволяют запускать команды maven без локальной установки
• checkstyle.xml, checkstyle-suppression.xml, pmd.xml и spotbugs-excludes.xml – в проекте используются линтеры для контроля качества кода. Указанные файлы содержат правила для используемых линтеров
• .mvn/ – служебная директория maven, содержащая конфигурационные параметры сборщика
• lombok.config – конфигурационный файл Lombok, библиотеки помогающей избежать рутинного написания шаблонного кода
• .editorconfig – файл с описанием настроек форматирования кода
• .github/workflows/build.yml – файл с описанием шагов сборки проекта в среде Github
• .gitattributes, .gitignore – служебные файлы для git, с описанием того, как обрабатывать различные файлы, и какие из них игнорировать

Для того чтобы собрать проект, и проверить, что все работает корректно, можно запустить из модального окна IDEA Run Anything команду:

mvn clean verify

Запуск тестов:

mvn test

Запуск линтеров:

mvn checkstyle:check modernizer:modernizer spotbugs:check pmd:check pmd:cpd-check