Data::Sah::Compiler::human - Compile Sah schema to human language
This document describes version 0.47 of Data::Sah::Compiler::human (from Perl distribution Data-Sah), released on 2015-03-24.
This class is derived from Data::Sah::Compiler. It generates human language text.
Aside from base class' arguments, this class supports these arguments (suffix * denotes required argument):
*
format => STR (default: inline_text)
inline_text
Format of text to generate. Either inline_text, inline_err_text, or markdown. Note that you can easily convert Markdown to HTML, there are libraries in Perl, JavaScript, etc to do that.
inline_err_text
markdown
Sample inline_text output:
integer, must satisfy all of the following: (divisible by 3, at least 10)
inline_err_text is just like inline_text, except geared towards producing an error message. Currently, instead of producing "integer" from schema "int", it produces "Not of type integer". The rest is identical.
Sample markdown output:
integer, must satisfy all of the following: * divisible by 3 * at least 10
This subclass adds the following compilation data ($cd).
$cd
Keys which contain compilation state:
Keys which contain compilation result:
Please visit the project's homepage at https://metacpan.org/release/Data-Sah.
Source repository is at https://github.com/perlancar/perl-Data-Sah.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Data-Sah
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2015 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Data::Sah, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Data::Sah
CPAN shell
perl -MCPAN -e shell install Data::Sah
For more information on module installation, please visit the detailed CPAN module installation guide.