ppisel - Select PPI::Element nodes using CSel syntax
This document describes version 0.002 of ppisel (from Perl distribution App-ppisel), released on 2019-07-30.
To print all 'print' statements:
% ppisel script.pl '.Statement:has(.Token::Word[content="print"])'
To print the first comment:
% ppisel script.pl 'Comment:first'
To dump PPI document tree (--root select the root node, --dump dumps the content):
--root
--dump
% ppisel script.pl --root --dump
This utility uses CSel to select against a tree of PPI::Element nodes, constructed by PPI from a Perl source code.
About the tree: the root node is PPI::Document object, which is a subclass of PPI::Element. The other nodes are also subclasses of PPI::Element. This utility allows you to omit the PPI::Token:: or PPI:: prefix, so to select a word token can use:
PPI::Token::
PPI::
.Token::Word
or just:
.Word
* marks required options.
*
Shortcut for --node-action count.
See --node-action.
--node-action
Shortcut for --node-action dump.
Default value:
"-"
Specify action(s) to perform on matching nodes.
["print_as_string"]
Each action can be one of the following:
* `count` will print the number of matching nodes.
* `print_method` will call on or more of the node object's methods and print the result. Example:
print_method:as_string
* `dump` will show a indented text representation of the node and its descendants. Each line will print information about a single node: its class, followed by the value of one or more attributes. You can specify which attributes to use in a dot-separated syntax, e.g.:
dump:tag.id.class
which will result in a node printed like this:
HTML::Element tag=p id=undef class=undef
By default, if no attributes are specified, `id` is used. If the node class does not support the attribute, or if the value of the attribute is undef, then `undef` is shown.
Can be specified multiple times.
Specify action(s) to perform on matching nodes (JSON-encoded).
Shortcut for --node-action print_as_string.
--print-method M is shortcut for --node-action print_method:M.
Shortcut for --select-action=root.
See --select-action.
--select-action
Specify how we should select nodes.
"csel"
Valid values:
["csel","root"]
The default is `csel`, which will select nodes from the tree using the CSel expression. Note that the root node itself is not included. For more details on CSel expression, refer to <pm:Data::CSel>.
`root` will return a single node which is the root node.
Choose output format, e.g. json, text.
undef
Set output format to json.
When outputing as JSON, strip result envelope.
0
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]
The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
[1,2,3]
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C ppisel ppisel
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
To activate tcsh completion for this script, put:
complete ppisel 'p/*/`ppisel`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-ppisel.
Source repository is at https://github.com/perlancar/perl-App-ppisel.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-ppisel
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
Data::CSel
PPI
Other utilities that use CSel against various data: ddsel, jsonsel, orgsel, podsel, htmlsel, yamlsel.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2019 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install App::ppisel, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::ppisel
CPAN shell
perl -MCPAN -e shell install App::ppisel
For more information on module installation, please visit the detailed CPAN module installation guide.