critique-cpan-module-abstract - critique-cpan-module-abstract
This document describes version 0.05 of critique-cpan-module-abstract (from Perl distribution CPAN-Critic-Module-Abstract), released on 2014-12-05.
Usage:
% critique-cpan-module-abstract [options] <abstract>
* marks required options.
*
Set path to configuration file.
Can be specified multiple times.
Set configuration profile to use.
Set output format.
Show help message.
Set output format to json.
When outputing as JSON, strip result envelope.
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:
[1,2,3]
In this case, you can use `--naked-res`.
Do not use any configuration file.
Default value:
"default"
Show program version.
/etc/critique-cpan-module-abstract.conf
~/critique-cpan-module-abstract.conf
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C critique-cpan-module-abstract critique-cpan-module-abstract
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.
~/.bashrc
You can also install App::BashCompletionProg which makes it easy to add completion for Perinci::CmdLine-based scripts. After you install the module and put . ~/.bash-complete-prog (or . /etc/bash-complete-prog), you can just run bash-completion-prog and the complete command will be added to your ~/.bash-completion-prog. Your next shell session will then recognize tab completion for the command.
. ~/.bash-complete-prog
. /etc/bash-complete-prog
bash-completion-prog
complete
~/.bash-completion-prog
To activate fish completion for this script, execute:
begin; set -lx COMP_SHELL fish; set -lx COMP_MODE gen_command; critique-cpan-module-abstract; end > $HOME/.config/fish/completions/critique-cpan-module-abstract.fish
Or if you want to install globally, you can instead write the generated script to /etc/fish/completions/critique-cpan-module-abstract.fish or /usr/share/fish/completions/critique-cpan-module-abstract.fish. The exact path might be different on your system. Please check your fish_complete_path variable.
/etc/fish/completions/critique-cpan-module-abstract.fish
/usr/share/fish/completions/critique-cpan-module-abstract.fish
fish_complete_path
To activate tcsh completion for this script, put:
complete critique-cpan-module-abstract 'p/*/`critique-cpan-module-abstract`/'
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.
~/.tcshrc
To activate zsh completion for this script, put:
_critique_cpan_module_abstract() { read -l; local cl="$REPLY"; read -ln; local cp="$REPLY"; reply=(`COMP_SHELL=zsh COMP_LINE="$cl" COMP_POINT="$cp" critique-cpan-module-abstract`) } compctl -K _critique_cpan_module_abstract critique-cpan-module-abstract
in your zsh startup (e.g. ~/.zshrc). 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.
~/.zshrc
Please visit the project's homepage at https://metacpan.org/release/CPAN-Critic-Module-Abstract.
Source repository is at https://github.com/perlancar/perl-CPAN-Critic-Module-Abstract.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=CPAN-Critic-Module-Abstract
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) 2014 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 CPAN::Critic::Module::Abstract, copy and paste the appropriate command in to your terminal.
cpanm
cpanm CPAN::Critic::Module::Abstract
CPAN shell
perl -MCPAN -e shell install CPAN::Critic::Module::Abstract
For more information on module installation, please visit the detailed CPAN module installation guide.