The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

App::AlgorithmDiffUtils - CLI utilities based on Algorithm::Diff

VERSION

This document describes version 0.003 of App::AlgorithmDiffUtils (from Perl distribution App-AlgorithmDiffUtils), released on 2021-05-25.

SYNOPSIS

DESCRIPTION

This distribution includes several utilities:

FUNCTIONS

algodiff_compact_diff

Usage:

 algodiff_compact_diff(%args) -> [$status_code, $reason, $payload, \%result_meta]

Perform compact_diff() on two files.

This function is not exported.

Arguments ('*' denotes required arguments):

  • file1* => filename

  • file2* => filename

Returns an enveloped result (an array).

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

Return value: (any)

algodiff_diff

Usage:

 algodiff_diff(%args) -> [$status_code, $reason, $payload, \%result_meta]

Perform diff() on two files.

This function is not exported.

Arguments ('*' denotes required arguments):

  • file1* => filename

  • file2* => filename

Returns an enveloped result (an array).

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

Return value: (any)

algodiff_hunks

Usage:

 algodiff_hunks(%args) -> [$status_code, $reason, $payload, \%result_meta]

Show hunks information.

This function is not exported.

Arguments ('*' denotes required arguments):

  • file1* => filename

  • file2* => filename

Returns an enveloped result (an array).

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

Return value: (any)

algodiff_lcs

Usage:

 algodiff_lcs(%args) -> [$status_code, $reason, $payload, \%result_meta]

Perform LCS() on two files.

This function is not exported.

Arguments ('*' denotes required arguments):

  • file1* => filename

  • file2* => filename

Returns an enveloped result (an array).

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

Return value: (any)

algodiff_sdiff

Usage:

 algodiff_sdiff(%args) -> [$status_code, $reason, $payload, \%result_meta]

Perform sdiff() on two files.

This function is not exported.

Arguments ('*' denotes required arguments):

  • file1* => filename

  • file2* => filename

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or "OK" if status is 200. Third element ($payload) is optional, the actual result. Fourth element (%result_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/App-AlgorithmDiffUtils.

SOURCE

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

BUGS

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

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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