Perinci::CmdLine::Util::Config - Utility routines related to config files
This document describes version 1.726 of Perinci::CmdLine::Util::Config (from Perl distribution Perinci-CmdLine-Util-Config), released on 2022-05-02.
Usage:
get_args_from_config(%args) -> [$status_code, $reason, $payload, \%result_meta]
config is a HoH (hashes of hashrefs) produced by reading an INI (IOD) configuration file using modules like Config::IOD::Reader.
config
Hashref argument args will be set by parameters in config, while plugins will be set by parameters in [plugin=...] sections in config. For example, with this configuration:
args
plugins
[plugin=...]
arg1=val1 arg2=val2 -special_arg1=val3 -special_arg2=val4 [plugin=DumpArgs] -event=before_validation [plugin=Foo] arg1=val1
args will become:
{ arg1=>"val1", arg2=>"val2", -special_arg1=>"val3", -special_arg2=>"val4", }
and plugins will become:
[ 'DumpArgs@before_validation' => {}, Foo => {arg1=>val}, ]
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
args => hash
common_opts => any
config => any
config_profile => any
meta => any
meta_is_normalized => any
plugins => array
r => any
subcommand_name => any
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
get_default_config_dirs() -> [$status_code, $reason, $payload, \%result_meta]
No arguments.
read_config(%args) -> [$status_code, $reason, $payload, \%result_meta]
config_dirs => any
config_filename => any
config_paths => any
hook_section => any
program_name => any
Please visit the project's homepage at https://metacpan.org/release/Perinci-CmdLine-Util-Config.
Source repository is at https://github.com/perlancar/perl-Perinci-CmdLine-Util-Config.
perlancar <perlancar@cpan.org>
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.
This software is copyright (c) 2022, 2020, 2019, 2018, 2017 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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-CmdLine-Util-Config
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.
To install Perinci::CmdLine::Util::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perinci::CmdLine::Util::Config
CPAN shell
perl -MCPAN -e shell install Perinci::CmdLine::Util::Config
For more information on module installation, please visit the detailed CPAN module installation guide.