++ed by:
10 non-PAUSE users
Author image perlancar


App::lcpan::Cmd::mods_by_mention_count - List modules ranked by number of mentions


This document describes version 1.062 of App::lcpan::Cmd::mods_by_mention_count (from Perl distribution App-lcpan), released on 2020-08-13.




 handle_cmd(%args) -> [status, msg, payload, meta]

List modules ranked by number of mentions.

This shows the list of most mentioned modules, that is, modules who are linked/referred to the most in PODs.

Unknown modules (modules not indexed) are not included. Note that mentions can refer to unknown modules.

By default, each source module/script that mentions a module is counted as one mention (--count-per content). Use --count-per dist to only count mentions by modules/scripts from the same dist as one mention (so a module only gets a maximum of 1 vote per dist). Use --count-per author to only count mentions by modules/scripts from the same author as one mention (so a module only gets a maximum of 1 vote per mentioning author).

By default, only mentions from other authors are included. Use --include-self-mentions to also include mentions from the same author.

This function is not exported.

Arguments ('*' denotes required arguments):

  • count_per => str (default: "content")

  • cpan => dirname

    Location of your local CPAN mirror, e.g. /path/to/cpan.

    Defaults to ~/cpan.

  • include_self_mentions => bool (default: 0)

  • index_name => filename (default: "index.db")

    Filename of index.

    If index_name is a filename without any path, e.g. index.db then index will be located in the top-level of cpan. If index_name contains a path, e.g. ./index.db or /home/ujang/lcpan.db then the index will be located solely using the index_name.

  • n => posint

    Return at most this number of results.

  • use_bootstrap => bool (default: 1)

    Whether to use bootstrap database from App-lcpan-Bootstrap.

    If you are indexing your private CPAN-like repository, you want to turn this off.

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)


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


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


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

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.


perlancar <perlancar@cpan.org>


This software is copyright (c) 2020, 2019, 2018, 2017, 2016, 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.