/ 
App-CreateAcmeCPANModulesImportModules-0.001
River stage one • 1 direct dependent • 1 total dependent
/ App::CreateAcmeCPANModulesImportModules

NAME

App::CreateAcmeCPANModulesImportModules - Create Acme::CPANModules::Import::* modules

VERSION

This document describes version 0.001 of App::CreateAcmeCPANModulesImportModules (from Perl distribution App-CreateAcmeCPANModulesImportModules), released on 2018-02-18.

FUNCTIONS

create_acme_cpanmodules_import_modules

Usage:

create_acme_cpanmodules_import_modules(%args) -> [status, msg, result, meta]

Create Acme::CPANModules::Import::* modules.

An Acme::CPANModules::Import::* module contains a module list where its entries (modules) are extracted from a web page. The purpose of creating such module is to have a POD mentioning the modules, thus adding/improving to the POD "mentions cloud" on CPAN.

This function is not exported.

Arguments ('*' denotes required arguments):

  • cache => bool (default: 1)

  • dist_dir => str

  • exclude_unindexed => bool (default: 1)

    Consult local CPAN index and exclude module entries that are not indexed on CPAN.

    This requires App::lcpan to be installed and a local CPAN index to exist and be fairly recent.

  • ignore_empty => bool

    If set to true, will not create if there are no extracte module names found.

  • modules* => array[hash]

  • namespace* => str

  • typos => hash

    Module names that should be replaced by their fixed spellings.

  • user_agent => str

    Set HTTP User-Agent.

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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

ENVIRONMENT

HTTP_USER_AGENT => str

Set default for user_agent argument.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-CreateAcmeCPANModulesImportModules.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-CreateAcmeCPANModulesImportModules.

BUGS

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

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

Acme::CPANModules

Some Acme::CPANModules::Import::* modules which utilize this during building: Acme::CPANModulesBundle::Import::NEILB, Acme::CPANModules::Import::SHARYANTO, Acme::CPANModulesBundle::Import::RSAVAGE, and so on.

App::lcpan, lcpan, especially the related-mods subcommand.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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