Filename::Perl::Release - Check whether filename looks like a perl module release archive, e.g. a CPAN release tarball
This document describes version 0.002 of Filename::Perl::Release (from Perl distribution Filename-Perl-Release), released on 2023-12-16.
use Filename::Perl::Release qw(check_perl_release_filename); my $res = check_perl_release_filename(filename => "Foo-Bar-1.000.tar.gz"); if ($res) { printf "File looks like a perl module release archive: dist=%s, version=%s)\n", $res->{distribution}, $res->{version}; } else { print "File does not look like a perl module release archive\n"; }
Usage:
check_perl_release_filename(%args) -> bool|hash
Check whether filename looks like a perl module release archive, e.g. a CPAN release tarball.
Examples:
Example #1:
check_perl_release_filename(filename => "foo.bar"); # -> 0
Example #2:
check_perl_release_filename(filename => "qux-quux-0.123.tar.gz");
Result:
{ archive_suffix => ".tar", distribution => "qux-quux", module => "qux::quux", version => 0.123, }
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
filename* => str
(No description)
Return value: (bool|hash)
Return false if not detected like a perl module release archive. Otherwise return a hash of information, which contains these keys: distribution, module, version.
distribution
module
version
Please visit the project's homepage at https://metacpan.org/release/Filename-Perl-Release.
Source repository is at https://github.com/perlancar/perl-Filename-Perl-Release.
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, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2023 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=Filename-Perl-Release
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 Filename::Perl::Release, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Filename::Perl::Release
CPAN shell
perl -MCPAN -e shell install Filename::Perl::Release
For more information on module installation, please visit the detailed CPAN module installation guide.