The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Dist-Zilla-Plugin-PkgAuthority-0.05
River stage zero No dependents
++
/ Dist::Zilla::Plugin::PkgAuthority

NAME

Dist::Zilla::Plugin::PkgAuthority - Add a $AUTHORITY to your packages.

VERSION

Version 0.05

SYNOPSIS

in dist.ini

  [PkgAuthority]
  pause_id = <PAUSEID>

DESCRIPTION

This plugin will add line like the following to each package in each Perl module or program (more or less) within the distribution:

  $MyModule::AUTHORITY = 'cpan:PAUSEID';

It will skip any package declaration that includes a newline between the package keyword and the package name, like:

  package
    Foo::Bar;

This sort of declaration is also ignored by the CPAN toolchain, and is typically used when doing monkey patching or other tricky things.

ATTRIBUTES

die_on_existing_authority

If true, then when Dist::Zilla::Plugin::PkgAuthority sees an existing $AUTHORITY assignment, it will throw an exception rather than skip the file. This attribute defaults to false.

Also note that assigning to $AUTHORITY before the module has finished compiling can lead to confused behavior with attempts to determine whether a module was successfully loaded on perl v5.8.

finder

This is the name of a FileFinder for finding modules to edit. The default value is :InstallModules and :ExecFiles; this option can be used more than once.

Other predefined finders are listed in "default_finders" in Dist::Zilla::Role::FileFinderUser. You can define your own with the [FileFinder::ByName] and [FileFinder::Filter] plugins.

AUTHOR

Mohammad S Anwar <mohammad.anwar AT yahoo.com>

REPOSITORY

https://github.com/manwar/Dist-Zilla-Plugin-PkgAuthority

SEE ALSO

Dist::Zilla::Plugin::Authority

ACKNOWLEDGEMENT

Inspired by the package Dist::Zilla::Plugin::PkgVersion by RJBS,

BUGS

Please report any bugs or feature requests to bug-dist-zilla-plugin-pkgauthority at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dist-Zilla-Plugin-PkgAuthority. I will be notified and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

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

    perldoc Dist::Zilla::Plugin::PkgAuthority

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright (C) 2016 Mohammad S Anwar.

This program is free software; you can redistribute it and / or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License.By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you,you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement,then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.