NAME

liveman - "живой мануал". Утилита для преобразования lib/**.md-файлов в файлы тестов (t/**.t) и документацию (POD), которая помещается в соответствующий модуль lib/**.pm

VERSION

Version 1.0

SYNOPSIS

liveman [-h] [--man] [-o][-c][-f][-s] [<files> ...]

DESCRIPTION

Проблема современных проектов в том, что документация оторвана от тестирования. Это означает, что примеры в документации могут быть нерабочими, а сама документация — отставать от кода.

Метод одновременного документирования и тестирования решает данную проблему.

Для документирования выбран формат md, как наиболее лёгкий для ввода и широкораспространённый. Секции кода perl, описанные в нём, транслируются в тест. А докуметация транслируется в POD и добавляется в секцию __END__ модуля perl.

Другими словами liveman преобразует lib/**.md-файлы в файлы тестов (t/**.t) и документацию, которая помещается в соответствующий модуль lib/**.pm. И сразу же запускает тесты с покрытием.

Покрытие можно посмотреть в файле cover_db/coverage.html.

Примечание: в .gitignore лучше сразу же поместить cover_db/.

OPTIONS

-h, --help

Показать помощь и выйти.

--man

Распечатать мануал и завершиться.

-o, --open

Открыть в браузере покрытие.

-c, --compile

Только компилировать, тесты не запускаем.

-f, --force

Трансформировать файлы lib/**.md даже если они не изменились.

-p, --prove

Запустить тесты в prove, а не yath.

-o OPTIONS, --options OPTIONS

Передать строку с опциями в yath или prove. Эти опции добавятся к опциям по умолчанию.

Опции по умолчанию у yath:

yath test -j4 --cover

Опции по умолчанию у prove:

prove -Ilib -r t

-а, --append

Добавить разделы функций в *.md из *.pm и завершиться.

LICENSE

⚖ GPLv3

liveman Copyright (C) 2007 Yaroslav O. Kosmina <darviarush@mail.ru> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.

AUTHOR

Yaroslav O. Kosmina <darviarush@mail.ru>