Kent Fredric > Dist-Zilla-Plugin-MetaProvides-Package-2.003001 > Dist::Zilla::Plugin::MetaProvides::Package

Download:
Dist-Zilla-Plugin-MetaProvides-Package-2.003001.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 2.003001   Source  

NAME ^

Dist::Zilla::Plugin::MetaProvides::Package - Extract namespaces/version from traditional packages for provides

VERSION ^

version 2.003001

SYNOPSIS ^

In your dist.ini:

    [MetaProvides::Package]
    inherit_version = 0    ; optional
    inherit_missing = 0    ; optional
    meta_noindex    = 1    ; optional

DESCRIPTION ^

This is a Dist::Zilla Plugin that populates the provides property of META.json and META.yml by absorbing it from your shipped modules, in a manner similar to how PAUSE itself does it.

This allows you to easily create an authoritative index of what module provides what version in advance of PAUSE indexing it, which PAUSE in turn will take verbatim.

QUICK REFERENCE ^

  Constructors:
  ->new(options={})
    finder => Attribute:finder

  Attributes:
  ->finder                            # ArrayRef[Str]

  Methods:
  ->dumpconfig                        # HashRef
  ->has_finder                        # via finder
  ->mvp_multivalue_args               # List
  ->provides

  -~- Inherited From: Dist::Zilla::Role::MetaProvider::Provider
  Constructors:
  ->new(options={})
    inherit_version => Attribute:inherit_missing
    inherit_missing => Attribute:inherit_version
    meta_noindex    => Attribute:meta_noindex


  Attributes:
  ->inherit_missing                 # Bool = 1
  ->inherit_version                 # Bool = 1
  ->meta_noindex                    # Bool = 1

  Methods:
  ->dumpconfig                      # HashRef
  ->metadata                        # { provides => ... }

  -~- Inherited From: Dist::Zilla::Role::PPI
  Methods:
  ->document_assigns_to_variable(options=[])  # Bool
    0   =>  $document                         # PPI::Document
    1   =>  $variable_name                    # Varible name (w/sigil)
  ->ppi_document_for_file(options=[])         # PPI::Document
    0   =>  $file                             # Dist::Zilla::Role::File
  ->save_ppi_document_to_file(options=[])     # PPI::Document
    0   =>  $document                         # PPI::Document
    1   =>  $file                             # Dist::Zilla::Role::File

  -~- Inherited From: Dist::Zilla::Role::MetaProvider

  -~- Inherited From: Dist::Zilla::Role::Plugin
  Constructors:
  ->new(options={})
    plugin_name => Attribute:plugin_name
    zilla       => Attribute:zilla
    logger      => Attribute:logger

  Attributes:
  ->logger                          #
  ->plugin_name                     # Str
  ->zilla                           # DZil

  Methods:
  ->log                             # via logger
  ->log_debug                       # via logger
  ->log_fatal                       # via logger
  ->mvp_multivalue_args             # ArrayRef
  ->mvp_aliases                     # HashRef
  ->plugin_from_config(options=[])  # Instance
    0 =>  $name
    1 =>  $arg
    2 =>  $section
  ->register_component(options=[])
    0 =>  $name
    1 =>  $arg
    2 =>  $section

CONSUMED ROLES ^

Dist::Zilla::Role::MetaProvider::Provider

ROLE SATISFYING METHODS ^

provides

A conformant function to the Dist::Zilla::Role::MetaProvider::Provider Role.

signature: $plugin->provides()

returns: Array of Dist::Zilla::MetaProvides::ProvideRecord

ATTRIBUTES ^

finder

This attribute, if specified will

This parameter may be specified multiple times to aggregate a list of finders

PRIVATE ATTRIBUTES ^

_package_blacklist

_finder_objects

PRIVATE METHODS ^

_packages_for

signature: $plugin->_packages_for( $file )

returns: Array of Dist::Zilla::MetaProvides::ProvideRecord

_vivify_installmodules_pm_finder

_build_finder_objects

_found_files

OPTIONS INHERITED FROM Dist::Zilla::Role::MetaProvider::Provider ^

inherit_version

How do you want existing versions ( Versions hard-coded into files before running this plug-in )to be processed?

inherit_missing

In the event you are using the aforementioned "inherit_version" = 0, this determines how to behave when encountering a module with no version defined.

meta_noindex

This is a utility for people who are also using MetaNoIndex, so that its settings can be used to eliminate items from the 'provides' list.

SEE ALSO ^

AUTHOR ^

Kent Fredric <kentnl@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2015 by Kent Fredric <kentfredric@gmail.com>.

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

syntax highlighting: