NAME

Perinci::CmdLine::Plugin::Run::DebugCompletion - Debug completion

VERSION

This document describes version 1.915 of Perinci::CmdLine::Plugin::Run::DebugCompletion (from Perl distribution Perinci-CmdLine-Lite), released on 2021-12-10.

DESCRIPTION

This plugin will make your script log tab completion information to a log file then exit instead of doing a normal run. It can be used to debug tab completion issues. An example of log line it produces:

[/path/to/your-script] [prog PROGNAME] [pid 12345] [uid 1000] COMP_LINE=<your-script > (%d char(s)) COMP_POINT=<%s>\n",

This plugin is not included by default. To activate this plugin from the command-line of bash shell:

% PERINCI_CMDLINE_PLUGINS="-Run::DebugCompletion" your-script ...

By default it logs to /tmp/pericmd-completion.log. To customize the log file location:

% PERINCI_CMDLINE_PLUGINS="-Run::DebugCompletion,log_file,/path/to/log.file" your-script ...

This plugin runs at the run event at a very high priority (1) then skips all the other run handlers (return 201 status).

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Perinci-CmdLine-Lite.

SOURCE

Source repository is at https://github.com/perlancar/perl-Perinci-CmdLine-Lite.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014 by perlancar <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.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-CmdLine-Lite

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.