—

              
#!perl
use 5.010;
use strict;
use warnings;
use Perinci::CmdLine::Any;
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2023-11-20'; # DATE
our $DIST = 'App-perlmv-u'; # DIST
our $VERSION = '0.007'; # VERSION
my $cmd = Perinci::CmdLine::Any->new(
    url => '/App/perlmv/u/',
    subcommands => {
        mv            => {url => '/App/perlmv/u/perlmv'},
        undo          => {url => '/App/perlmv/u/undo'},
        redo          => {url => '/App/perlmv/u/redo'},
        history       => {url => '/App/perlmv/u/history'},
        clear_history => {url => '/App/perlmv/u/clear_history'},
    },
    default_subcommand => 'mv',
    log => 1,
);
$cmd->common_opts->{undo} = {
    summary => 'Shortcut for --cmd=undo',
    getopt => 'undo',
    handler => sub {
        my ($go, $val, $r) = @_;
        $r->{subcommand_name} = 'undo';
        $r->{subcommand_name_from} = '--cmd'; # XXX not exactly accurate
        $r->{skip_parse_subcommand_argv} = 1;
    },
};
$cmd->common_opts->{redo} = {
    summary => 'Shortcut for --cmd=redo',
    getopt => 'redo',
    handler => sub {
        my ($go, $val, $r) = @_;
        $r->{subcommand_name} = 'redo';
        $r->{subcommand_name_from} = '--cmd'; # XXX not exactly accurate
        $r->{skip_parse_subcommand_argv} = 1;
    },
};
$cmd->common_opts->{history} = {
    summary => 'Shortcut for --cmd=history',
    getopt => 'history',
    handler => sub {
        my ($go, $val, $r) = @_;
        $r->{subcommand_name} = 'history';
        $r->{subcommand_name_from} = '--cmd'; # XXX not exactly accurate
        $r->{skip_parse_subcommand_argv} = 1;
    },
};
$cmd->common_opts->{clear_history} = {
    summary => 'Shortcut for --cmd=clear_history',
    getopt => 'clear-history',
    handler => sub {
        my ($go, $val, $r) = @_;
        $r->{subcommand_name} = 'clear_history';
        $r->{subcommand_name_from} = '--cmd'; # XXX not exactly accurate
        $r->{skip_parse_subcommand_argv} = 1;
    },
};
$cmd->run;
1;
# ABSTRACT: Rename files using Perl code, with undo/redo
# PODNAME: perlmv-u
__END__
HideShow 445 lines of Pod
=pod
=encoding UTF-8
=head1 NAME
perlmv-u - Rename files using Perl code, with undo/redo
=head1 VERSION
This document describes version 0.007 of perlmv-u (from Perl distribution App-perlmv-u), released on 2023-11-20.
=head1 SYNOPSIS
 # rename some files, but in simulation mode, not really rename the files
 % perlmv-u --dry-run -e '/(\d+)/; sprintf "file%03d.txt", $1' file*txt
 % perlmv-u -n        -e '/(\d+)/; sprintf "file%03d.txt", $1' file*txt
 # rename some files, for real
 % perlmv-u           -e '/(\d+)/; sprintf "file%03d.txt", $1' file*txt
 # oops, made a mistake. undo last action.
 % perlmv-u --undo
 # redo last action
 % permv-u --redo
 # show history
 % perlmv-u --history
 # forget history; past actions can no longer be undone/redone
 % perlmv-u --clear-history
