The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-DocKnot-3.01
River stage zero No dependents
2 ++
/ App::DocKnot::Config

NAME

App::DocKnot::Config - Read and return DocKnot package configuration

SYNOPSIS

    use App::DocKnot::Config;
    my $reader = App::DocKnot::Config->new({ metadata => 'docs/metadata' });
    my $config = $reader->config();

REQUIREMENTS

Perl 5.24 or later and the modules File::BaseDir, File::ShareDir, JSON, and Perl6::Slurp, all of which are available from CPAN.

DESCRIPTION

This component of DocKnot reads and returns the configuration for a package. It takes as input a directory of metadata and returns the configuration information as a hash.

Additional metadata about specific licenses is loaded via File::BaseDir and therefore uses XDG paths by default. This means that license metadata is found by searching the following paths in order:

  1. $HOME/.config/docknot

  2. $XDG_CONFIG_DIRS/docknot (/etc/xdg/docknot by default)

  3. Files included in the package.

Default license metadata files are included with the App::DocKnot module and are used unless more specific configuration files exist.

CLASS METHODS

new(ARGS)

Create a new App::DocKnot::Config object. This should be used for all subsequent actions. ARGS should be a hash reference with one or more of the following keys:

metadata

The path to the directory containing metadata for a package. Default: docs/metadata relative to the current directory.

INSTANCE METHODS

config()

Load the metadata for the package and return it as a hash. The possible keys of this hash and the possible values are not yet documented.

AUTHOR

Russ Allbery <rra@cpan.org>

COPYRIGHT AND LICENSE

Copyright 2013-2019 Russ Allbery <rra@cpan.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

SEE ALSO

docknot(1)

This module is part of the App-DocKnot distribution. The current version of App::DocKnot is available from CPAN, or directly from its web site at https://www.eyrie.org/~eagle/software/docknot/.