jonasbn > Perl-Critic-Policy-logicLAB-RequireParamsValidate-0.02 > Perl::Critic::Policy::logicLAB::RequireParamsValidate

Download:
Perl-Critic-Policy-logicLAB-RequireParamsValidate-0.02.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.02   Source  

NAME ^

Perl::Critic::Policy::logicLAB::RequireParamsValidate - simple policy for enforcing use of Params::Validate

AFFILIATION ^

This policy is a policy in the Perl::Critic::logicLAB distribution. The policy is themed: logiclab.

VERSION ^

This documentation describes version 0.01.

SYNOPSIS ^

    # ok
    sub foo {
        validate(
            @_, {
                foo => 1,    # mandatory
                bar => 0,    # optional
            }
        );

        #...
    }

    # not ok
    sub bar {
        return 1;
    }

    # ok
    sub _baz {
        return 1;
    }

Invocation of policy:

    $ perlcritic --single-policy logicLAB::RequireParamsValidate lib

Explanation:

    Use Params::Validate for public facing APIs

Description:

    Parameter validation not complying with required standard

CONFIGURATION AND ENVIRONMENT ^

No special requirements or environment required.

DEPENDENCIES AND REQUIREMENTS ^

INCOMPATIBILITIES ^

This distribution has no known incompatibilities.

BUGS AND LIMITATIONS ^

There are no known bugs or limitations

TEST AND QUALITY ^

The following policies have been disabled for this distribution

See also t/perlcriticrc

TEST COVERAGE

Coverage test executed the following way, the coverage report is based on the version described in this documentation (see "VERSION").

    ./Build testcover

    ---------------------------- ------ ------ ------ ------ ------ ------ ------
    File                           stmt   bran   cond    sub    pod   time  total
    ---------------------------- ------ ------ ------ ------ ------ ------ ------
    .../RequireParamsValidate.pm  100.0  100.0   66.7  100.0  100.0  100.0   98.6
    Total                         100.0  100.0   66.7  100.0  100.0  100.0   98.6
    ---------------------------- ------ ------ ------ ------ ------ ------ ------

SEE ALSO ^

AUTHOR ^

ACKNOWLEDGEMENT ^

LICENSE AND COPYRIGHT ^

Copyright (c) 2013-2014 Jonas B. Nielsen, jonasbn. All rights reserved.

Perl::Critic::Policy::logicLAB::RequirePackageNamePattern; is released under the Artistic License 2.0

The distribution is licensed under the Artistic License 2.0, as specified by the license file included in this distribution.

syntax highlighting: