The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Module-Features-PluginSystem-0.002
River stage zero No dependents
/ Module::Features::PluginSystem

NAME

Module::Features::PluginSystem - Features of modules that generate text tables

VERSION

This document describes version 0.002 of Module::Features::PluginSystem (from Perl distribution Module-Features-PluginSystem), released on 2024-03-17.

DESCRIPTION

Glossary

Hook: a named execution point where plugins' handlers get the chance to add behaviors.

Plugin: a code packaged in a Perl module that contains extra behaviors in one or more of /handler/s.

Handler: A subroutine (or method) in a /plugin/ that will get called in a /hook/.

Priority: a number between 0 and 100 signifying the order of execution of a handler compared to handlers for the same hook from other plugins. Lower number means a higher priority (executed first). Default priority if unspecified is 50.

DEFINED FEATURES

Features defined by this module:

  • can_add_multiple_handlers_from_a_plugin

    Optional. Type: bool. Allow adding a plugin instance multiple times.

  • can_customize_handler_priority

    Optional. Type: bool. Allow application user to customize the priority of a plugin's handler, without modifying source code.

  • can_handler_priority

    Optional. Type: bool.

  • can_let_plugin_contain_multiple_handlers

    Optional. Type: bool. Whether a single plugin module (or class) can contain handlers for more than one hook.

  • can_let_plugin_repeat_hook

    Optional. Type: bool.

  • can_let_plugin_repeat_other_plugins

    Optional. Type: bool.

  • can_let_plugin_skip_hook

    Optional. Type: bool.

  • can_let_plugin_skip_other_plugins

    Optional. Type: bool.

  • can_plugin_configuration

    Optional. Type: bool. Allow plugin to have configuration; see also feature: .

  • can_put_handler_in_other_hook

    Optional. Type: bool. Allow a plugin handler for a hook to be assigned to another hook.

  • speed

    Optional. Type: str. Subjective speed rating, relative to other plugin system modules.

For more details on module features, see Module::Features.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Module-Features-PluginSystem.

SOURCE

Source repository is at https://github.com/perlancar/perl-Module-Features-PluginSystem.

SEE ALSO

Module::Features

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) 2024 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=Module-Features-PluginSystem

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.