eshlykov / hangman

Console app for the Hangman game

hangman

О проекте

Консольная версию игры «Виселица».

После запуска предлагается угадывать по одной букве, вводя их через консоль. После каждой попытки вы увидите отчет, угадана буква или нет, и если да, угаданную часть слова, после чего можно переходить к следующей букве. Если же вы не отгадали, то нужно попробовать еще раз. Вам дается возможность совершить только 5 ошибок.

Все слова на английском языке и не содержат цифр, дефисов и прочих символов. Вводить в верхнем или нижнем регистре, не имеет значения.

Установка и запуск

Установка

Скачайте репозиторий.

Запуск

Запуск осуществляет с помощью утилиты sbt — Scala Build Tool. Скачать его можно с официального сайта или c помощью менеджера пакетов:

apt/yum/brew/choco install sbt

Можно пропустить этот шаг, если есть IntelliJ IDEA с плагином Scala. Просто импортируйте проект и используйте дефолтную конфигурацию для запуска.

Запуск через консоль осуществляется командой:

sbt run

При этом нужно находиться в директории проекта (hangman).

Зависимости

В проекте использованы:

• плагин sbt-scoverage для вычисления покрытия кода;
• плагин scalastyle для статического анализа кода;
• библиотека scalastyle для модульного тестированио.

Специально качивать ничего не нужно: sbt подтягивает все зависимости самостоятельно (требуется подключение к интернету).

Анализ качества исполнения проекта

Все команды нужно выполнять также в директории проекта (hangman).

Статический анализ кода

Анализ состоит из двух шагов:

• sbt scalastyleGenerateConfig сгенерирует конфигурацию, по которой будет проверяться код. При наличии конфигурации этот шаг необязателен.
• sbt scalastyle выполнит проверку и выведет на экран отчет.

Сделать все за раз: sbt scalastyleGenerateConfig scalastyle.

Модульное тестирование

• sbt test прогонит тесты и выведет на экран отчет.

Покрытие кода

Анализ состоит из трех шагов.

• sbt coverage включает анализ покрытия;
• запуск модульных тестов;
• sbt coverageReport выводит отчет.

Сделать все за раз: sbt coverage test coverageReport.

Лицензия

Проект распространяется под лицензией MIT. См. файл LICENCE для подробной информации.