The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

App::GitFind - Find files anywhere in a Git repository

SYNOPSIS

This is the implementation of the git-find command (q.v.). To use it from Perl code:

    use App::GitFind;
    exit App::GitFind->new(\@ARGV)->run;

SUBROUTINES/METHODS

BUILD

Process the arguments. Usage:

    my $gf = App::GitFind->new(-argv => \@ARGV, -searchbase => Cwd::getcwd);

May modify the provided array. May exit(), e.g., on --help.

run

Does the work. Call as exit($obj->run()). Returns a shell exit code.

INTERNALS

_make_searcher

Create an iterator for the entries to be processed. Returns an App::GitFind::Searcher. Usage:

    my $searcher = $self->_make_searcher('rev', -in => $repo);

_process_options

Process the options and return a hashref. Any remaining arguments are stored under key _.

AUTHOR

Christopher White, <cxw at cpan.org>

LICENSE AND COPYRIGHT

Copyright 2019 Christopher White. Portions copyright 2019 D3 Engineering, LLC.

This program is distributed under the MIT (X11) License: http://www.opensource.org/licenses/mit-license.php

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.