/ 
App-FileRenameUtils-0.013
River stage one • 1 direct dependent • 1 total dependent
/ App::FileRenameUtils

NAME

App::FileRenameUtils - Utilities related to renaming/moving files

VERSION

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

DESCRIPTION

This distribution provides the following command-line utilities:

1. datestamp
2. move-files-here
3. mv-add-prefix
4. mv-add-prefix-datestamp
5. mv-add-prefix-number
6. mv-files-to-dirs
7. mv-reverse
8. mv-swap
9. mv-to-from
10. rename-add-prefix
11. rename-add-prefix-datestamp
12. rename-add-prefix-number
13. rename-swap
14. rename-to-from

FUNCTIONS

add_filename_suffix

Usage:

$new_name = add_filename_suffix($filename, $suffix);

Examples:

add_filename_suffix("foo.jpg", " (1)"); # -> "foo (1).jpg"
add_filename_suffix("foo", " (1)"); # -> "foo (1)"

find_unique_filename

Usage:

$new_name = find_unique_filename($filename);

Continue adding suffix " (1)", " (2)", and so on to $filename (see "add_filename_suffix") until the new name does not exist on the filesystem. If $filename already does not exist, it will be returned as-is.

HOMEPAGE

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

SOURCE

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

SEE ALSO

rename from File::Rename

perlmv from App::perlmv, and its various scriptlets under App::perlmv::scriptlet::*, e.g. App::perlmv::scriptlet::add_prefix or App::perlmv::scriptlet::according_to_containing_dir.

renwd from App::renwd

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

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, 2020, 2019 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-FileRenameUtils

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.