/ 
App-FileRemoveUtils-0.007
River stage one • 2 direct dependents • 3 total dependents
/ App::FileRemoveUtils

NAME

App::FileRemoveUtils - Utilities related to removing/deleting files

VERSION

This document describes version 0.007 of App::FileRemoveUtils (from Perl distribution App-FileRemoveUtils), released on 2023-11-20.

DESCRIPTION

This distribution provides the following command-line utilities:

FUNCTIONS

delete_all_empty_dirs

Usage:

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

Delete all empty (zero-sized) subdirectories recursively.

This function is not exported by default, but exportable.

This function supports dry-run operation.

No arguments.

Special arguments:

  • -dry_run => bool

    Pass -dry_run=>1 to enable simulation mode.

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

delete_all_empty_files

Usage:

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

Delete all empty (zero-sized) files recursively.

This function is not exported by default, but exportable.

This function supports dry-run operation.

No arguments.

Special arguments:

  • -dry_run => bool

    Pass -dry_run=>1 to enable simulation mode.

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

list_all_empty_dirs

Usage:

list_all_empty_dirs($include_would_be_empty) -> any

List all sempty (zero-entry) subdirectories in the current directory tree.

This function is not exported.

Arguments ('*' denotes required arguments):

  • $include_would_be_empty => bool (default: 1)

    Include directories that would be empty if their empty subdirectories are removed.

Return value: (any)

list_all_empty_files

Usage:

list_all_empty_files() -> any

List all empty (zero-sized) files in the current directory tree.

This function is not exported.

No arguments.

Return value: (any)

HOMEPAGE

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

SOURCE

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

SEE ALSO

rmhere from App::rmhere

Other similar distributions: App::FileModifyUtils, App::FileRenameUtilities.

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) 2023 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=App-FileRemoveUtils

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.