/ 
Data-Sah-0.916
River stage three • 431 direct dependents • 689 total dependents
/ Data::Sah::Compiler::human

NAME

Data::Sah::Compiler::human - Compile Sah schema to human language

VERSION

This document describes version 0.916 of Data::Sah::Compiler::human (from Perl distribution Data-Sah), released on 2024-02-16.

SYNOPSIS

DESCRIPTION

This class is derived from Data::Sah::Compiler. It generates human language text.

ATTRIBUTES

METHODS

new() => OBJ

$c->compile(%args) => RESULT

Aside from base class' arguments, this class supports these arguments (suffix * denotes required argument):

  • format => STR (default: 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.

    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

  • hash_values => hash

    Optional, supply more keys to hash value to sprintfn which will be used during compilation.

Compilation data

This subclass adds the following compilation data ($cd).

Keys which contain compilation state:

Keys which contain compilation result:

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Data-Sah.

SOURCE

Source repository is at https://github.com/perlancar/perl-Data-Sah.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2024, 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012 by perlancar <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.

BUGS

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.