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

NAME

App::lcpan::Cmd::author_rdeps - Find distributions that use one of author's modules

VERSION

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

FUNCTIONS

handle_cmd

Usage:

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

Find distributions that use one of author's modules.

This function is not exported.

Arguments ('*' denotes required arguments):

  • added_since => date

    Include only records that are added since a certain date.

  • added_since_last_index_update => true

    Include only records that are added since the last index update.

  • added_since_last_n_index_updates => posint

    Include only records that are added since the last N index updates.

  • author* => str

    (No description)

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

  • phase => str (default: "ALL")

    (No description)

  • rel => str (default: "ALL")

    (No description)

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

  • updated_since => date

    Include only records that are updated since certain date.

  • updated_since_last_index_update => true

    Include only records that are updated since the last index update.

  • updated_since_last_n_index_updates => posint

    Include only records that are updated since the last N index updates.

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

  • user_authors => array[str]

    (No description)

  • user_authors_arent => array[str]

    (No description)

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.