dump-scriptx-script - Run a Getopt::Long-based script but only to dump the import arguments
This document describes version 0.002 of dump-scriptx-script (from Perl distribution App-ScriptXUtils), released on 2020-10-01.
Usage:
% dump-scriptx-script [-D] [-I=s+] [--format=name] [--json] [--lib=s+] [--libs-json=s] [--(no)naked-res] [--page-result[=program]] [--skip-detect] <filename>
This function runs a CLI script that uses ScriptX but monkey-patches beforehand so that import() will dump the import arguments and then exit. The goal is to get the import arguments without actually running the script.
ScriptX
import()
This can be used to gather information about the script and then generate documentation about it or do other things (e.g. App::shcompgen to generate a completion script for the original script).
App::shcompgen
CLI script needs to use ScriptX. This is detected currently by a simple regex. If script is not detected as using Getopt::Long, status 412 is returned.
Getopt::Long
* marks required options.
*
Path to the script.
Libraries to unshift to @INC when running script.
Can be specified multiple times.
Libraries to unshift to @INC when running script (JSON-encoded).
See --lib.
--lib
Choose output format, e.g. json, text.
Default value:
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]
Filter output through a pager.
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 dump-scriptx-script dump-scriptx-script
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 dump-scriptx-script 'p/*/`dump-scriptx-script`/'
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-ScriptXUtils.
Source repository is at https://github.com/perlancar/perl-App-ScriptXUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-ScriptXUtils
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2020, 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::ScriptXUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::ScriptXUtils
CPAN shell
perl -MCPAN -e shell install App::ScriptXUtils
For more information on module installation, please visit the detailed CPAN module installation guide.