The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Perl-Lint-Git-v1.1.0
River stage zero No dependents
++
/ Perl::Lint::Git

NAME

Perl::Lint::Git - Connect git and Perl::Lint to blame the right people for violations.

VERSION

Version 1.1.0

SYNOPSIS

        use Perl::Lint::Git;
        my $git_linter = Perl::Lint::Git->new(
                file => $file,
        );

        my $violations = $git_linter->report_violations(
                author => $author,                 # or undef for all
                since  => $date,                   # to lint only recent changes
        );

METHODS

new()

Create a new Perl::Lint::Git object.

        my $git_linter = Perl::Lint::Git->new(
                file => $file,
        );

Parameters:

  • 'file' (mandatory)

    The path to a file in a Git repository.

get_authors()

Return an arrayref of all the authors found in git blame for the file analyzed.

        my $authors = $git_linter->get_authors();

report_violations()

Report the violations for a given Git author.

        my $violations = $git_linter->report_violations(
                author => $author,                 # or undef for all
                since  => $date,                   # to lint only recent changes
        );

Parameters:

  • author (mandatory)

    The name of the author to search violations for.

  • since (optional)

    A date (format YYYY-MM-DD) for which violations that are older will author to fix an entire legacy file at once if only one line needs to be be ignored. This allows linting only recent changes, instead of forcing your modified.

  • use_cache (default: 0)

    Use a cached version of git diff when available. See Git::Repository::Plugin::Blame::Cache for more information.

force_reanalyzing()

Force reanalyzing the file specified by the current object. This is useful if the file has been modified since the Perl::Lint::Git object has been created.

        $git_critic->force_reanalyzing();

ACCESSORS

get_perl_lint_violations()

Return an arrayref of all the Perl::Lint::Violation objects found by running Perl::Lint on the file specified by the current object.

        my $perlcritic_violations = $git_critic->get_perlcritic_violations();

get_blame_lines()

Return an arrayref of Git::Repository::Plugin::Blame::Line objects corresponding to the lines in the file analyzed.

        my $blame_lines = $self->get_blame_lines();

get_blame_line()

Return a Git::Repository::Plugin::Blame::Line object corresponding to the line number passed as parameter.

        my $blame_line = $git_critic->get_blame_line( 5 );

INTERNAL METHODS

_analyze_file()

Run git blame and Perl::Lint on the file specified by the current object and caches the results to speed reports later.

        $git_critic->_analyze_file();

Arguments:

  • use_cache (default: 0)

    Use a cached version of git diff when available.

_is_analyzed()

Return whether the file specified by the current object has already been analyzed with "git blame" and "PerlLint".

        my $is_analyzed = $git_critic->_is_analyzed();

_get_file()

Return the path to the file to analyze for the current object.

        my $file = $git_critic->_get_file();

SEE ALSO

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/guillaumeaubert/Perl-Lint-Git/issues. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

        perldoc Perl::Lint::Git

You can also look for information at:

AUTHOR

Guillaume Aubert, <aubertg at cpan.org>.

COPYRIGHT & LICENSE

Copyright 2015-2017 Guillaume Aubert.

This code is free software; you can redistribute it and/or modify it under the same terms as Perl 5 itself.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE file for more details.