App-EditorTools

 view release on metacpan or  search on metacpan

Changes  view on Meta::CPAN

    kentnl++ for the report and patch (RT#63018).

0.12 - Tue Mar 30 17:29:06 2010
    Moved vim/emacs script into a share directory (from DATA).
    Improved the documenation a bit.

0.11 - Thu Mar 25 13:28:50 2010
    Minor bug fix to install-emacs command.

0.10 - Thu Mar 25 13:20:30 2010
    Added install-vim and install-emacs command to make binding install
    easier and more portable. Improved documentation and testing.

0.09 - Thu Dec 10 12:55:30 2009
    Added version requirement for Test::More in Build.PL so we can use
    done_testing().

0.08 - Sat Nov 14 16:56:51 2009
    Convert tests from IPC::Run3 to App::Cmd::Testers to fix tests on certain platforms

0.07 - Fri Nov 13 13:03:23 2009

README  view on Meta::CPAN

NAME
    App::EditorTools - Command line tool for Perl code refactoring

BACKGROUND
    The Padre Perl editor team developed some very interesting PPI based
    refactoring tools for their editor. Working with the Padre team, those
    routines were abstracted into PPIx::EditorTools in order to make them
    available to alternative editors.

    The initial implementation was developed for Vim. Pat Regan contributed
    the emacs bindings. Other editor bindings are encouraged/welcome.

REFACTORINGS
    The following lists the refactoring routines that are currently
    supported. Please see App::EditorTools::Vim or App::EditorTools::Emacs
    to learn how to install the bindings and the short cuts to use within
    your editor. The command line interface should only be needed to develop
    the editor bindings.

    Each command expects the Perl program being edited to be piped in via
    STDIN. The refactored code is output on STDOUT.

    RenameVariable
            editortools renamevariable -c col -l line -r newvar

        Renames the variable at column "col" and line "line" to "newvar".
        Unlike editors typical find and replace, this is aware of lexical
        scope and only renames those variables within same scope. For

lib/App/EditorTools.pm  view on Meta::CPAN

App::EditorTools - Command line tool for Perl code refactoring

=head1 BACKGROUND

The L<Padre> Perl editor team developed some very interesting L<PPI> based
refactoring tools for their editor. Working with the L<Padre> team, those
routines were abstracted into L<PPIx::EditorTools> in order to make them 
available to alternative editors.

The initial implementation was developed for Vim. Pat Regan contributed
the emacs bindings. Other editor bindings are encouraged/welcome.

=head1 REFACTORINGS

The following lists the refactoring routines that are currently supported.
Please see L<App::EditorTools::Vim> or L<App::EditorTools::Emacs> to
learn how to install the bindings and the short cuts to use within your
editor. The command line interface should only be needed to develop the
editor bindings.

Each command expects the Perl program being edited to be piped in via
STDIN. The refactored code is output on STDOUT.

=over 4

=item RenameVariable

    editortools renamevariable -c col -l line -r newvar 

lib/App/EditorTools/Command/InstallEmacs.pm  view on Meta::CPAN

package App::EditorTools::Command::InstallEmacs;

# ABSTRACT: Install emacs bindings for App::EditorTools

use strict;
use warnings;
use parent 'App::EditorTools::CommandBase::Install';

#use App::EditorTools -command;
use File::HomeDir;

our $VERSION = '1.00';

lib/App/EditorTools/Command/InstallEmacs.pm  view on Meta::CPAN

1;

__END__

=pod

=head1 NAME

App::EditorTools::Command::InstallEmacs - Install emacs bindings for App::EditorTools

=head1 VERSION

version 1.00

=head1 SYNOPSIS

    # Install the emacs script to create binding to App::EditorTools with:
    editortools install-emacs

=head1 DESCRIPTION

This will place the emacs script contained in the share dir of this
distribution where emacs expects it ( C<$HOME/.emacs.d/editortools.el> for a
local install on a unix-like system)>).

=head1 OPTIONS

