Module::Abstract - Extract the abstract of a locally installed Perl module
This document describes version 0.002 of Module::Abstract (from Perl distribution Module-Abstract), released on 2021-08-27.
use Module::Abstract qw(module_abstract); say module_abstract("strict"); # => prints something like: Perl pragma to restrict unsafe constructs
Usage:
my $abstract = module_abstract($mod_name);
Extract abstract from module source. Will first load module source using Module::Installed::Tiny's module_source() function (which dies on failure e.g. when it can't find the module). Then will search using simple regex this pattern:
module_source()
=head1 NAME Some::Module::Name - some abstract
or (usually present in Dist::Zilla-managed distribution):
#ABSTRACT: some abstract
Will return undef if abstract cannot be found.
Please visit the project's homepage at https://metacpan.org/release/Module-Abstract.
Source repository is at https://github.com/perlancar/perl-Module-Abstract.
App::lcpan also contains routine to extract abstract from module. It might use Module::Abstract in the future.
pmabstract from App::PMUtils, a CLI front-end for Module::Abstract.
perlancar <perlancar@cpan.org>
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2021 by perlancar <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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Module-Abstract
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.
To install Module::Abstract, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Module::Abstract
CPAN shell
perl -MCPAN -e shell install Module::Abstract
For more information on module installation, please visit the detailed CPAN module installation guide.