NAME
"Liveman - “Living Guide”. Utility for converting files lib/**.md in test files (t/**.t) and documentation (POD), which is placed in the corresponding module (lib/**.pm)
SYNOPSIS
liveman [-h] [--man] [-A pkg [license]] [-w] [-o][-c][-f][-s][-a] [<files> ...]DESCRIPTION
The problem of modern projects is that the documentation is separated from testing. This means that the examples in the documentation may not work, and the documentation itself can lag behind the code.
The method of simultaneous documentation and testing solves this problem.
For the documentation, the md format was selected, since it is the most simple for input and widespread. The areas of code perl described in it are broadcast into a test. The documentation is translated into pod and is added to the __END__ section of the perl module.
In other words, liveman converts lib/**.md-files to test files (t/**.t) and documentation that is placed in the corresponding lib/**.pm module. And immediately launches the tests with coating.
The coating can be viewed in the *cover_db/coverage.html file.
Note: It is better to immediately put cover_db/ in .gitignore.
OPTIONS
-h, --help
Show a certificate and get out.
-v, --version
Show the version and go out.
`perl $ENV{PROJECT_DIR}/script/liveman -v` # ~> ^\d+\.\d+$--man
Print instructions and end.
-c, --compile
Only compile (without starting the tests).
-f, --force
Convert the lib/**.md files, even if they have not changed.
-p, --prove
Use the prove utility for tests, not yath.
-o, --open
Open the coating in the browser.
-O, --options OPTIONS
Transfer the line with the options yath or prove. These parameters will be added to the default parameters.
Default parameters for yath:
C<yath test -j4 --cover>Default parameters for prove:
C<prove -Ilib -r t>-a, --append
Add functions in *.md from*.pm and end.
-A, --new PACKAGE [LICENSE]
Create a new repository.
PACKAGE - this is the name of the new package, for example,
Aion::View.License is a license name, for example, GPLv3 or perl_5.
-D, --cpanfile
Print a sample cpanfile.
-d, --diff-cpanfile [meld]
Compare the sample cpanfile with the existing one. If the parameter is not specified, meld is used. Alternatively, you can use diff, colordiff, wdiff, kompare, kdiff3, tkdiff, diffuse or any other utility that takes two files as arguments.
INSTALL
To install this module in your system, follow the following App::cpm
sudo cpm install -gvv LivemanAUTHOR
Yaroslav O. Kosmina mailto:dart@cpan.org
LICENSE
⚖ GPLv3
COPYRIGHT
The App::Liveman module is Copyright © 2024 Yaroslav O. Kosmina. Rusland. All Rights Reserved.