/ 
Perinci-CmdLine-Util-0.15
River stage two • 5 direct dependents • 25 total dependents
/ Perinci::CmdLine::Util

NAME

Perinci::CmdLine::Util - Utility routines related to Perinci::CmdLine

VERSION

This document describes version 0.15 of Perinci::CmdLine::Util (from Perl distribution Perinci-CmdLine-Util), released on 2017-01-12.

SYNOPSIS

DESCRIPTION

FUNCTIONS

detect_pericmd_script(%args) -> [status, msg, result, meta]

Detect whether a file is a Perinci::CmdLine-based CLI script.

The criteria are:

  • the file must exist and readable;

  • (optional, if include_noexec is false) file must have its executable mode bit set;

  • content must start with a shebang #!;

  • either: must be perl script (shebang line contains 'perl') and must contain something like use Perinci::CmdLine;

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

  • filename => str

    Path to file to be checked.

    Either filename or string must be specified.

  • include_noexec => bool (default: 1)

    Include scripts that do not have +x mode bit set.

  • string => buf

    Path to file to be checked.

    Either file or string must be specified.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Perinci-CmdLine-Util.

SOURCE

Source repository is at https://github.com/perlancar/perl-Perinci-CmdLine-Util.

BUGS

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

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::CmdLine

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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