NAME

DDG::HasShareDir - Role for a plugin that has a share directory

VERSION

version 1009

DESCRIPTION

This Moo::Role is attached to plugins which are able to give sharedir informations. A class which has no sharedir is not allowed to carry this role.

The class using this role must implement module_share_dir and share.

module_share_dir must return the path to the sharedir inside the repo, like share/goodie/public_dns.

share must give back a Path::Class::Dir of the share directory if its called without parameter. If a parameter is given it must give back Path::Class::File or Path::Class::Dir of the corresponding file in the sharedir that is given as parameter. Checkout "share" in DDG::Meta::ShareDir for information about usage of this function.

For more information about the sharedir see DDG::Meta::ShareDir.

SEE ALSO

Dist::Zilla::Plugin::AutoModuleShareDirs

AUTHOR

DuckDuckGo <open@duckduckgo.com>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2013 by DuckDuckGo, Inc. https://duckduckgo.com/.

This is free software, licensed under:

The Apache License, Version 2.0, January 2004