07 Mar 2017 07:39:26 UTC
- Distribution: Dist-Zilla-App-Command-dumpphases
- Module version: 1.000009
- Source (raw)
- Browse (raw)
- How to Contribute
- Testers (523 / 1 / 0)
- KwaliteeBus factor: 1
- 96.35% Coverage
- License: perl_5
- Perl: v5.6.0
- Activity24 month
- Download (34.95KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest version++ed by:2 non-PAUSE usersKENTNL Kent Fredric (PAUSE Custodial Account)
- SEE ALSO
- COPYRIGHT AND LICENSE
Dist::Zilla::App::Command::dumpphases - Dump a textual representation of each phase's parts.
cd $PROJECT; dzil dumpphases dzil dumpphases --color-theme=basic::plain # plain text dzil dumpphases --color-theme=basic::green # green text
If you are using an HTML-enabled POD viewer, you should see a screenshot of this in action:
( Everyone else can visit http://kentnl.github.io/screenshots/Dist-Zilla-App-Command-dumpphases/example_01.png )
Will report what phases are triggering as they happen.
Working out what Plugins will execute in which order during which phase can be a little confusing sometimes.
This Command exists primarily to make developing Plugin Bundles and debugging dist.ini a bit easier, especially for newbies who may not fully understand Bundles yet.
If you want to turn colors off, use
Term::ANSIcolor's environment variable
ANSI_COLORS_DISABLED=1 dzil dumpphases
Alternatively, since 0.3.0 you can specify a color-free theme:
dzil dumpphases --color-theme=basic::plain
Technically speaking, this utility deals with more than just "phases", it will in fact dump all plugins used, and it will in the process of doing so, dump things that are part of the clearly defined "phases" that occur within
However, if you want to be pedantic, and understand how
Dist::Zillaworks, then you must understand, many of the things this module calls "phases" are not so much phases.
At its core,
Dist::Zillahas an array, on which all
Plugins are stored.
Plugin, in itself, will not do very much ( at least, not unless they do instantiation-time changes like
There are 3 Primary kinds of plugin
Plugins which exist to augment other plugins ( For instance,
Dist::Zillaitself essentially ignores these, and their consumption is entirely regulated by other
Plugins which hook into a specific and determinate phase of the
These all provide primary methods, which
Dist::Zilladirectly calls somewhere in its core code base.
Good examples of Phase plugins perform
A Third Kind
There's a third kind of Plugin, which is somewhere between the other two, which I presently lack a name for.
Like the Phases, they provide primary methods, which are called by
Dist::Zilladirectly, and they provide information for infrastructural components of the
However, they're not strictly "phases", because exactly when they will be called ( or if they will be called at all ) is heavily dependent on usage.
-VersionProvider, which is dependent on a few variables, and is called only when its needed, the first time its needed.
Which means it could occur as early as creating
META.jsonor it could occur as late as just before it writes the distribution out to disk.
App::Commandcommand will indeed list all of the above, but for the sake of ease of use, the "Third kind" is informally under the umbrella of a "phase".
This command takes one optional parameter
dzil dumpphases --color-theme=<THEME>
The name of a color theme to use.
Existing themes are:
Kent Fredric <firstname.lastname@example.org>
This software is copyright (c) 2017 by Kent Fredric <email@example.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.
Module Install Instructions
To install Dist::Zilla::App::Command::dumpphases, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Dist::Zilla::App::Command::dumpphases
For more information on module installation, please visit the detailed CPAN module installation guide.