view release on metacpan or  search on metacpan

lib/Code/ART/API/Vim.pm  view on Meta::CPAN

    # Otherwise, build the regex as the disjunction of each possible set of coordinates...
    return '\%(' . join('\|', @positions) . '\)';
}



1; # Magic true value required at end of module
__END__

=head1 NAME

Code::ART::API::Vim - Vim API for Code::ART


=head1 VERSION

This document describes Code::ART version 0.000001


=head1 SYNOPSIS

    perl -MCode::ART::API::Vim -e'refactor_to_sub($OPTIONS)'

    perl -MCode::ART::API::Vim -e'classify_var_at($CURSOR_IDX)'

=head1 DESCRIPTION

This module provides a range of subroutines to help plug the
Code::ART module directly into the Vim editor.

See the F<perlart.vim> plugin for details of how the various components
are used.

See the L<Code::ART> module for documentation of the functions provided
through this API.


=head1 DIAGNOSTICS

Exactly as for the corresponding subroutines in the L<Code::ART> module
(because they are merely passed through from that module).


=head1 CONFIGURATION AND ENVIRONMENT

Code::ART::API::Vim requires no configuration files or environment variables.


=head1 DEPENDENCIES

The L<Code::ART> module.


=head1 INCOMPATIBILITIES

Because this module relies on the PPR module,
it will not run under Perl 5.20
(because regexes are broken in that version of Perl).


=head1 BUGS AND LIMITATIONS

These refactoring and analysis algorithms are not intelligent or
self-aware. They do not understand the code they are processing, and
especially not the purpose or intent of that code. They are merely
applying a set of heuristics (i.e. informed guessing) to try to
determine what you actually wanted the replacement code to do. Sometimes
they will guess wrong. Treat them as handy-but-dumb tools, not as
magical A.I. superfriends. Trust...but verify.

No bugs have been reported.

Please report any bugs or feature requests to
C<bug-code-art.cpan.org>, or through the web interface at
L<http://rt.cpan.org>.


=head1 AUTHOR

Damian Conway  C<< <DCONWAY@CPAN.org> >>


=head1 LICENCE AND COPYRIGHT

Copyright (c) 2020, Damian Conway C<< <DCONWAY@CPAN.org> >>. All rights reserved.

This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlartistic>.


=head1 DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.