#!perl

our $DATE = '2015-03-21'; # DATE
our $VERSION = '0.40'; # VERSION

use 5.010;
use strict;
use warnings;
use Log::Any '$log';

use App::PMUtils;
use Perinci::CmdLine::Any;

our %SPEC;
$SPEC{pmlines} = {
    v => 1.1,
    summary => 'Count number of {code,POD} lines in a Perl module',
    description => <<'_',



_
    args => {
        module => $App::PMUtils::arg_module_multiple,
    },
    result_naked => 1,
};
sub pmlines {
    require SourceCode::LineCounter::Perl;

    my %args = @_;
    my $mods = $args{module};

    require Module::Load;
    require Module::Path::More;

    my $res = [];
    for my $mod (@$mods) {
        $mod =~ s!/!::!g;
        my $rec = {module=>$mod};
        push @$res, $rec;
        my $path = Module::Path::More::module_path(module=>$mod);
        next unless $path;

        my $counter = SourceCode::LineCounter::Perl->new;
        $counter->count($path);
        $rec->{total}   = $counter->total;
        $rec->{code}    = $counter->code;
        $rec->{pod}     = $counter->documentation;
        $rec->{blank}   = $counter->blank;
        $rec->{comment} = $counter->comment;
    };

    $res;
}

Perinci::CmdLine::Any->new(
    url => '/main/pmlines',
)->run;

# ABSTRACT: Count number of {code,POD} lines in a Perl module
# PODNAME: pmlines

__END__

=pod

=encoding UTF-8

=head1 NAME

pmlines - Count number of {code,POD} lines in a Perl module

=head1 VERSION

This document describes version 0.40 of pmlines (from Perl distribution App-PMUtils), released on 2015-03-21.

=head1 SYNOPSIS

 % pmlines HTTP::Tiny LWP::UserAgent
 +-------+------+---------+----------------+-----+-------+
 | blank | code | comment | module         | pod | total |
 | 482   | 988  | 276     | HTTP::Tiny     | 686 | 2136  |
 | 417   | 844  | 68      | LWP::UserAgent | 807 | 1861  |
 +-------+------+---------+----------------+-----+-------+

=head1 DESCRIPTION

This utility uses L<SourceCode::LineCounter::Perl> to count lines of
{code,POD,blank,comment} in a specified module.

=head1 OPTIONS

C<*> marks required options.

=over

=item B<--config-path>=I<s>

Set path to configuration file.

Can be specified multiple times.

=item B<--config-profile>=I<s>

Set configuration profile to use.

=item B<--format>=I<s>

Choose output format, e.g. json, text.

Default value:

 undef

=item B<--help>, B<-h>, B<-?>

Display this help message.

=item B<--json>

Set output format to json.

=item B<--module-json>=I<s>

See C<--module>.

=item B<--module>=I<s@>*

Can be specified multiple times.

=item B<--naked-res>

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd
element) as well as result metadata/extra result (4th element) instead of just
the result (3rd element). However, sometimes you want just the result, e.g. when
you want to pipe the result for more post-processing. In this case you can use
`--naked-res` so you just get:

    [1,2,3]


=item B<--no-config>

Do not use any configuration file.

=item B<--version>, B<-v>

=back

=head1 ENVIRONMENT

PMLINES_OPT

=head1 FILES

~/pmlines.conf

/etc/pmlines.conf

=head1 SEE ALSO

L<App::cloc> which uses the B<cloc> program and can output number of
{code,blank,comment} lines in a Perl source code (as well as other languages).
Results might differ slightly with result from this utility.

L<pllines> (from L<App::PlUtils> distribution)

=head1 COMPLETION

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

=head2 bash

To activate bash completion for this script, put:

 complete -C pmlines pmlines

in your bash startup (e.g. C<~/.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 L<shcompgen> which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with L<Dist::Zilla::Plugin::GenShellCompletion>) will even automatically enable shell completion for their included scripts (using C<shcompgen>) at installation time, so you can immadiately have tab completion.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete pmlines 'p/*/`pmlines`/'

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

=head2 other shells

For fish and zsh, install C<shcompgen> as described above.

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/App-PMUtils>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-PMUtils>.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-PMUtils>

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.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by 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.

=cut
