NAME

renself - REName current (Working) Directory

VERSION

This document describes version 0.008 of renself (from Perl distribution App-renwd), released on 2021-11-16.

SYNOPSIS

This is a script to do the simple:

% mv ../curdirname ../newname

except with one convenience: tab completion. If you activate tab completion for this script (e.g. via complete -C renwd renwd), then you can do:

% renwd <Tab>

and the current directory name is completed for you to edit/modify/

DESCRIPTION

Why would you want to rename the current working directory? I often do this when inside a directory and wanting to mark the directory as "processed" by adding "-DONE" to its name. The name of the directory is often quite long, and sometimes the parent directory contains a lot of subdirectories so you can't rely on just the first 1-2 characters of the directory name to get a unique tab completion. Hence this script.

Pro-tip: install this bash function to be able to rename current directory as well as cd to the new directory (tab completion is also provided):

# function definition
renwd-cd ()
{
    local dir=`renwd --print -- "$1" 2>/dev/null`
    if [[ "$dir" = "" ]]; then echo "Failed"; else cd "../$dir"; fi
}

# activate tab completion
complete -C renwd renwd-cd

Afterwards, you can:

% renwd-cd foo<Tab>

Note: renself is an alias for renwd.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C renself renself

in your bash startup (e.g. ~/.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 cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete renself 'p/*/`renself`/'

in your tcsh startup (e.g. ~/.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 shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

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

SOURCE

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

SEE ALSO

renlikewd (from App::renlikewd)

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, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

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

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.