Scroll to navigation

Dist::Zilla::Role::PluginBundle::PluginRemover(3pm) User Contributed Perl Documentation Dist::Zilla::Role::PluginBundle::PluginRemover(3pm)


Dist::Zilla::Role::PluginBundle::PluginRemover - Add '-remove' functionality to a bundle


version 0.104


  # in Dist::Zilla::PluginBundle::MyBundle
  with (
    'Dist::Zilla::Role::PluginBundle', # or PluginBundle::Easy
  # PluginRemover should probably be last
  # (unless you're doing something more complex)


This role enables your Dist::Zilla Plugin Bundle to automatically remove any plugins specified by the "-remove" attribute (like @Filter does):

  -remove = PluginIDontWant
  -remove = OtherDumbPlugin

If you want to use an attribute named "-remove" for your own bundle you can override the "plugin_remover_attribute" sub to define a different attribute name:

  # in your bundle package
  sub plugin_remover_attribute { 'scurvy_cur' }

This role adds a method modifier to "bundle_config", which is the method that the root "PluginBundle" role requires, and that "PluginBundle::Easy" wraps.



Returns the name of the attribute containing the array ref of plugins to remove.

Defaults to "-remove".


  $class->remove_plugins(\@to_remove, @plugins);
  $class->remove_plugins(['Foo'], [Foo => 'DZP::Foo'], [Bar => 'DZP::Bar']);

Takes an arrayref of plugin names to remove (like what will be in the config payload for "-remove"), removes them from the list of plugins passed, and returns the remaining plugins.

This is used by the "bundle_config" modifier but is defined separately in case you would like to use the functionality without the voodoo that occurs when consuming this role.

The plugin name to match against all plugins can be given as either the plugin moniker (like you might provide in your config file, expanded via "expand_config" in Dist::Zilla::Util), or the unique plugin name used to differentiate multiple plugins of the same type. For example, in this configuration:

    [Foo::Bar / plugin 1]
    [Foo::Bar / plugin 2]

passing 'Foo::Bar' to "remove_plugins" will remove both these plugins from the configuration, but only the first is removed when passing 'plugin 1'.



You can find documentation for this module with the perldoc command.

  perldoc Dist::Zilla::Role::PluginBundle::PluginRemover


The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.


A modern, open-source CPAN search engine, useful to view POD in HTML format.


Bugs / Feature Requests

Please report any bugs or feature requests by email to "bug-dist-zilla-role-pluginbundle-pluginremover at", or through the web interface at <>. You will be automatically notified of any progress on the request by the system.

Source Code


  git clone


Randy Stauner <>


Karen Etheridge <>


This software is copyright (c) 2011 by Randy Stauner.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

2021-01-07 perl v5.32.0