=head1 DESCRIPTION
B<EARLY RELEASE, EXPERIMENTAL.>
This utility is a reimplementation of L<perlmv> with undo feature. Currently
unimplemented: scriptlets, mv/cp/symlink/link mode, test compile (-c),
--parents, etc.
=head1 SUBCOMMANDS
=head2 B<clear_history>
Clear undo history.
=head2 B<history>
Show undo history.
=head2 B<mv>
Rename files using Perl code, with undo/redo.
=head2 B<redo>
Redo last undone action.
=head2 B<undo>
Undo last action.
=head1 OPTIONS
C<*> marks required options.
=head2 Common options
=over
=item B<--clear-history>
Shortcut for --cmd=clear_history.
=item B<--cmd>=I<s>
Select subcommand.
This is useful if a default subcommand exists, where that subcommand will be
chosen if user does not specify another explicitly.
=item B<--config-path>=I<s>, B<-c>
Set path to configuration file.
Can actually be specified multiple times to instruct application to read from
multiple configuration files (and merge them).
=item B<--config-profile>=I<s>, B<-P>
Set configuration profile to use.
A single configuration file can contain profiles, i.e. alternative sets of
values that can be selected. For example:
 [profile=dev]
 username=foo
 pass=beaver
  
 [profile=production]
 username=bar
 pass=honey
When you specify C<--config-profile=dev>, C<username> will be set to C<foo> and
C<password> to C<beaver>. When you specify C<--config-profile=production>,
C<username> will be set to C<bar> and C<password> to C<honey>.
=item B<--debug>
Shortcut for --log-level=debug.
=item B<--dry-run>, B<-n>
Run in simulation mode (also via DRY_RUN=1).
=item B<--format>=I<s>
Choose output format, e.g. json, text.
Default value:
 undef
Output can be displayed in multiple formats, and a suitable default format is
chosen depending on the application and/or whether output destination is
interactive terminal (i.e. whether output is piped). This option specifically
chooses an output format.
=item B<--help>, B<-h>, B<-?>
Display help message and exit.
=item B<--history>
Shortcut for --cmd=history.
=item B<--json>
Set output format to json.
=item B<--log-level>=I<s>
Set log level.
By default, these log levels are available (in order of increasing level of
importance, from least important to most): C<trace>, C<debug>, C<info>,
C<warn>/C<warning>, C<error>, C<fatal>. By default, the level is usually set to
C<warn>, which means that log statements with level C<info> and less important
levels will not be shown. To increase verbosity, choose C<info>, C<debug>, or
C<trace>.
For more details on log level and logging, as well as how new logging levels can
be defined or existing ones modified, see L<Log::ger>.
=item B<--naked-res>
When outputing as JSON, strip result envelope.
Default value:
 0
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
 [200,"OK",[1,2,3],{"func.extra"=>4}]
The reason is so you can get the status (1st element), status message (2nd
element) as well as result metadata/extra result (4th element) instead of just
the result (3rd element). However, sometimes you want just the result, e.g. when
you want to pipe the result for more post-processing. In this case you can use
C<--naked-res> so you just get:
 [1,2,3]
=item B<--no-config>, B<-C>
Do not use any configuration file.
If you specify C<--no-config>, the application will not read any configuration
file.
=item B<--no-env>
Do not read environment for default options.
If you specify C<--no-env>, the application wil not read any environment
variable.
=item B<--page-result>
Filter output through a pager.
This option will pipe the output to a specified pager program. If pager program
is not specified, a suitable default e.g. C<less> is chosen.
=item B<--quiet>
Shortcut for --log-level=error.
=item B<--redo>
Shortcut for --cmd=redo.
=item B<--subcommands>
List available subcommands.
=item B<--trace>
Shortcut for --log-level=trace.
=item B<--undo>
Shortcut for --cmd=undo.
=item B<--verbose>
Shortcut for --log-level=info.
=item B<--version>, B<-v>
Display program's version and exit.
=item B<--view-result>
View output using a viewer.
This option will first save the output to a temporary file, then open a viewer
program to view the temporary file. If a viewer program is not chosen, a
suitable default, e.g. the browser, is chosen.
=back
=head2 Options for subcommand mv
=over
=item B<--eval>=I<s>*, B<-e>
Perl code to rename file.
Your Perl code will receive the original filename in C<$_> and is expected to
modify it. If it is unmodified, the last expression is used as the new filename.
If it is also the same as the original filename, the file is not renamed.
=item B<--file>=I<s@>*
(No description)
Can also be specified as the 1st command-line argument and onwards.
Can be specified multiple times.
=item B<--files-json>=I<s>
See C<--file>.
Can also be specified as the 1st command-line argument and onwards.
=item B<-d>
Alias for --dry-run.
=back
=head2 Options for subcommand undo
=over
=item B<--ignore-errors>
(No description)
=back
=head1 COMPLETION
This script has shell tab completion capability with support for several
shells.
=head2 bash
To activate bash completion for this script, put:
 complete -C perlmv-u perlmv-u
