Andy Lester > Perl-Critic-1.121_01 > Perl::Critic::Policy::TestingAndDebugging::RequireUseWarnings

Download:
Perl-Critic-1.121_01.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.121_01   Source  

NAME ^

Perl::Critic::Policy::TestingAndDebugging::RequireUseWarnings - Always use warnings.

AFFILIATION ^

This Policy is part of the core Perl::Critic distribution.

DESCRIPTION ^

Using warnings, and paying attention to what they say, is probably the single most effective way to improve the quality of your code. This policy requires that the 'use warnings' statement must come before any other statements except package, require, and other use statements. Thus, all the code in the entire package will be affected.

There are special exemptions for Moose, Moose::Role, and Moose::Util::TypeConstraints because they enforces warnings; e.g. 'use Moose' is treated as equivalent to 'use warnings'.

This policy will not complain if the file explicitly states that it is compatible with a version of perl prior to 5.6 via an include statement, e.g. by having require 5.005 in it.

The maximum number of violations per document for this policy defaults to 1.

CONFIGURATION ^

If you make use of things like Moose::Exporter, you can create your own modules that import the warnings pragma into the code that is useing them. There is an option to add to the default set of pragmata and modules in your .perlcriticrc: equivalent_modules.

    [TestingAndDebugging::RequireUseWarnings]
    equivalent_modules = MooseX::My::Sugar

BUGS ^

Needs to check for -w on the shebang line.

SEE ALSO ^

Perl::Critic::Policy::TestingAndDebugging::ProhibitNoWarnings

AUTHOR ^

Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT ^

Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module

syntax highlighting: