NAME
App::CPANModulesUtils - Command-line utilities related to Acme::CPANModules
VERSION
This document describes version 0.006 of App::CPANModulesUtils (from Perl distribution App-CPANModulesUtils), released on 2021-05-19.
SYNOPSIS
DESCRIPTION
This distribution includes the following command-line utilities related to Acme::CPANModules:
FUNCTIONS
acme_cpanmodules_for
Usage:
acme_cpanmodules_for(%args) -> [status, msg, payload, meta]List Acme::CPANModules distributions that mention specified modules.
This utility consults lcpan (local indexed CPAN mirror) to check if there are Acme::CPANModules distributions that mention specified modules. This is done by checking the presence of a dependency with the relationship x_mentions.
See also App::lcpan which has a "x-mentions-for-mod" subcommand that does the same thing.
This function is not exported.
Arguments ('*' denotes required arguments):
modules* => array[perl::modname]
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
gen_acme_cpanmodules_module_from_acme_cpanlists_list
Usage:
gen_acme_cpanmodules_module_from_acme_cpanlists_list(%args) -> [status, msg, payload, meta]Generate an Acme::CPANModules module file from an Acme::CPANLists module list.
This function is not exported.
Arguments ('*' denotes required arguments):
input_list_index => nonnegint
Required if the Acme::CPANLists module contains more than one module list.
input_module* => perl::modname
"Acme::CPANLists::" will be prepended if module name does not begin with it.
output_file => filename
will default to "lib/Acme/CPANModules/<YourModuleName>.pm
output_module => perl::modname
"Acme::CPANModules::" will be prepended if module name does not begin with it.
Will default to the Acme::CPANLists module name, with CPANLists replaced by CPANModules.
overwrite => true
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
gen_acme_cpanmodules_module_from_webpage
Usage:
gen_acme_cpanmodules_module_from_webpage(%args) -> [status, msg, payload, meta]Generate an Acme::CPANModules module file a webpage.
This routine will download the webpage, extract the links in it, extract the CPAN modules mentioned in the links, and use the extracted CPAN modules as entries for the Acme::CPANModules module.
This function is not exported.
Arguments ('*' denotes required arguments):
output_file => filename
will default to "lib/Acme/CPANModules/<YourModuleName>.pm
output_module* => perl::modname
"Acme::CPANModules::" will be prepended if module name does not begin with it.
overwrite => true
url* => str
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-CPANModulesUtils.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-CPANModulesUtils.
BUGS
Please report any bugs or feature requests on the bugtracker website https://github.com/perlancar/perl-App-CPANModulesUtils/issues
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.
SEE ALSO
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 2020, 2019, 2018 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.