/ 
App-lcpan-1.074
River stage two • 42 direct dependents • 69 total dependents
/ App::lcpan::Cmd::related_mods

NAME

App::lcpan::Cmd::related_mods - List other modules related to module(s)

VERSION

This document describes version 1.074 of App::lcpan::Cmd::related_mods (from Perl distribution App-lcpan), released on 2023-09-26.

FUNCTIONS

handle_cmd

Usage:

handle_cmd(%args) -> [$status_code, $reason, $payload, \%result_meta]

List other modules related to module(s).

This subcommand lists other modules that might be related to the module(s) you specify. This is done by listing modules that tend be mentioned together in POD documentation.

The downside of this approach is that the module(s) and the related modules must all already be mentioned together in POD documentations. You will not find a fresh new module that tries to be an improvement/alternative to an existing module, even if that new module mentions the old module a lot, simply because the new module has not been mentioned in other modules' PODs. Someone will need to create that POD(s) first.

The scoring/ranking still needs to be tuned.

This function is not exported.

Arguments ('*' denotes required arguments):

  • cpan => dirname

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

    Defaults to ~/cpan.

  • 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.

  • limit => int (default: 20)

    Maximum number of modules to return.

  • modules* => array[perl::modname]

    (No description)

  • skip_same_dist => bool

    Skip modules from the same distribution.

  • sort => array[str] (default: ["-score","-num_mentions"])

    (No description)

  • submodules => bool

    Whether to include submodules.

    If set to true, will only show related submodules, e.g. lcpan related-modules Foo::Bar will only show Foo::Bar::Baz, Foo::Bar::Quz, and so on.

    If set to false, will only show related modules that are not submodules, e.g. lcpan related-modules Foo::Bar will show Baz, Foo::Baz, but not Foo::Bar::Baz.

  • update_db_schema => bool (default: 1)

    Whether to update database schema to the latest.

    By default, when the application starts and reads the index database, it updates the database schema to the latest if the database happens to be last updated by an older version of the application and has the old database schema (since database schema is updated from time to time, for example at 1.070 the database schema is at version 15).

    When you disable this option, the application will not update the database schema. This option is for testing only, because it will probably cause the application to run abnormally and then die with a SQL error when reading/writing to the database.

    Note that in certain modes e.g. doing tab completion, the application also will not update the database schema.

  • 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.

  • with_content_paths => bool

    Return the list of content paths where the module and a related module are mentioned together.

  • with_scores => bool

    Return score-related fields.

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

HOMEPAGE

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

SOURCE

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

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

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.

COPYRIGHT AND LICENSE

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

BUGS

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.