view release on metacpan or  search on metacpan

lib/App/PPI/Dumper.pm  view on Meta::CPAN

package App::PPI::Dumper;

our $VERSION = "1.026";

=encoding utf8

=head1 NAME

App::PPI::Dumper - Use the PPI to dump the structure of a Perl file

=head1 SYNOPSIS

	use App::PPI::Dumper;

	App::PPI::Dumper->run( @ARGV );

=head1 DESCRIPTION

Parse a Perl document with PPI and dump the Perl Document Object Model (PDOM).
This script is a command-line interface to PPI::Dumper.

=head2 Methods

=over 4

=item run( OPTIONS, INPUT_FILE )

Parse INPUT_FILE with the given PPI::Dumper options, then print the result to
standard output.

=over 4

=item -m

Show the memory address of each PDOM element.

=item -i N

Ident each level of output by N spaces. The default is 2.

=item -P

Do not show the full package name for each PPI class.

=item -T

Do not show the original source token that goes with each PPI object.

=item -W

Do not show whitespace tokens.

=item -C

Do not show comment tokens.

=item -l

Show the source code location of each PPI token.

=item -r

Parse the input in readonly mode. See PPI::Document::new() for the details.

=back

=back

=head1 SEE ALSO

Most behaviour, including environment variables and configuration,
comes directly from PPI::Dumper. I just made a command-line tool for it.

=head1 SOURCE AVAILABILITY

This code is in Github:

	https://github.com/briandfoy/app-ppi-dumper.git

=head1 AUTHOR

brian d foy, C<< <briandfoy@pobox.com> >>

=head1 COPYRIGHT

Copyright © 2009-2025, brian d foy <briandfoy@pobox.com>. All rights reserved.

You may redistribute this under the terms of the Artistic License 2.0.