in your bash startup (e.g. F<~/.bashrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.
It is recommended, however, that you install modules using L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.
=head2 tcsh
To activate tcsh completion for this script, put:
 complete perlmv-u 'p/*/`perlmv-u`/'
in your tcsh startup (e.g. F<~/.tcshrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.
It is also recommended to install L<shcompgen> (see above).
=head2 other shells
For fish and zsh, install L<shcompgen> as described above.
=head1 CONFIGURATION FILE
This script can read configuration files. Configuration files are in the format of L<IOD>, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using C<--config-path>): F</home/u1/.config/perlmv-u.conf>, F</home/u1/perlmv-u.conf>, or F</etc/perlmv-u.conf>.
All found files will be read and merged.
To disable searching for configuration files, pass C<--no-config>.
To put configuration for a certain subcommand only, use a section name like C<[subcommand=NAME]> or C<[SOMESECTION subcommand=NAME]>.
You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]> or C<[subcommand=SUBCOMMAND_NAME profile=SOMENAME]> or C<[SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]>. Those sections will only be read if you specify the matching C<--config-profile SOMENAME>.
You can also put configuration for multiple programs inside a single file, and use filter C<program=NAME> in section names, e.g. C<[program=NAME ...]> or C<[SOMESECTION program=NAME]>. The section will then only be used when the reading program matches.
You can also filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...]>. If you only want a section to be read when the value of an environment variable equals some string: C<[env=HOSTNAME=blink ...]> or C<[SOMESECTION env=HOSTNAME=blink ...]>. If you only want a section to be read when the value of an environment variable does not equal some string: C<[env=HOSTNAME!=blink ...]> or C<[SOMESECTION env=HOSTNAME!=blink ...]>. If you only want a section to be read when the value of an environment variable includes some string: C<[env=HOSTNAME*=server ...]> or C<[SOMESECTION env=HOSTNAME*=server ...]>. If you only want a section to be read when the value of an environment variable does not include some string: C<[env=HOSTNAME!*=server ...]> or C<[SOMESECTION env=HOSTNAME!*=server ...]>. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.
To load and configure plugins, you can use either the C<-plugins> parameter (e.g. C<< -plugins=DumpArgs >> or C<< -plugins=DumpArgs@before_validate_args >>), or use the C<[plugin=NAME ...]> sections, for example:
 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
  
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2
  
which is equivalent to setting C<< -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2 >>.
List of available configuration parameters:
=head2 Common for all subcommands
=head2 Configuration for subcommand clear_history
=head2 Configuration for subcommand history
=head2 Configuration for subcommand mv
 d (see -d)
 eval (see --eval)
 files (see --file)
=head2 Configuration for subcommand redo
=head2 Configuration for subcommand undo
 ignore_errors (see --ignore-errors)
=head1 ENVIRONMENT
=head2 PERLMV_U_OPT
String. Specify additional command-line options.
=head1 FILES
=head2 /home/u1/.config/perlmv-u.conf
=head2 /home/u1/perlmv-u.conf
=head2 /etc/perlmv-u.conf
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-perlmv-u>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-App-perlmv-u>.
=head1 SEE ALSO
L<perlmv> from L<App::perlmv>
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 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 L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,
L<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.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2023, 2021, 2017 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.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-perlmv-u>
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.
=cut