lib/App/EditorTools/Command/InstallVim.pm  view on Meta::CPAN

package App::EditorTools::Command::InstallVim;

# ABSTRACT: Installs vim bindings for App::EditorTools

use strict;
use warnings;
use parent 'App::EditorTools::CommandBase::Install';

#use App::EditorTools -command;
use File::HomeDir;
# use IPC::Cmd qw(run);

our $VERSION = '1.00';

lib/App/EditorTools/Command/InstallVim.pm  view on Meta::CPAN

1;

__END__

=pod

=head1 NAME

App::EditorTools::Command::InstallVim - Installs vim bindings for App::EditorTools

=head1 VERSION

version 1.00

=head1 SYNOPSIS

    # Install the vim script to create binding to App::EditorTools with:
    editortools install-vim

=head1 DESCRIPTION

This will place the vim script contained in the share dir of this distribution
where vim expects it ( C<$HOME/.vim/ftplugin/perl/editortools.vim> for a local
install on a unix-like system)>).

=head1 OPTIONS

lib/App/EditorTools/CommandBase/Install.pm  view on Meta::CPAN

package App::EditorTools::CommandBase::Install;

# ABSTRACT: Base class for installing bindings for editors

use strict;
use warnings;

use File::Basename;
use File::Path qw(mkpath);
use File::Slurp;
use File::ShareDir qw(dist_file);
use App::Cmd::Setup -command;

lib/App/EditorTools/CommandBase/Install.pm  view on Meta::CPAN

}

1;

__END__

=pod

=head1 NAME

App::EditorTools::CommandBase::Install - Base class for installing bindings for editors

=head1 VERSION

version 1.00

=head1 AUTHOR

Mark Grimes, E<lt>mgrimes@cpan.orgE<gt>

=head1 COPYRIGHT AND LICENSE

lib/App/EditorTools/Emacs.pod  view on Meta::CPAN

=pod

=head1 NAME

App::EditorTools::Emacs - Emacs binding for App::EditorTools

=head1 SYNOPSIS
    
    # Install the emacs script to create binding to App::EditorTools with:
	editortools install-emacs

=head1 DESCRIPTION

Once the emacs bindings have been installed (per the instructions in the
SYNOPIS) you can use the mappings below speed editing/refactoring your
Perl code. See L<App::EditorTools> for a description of each refactoring
routine.

=head1 MAPPINGS

=over 4

=item TODO

lib/App/EditorTools/Vim.pod  view on Meta::CPAN

=pod

=head1 NAME

App::EditorTools::Vim - Vim binding to App::EditorTools

=head1 SYNOPSIS
    
    # Install the vim script to create binding to App::EditorTools with:
	editortools install-vim

=head1 DESCRIPTION

Once the vim bindings have been installed (per the instructions in the
SYNOPIS) you can use the mappings below speed editing/refactoring your
Perl code. See L<App::EditorTools> for a description of each refactoring
routine.

=head1 MAPPINGS

=over 4

=item ,pp

script/editortools  view on Meta::CPAN

App::EditorTools - Command line tool for Perl code refactoring

=head1 BACKGROUND

The L<Padre> Perl editor team developed some very interesting L<PPI> based
refactoring tools for their editor. Working with the L<Padre> team, those
routines were abstracted into L<PPIx::EditorTools> in order to make them 
available to alternative editors.

The initial implementation was developed for Vim. Pat Regan contributed
the emacs bindings. Other editor bindings are encouraged/welcome.

=head1 REFACTORINGS

The following lists the refactoring routines that are currently supported.
Please see L<App::EditorTools::Vim> or L<App::EditorTools::Emacs> to
learn how to install the bindings and the short cuts to use within your
editor. The command line interface should only be needed to develop the
editor bindings.

Each command expects the Perl program being edited to be piped in via
STDIN. The refactored code is output on STDOUT.

=over 4

=item RenameVariable

    editortools renamevariable -c col -l line -r newvar