- CONFIGURATION FILE
- COPYRIGHT AND LICENSE
critique-cpan-module-abstract - Critic CPAN module abstract
This document describes version 0.07 of critique-cpan-module-abstract (from Perl distribution CPAN-Critic-Module-Abstract), released on 2015-09-03.
% critique-cpan-module-abstract [options] <abstract>
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.
It is recommended, however, that you install shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using
shcompgen) at installation time, so you can immadiately have tab completion.
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.
It is also recommended to install
shcompgen (see above).
For fish and zsh, install
shcompgen as described above.
CRITIQUE_CPAN_MODULE_ABSTRACT_OPT => str
Specify additional command-line options
This script can read configuration file, which by default is searched at
/etc/critique-cpan-module-abstract.conf (can be changed by specifying
--config-path). All found files will be read and merged.
To disable searching for configuration files, pass
Configuration file is in the format of IOD, which is basically INI with some extra features.
You can put multiple profiles in a single file by using section names like
[profile=SOMENAME]. Those sections will only be read if you specify the matching
List of available configuration parameters:
abstract (see --abstract) format (see --format) naked_res (see --naked-res) profile (see --profile)
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.
COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by firstname.lastname@example.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.
* marks required options.
Set path to configuration file.
Can be specified multiple times.
Set configuration profile to use.
Do not use any configuration file.
Do not read environment for default options.
Choose output format, e.g. json, text.
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.:
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:
- --help, -h, -?
Display help message and exit.
- --version, -v
Display program's version and exit.