The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
App-PrettyRes-0.03
River stage one • 1 direct dependent • 1 total dependent
/ pretty-res

NAME

pretty-res - Format enveloped result prettily

VERSION

This document describes version 0.03 of pretty-res (from Perl distribution App-PrettyRes), released on 2016-03-10.

SYNOPSIS

Usage:

% pretty-res [OPTIONS] < INPUT

Examples:

% echo '[200, "OK", [1..5]]' | pretty-res -i perl
.----.
|  1 |
|  2 |
|  3 |
|  4 |
|  5 |
`----'

% echo '[1..5]' | pretty-res -i perl ; # enveloped automatically added
.----.
|  1 |
|  2 |
|  3 |
|  4 |
|  5 |
`----'

% cat celine-dion-album-sales.json
[
  200,
  "OK",
  [
    {
      "lang": "en",
      "sales": 3000000,
      "title": "unison",
      "year": 1990
    },
    {
      "lang": "en",
      "sales": 5300000,
      "title": "celine dion",
      "year": 1992
    },
    {
      "lang": "en",
      "sales": 16600000,
      "title": "the color of my love",
      "year": 1993
    },
    ...
  ]
]

% pretty-res celine-dion-album-sales.json
.--------------------------------------------------------------.
| lang      sales   tags        title                     year |
|                                                              |
| en      3000000               unison                    1990 |
| en      5300000               celine dion               1992 |
| en     16600000               the color of my love      1993 |
| en     30300000               falling into you          1996 |
| en     32100000               let's talk about love     1997 |
| en     12100000   christmas   these are special times   1998 |
| en     10500000               a new day has come        2002 |
| en      5100000               one heart                 2003 |
| en      2600000               miracle                   2004 |
| en      3400000               taking chances            2007 |
| en      1300000               loved me back to life     2013 |
`--------------------------------------------------------------'

DESCRIPTION

This script formats data structure using Perinci::Result::Format. If data structure is not detected as an enveloped result (see Rinci::function for more information about enveloped result), it will add an envelope for you.

You can use this script to reformat ouput from Perinci::CmdLine (although by default Perinci::CmdLine already provides --format to let user format the result) or Riap response.

It accepts input as JSON, or several other alternative formats (see the -i option). It by default outputs the data using the text format (use the -o option to change the format).

EXIT CODES

0 on success.

99 on command-line options error.

OPTIONS

  • --input=STR, -i

    Pick input format. Available formats: json (parsed using JSON), yaml (parsed using YAML::Syck), perl. Default is json.

  • --output=STR, -o

    Pick output format. See Perinci::Result::Format for available formats.

FAQ

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-App-PrettyRes.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-PrettyRes

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.

SEE ALSO

Perinci::Result::Format

pretty

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 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.