Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

perl::critic::policy::testinganddebugging::requireusewarnings(3) [centos man page]

Perl::Critic::Policy::TestingAndDebugging::RequireUseWarUsersContributed Perl DocuPerl::Critic::Policy::TestingAndDebugging::RequireUseWarnings(3)

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 take make use of things like Moose::Exporter, you can create your own modules that import the warnings pragma into the code that is "use"ing 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 perl v5.16.3 2014-06-09 Perl::Critic::Policy::TestingAndDebugging::RequireUseWarnings(3)

Check Out this Related Man Page

Perl::Critic::Policy::Modules::RequireExplicitPackage(3)User Contributed Perl DocumentatioPerl::Critic::Policy::Modules::RequireExplicitPackage(3)

NAME
Perl::Critic::Policy::Modules::RequireExplicitPackage - Always make the "package" explicit. AFFILIATION
This Policy is part of the core Perl::Critic distribution. DESCRIPTION
In general, the first statement of any Perl module or library should be a "package" statement. Otherwise, all the code that comes before the "package" statement is getting executed in the caller's package, and you have no idea who that is. Good encapsulation and common decency require your module to keep its innards to itself. There are some valid reasons for not having a "package" statement at all. But make sure you understand them before assuming that you should do it too. The maximum number of violations per document for this policy defaults to 1. CONFIGURATION
As for programs, most people understand that the default package is "main", so this Policy doesn't apply to files that begin with a perl shebang. If you want to require an explicit "package" declaration in all files, including programs, then add the following to your .perlcriticrc file [Modules::RequireExplicitPackage] exempt_scripts = 0 Some users may find it desirable to exempt the load of specific modules from this policy. For example, Perl does not support Unicode module names because of portability problems. Users who are not concerned about this and intend to use "UTF-8" module names will need to specify "use utf8;" before the package declaration. To do this, add the following to your .perlcriticrc file [Modules::RequireExplicitPackage] allow_import_of = utf8 The "allow_import_of" configuration option takes multiple module names, separated by spaces. IMPORTANT CHANGES
This policy was formerly called "ProhibitUnpackagedCode" which sounded a bit odd. If you get lots of "Cannot load policy module" errors, then you probably need to change "ProhibitUnpackagedCode" to "RequireExplicitPackage" in your .perlcriticrc file. 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. perl v5.16.3 2014-06-09 Perl::Critic::Policy::Modules::RequireExplicitPackage(3)
Man Page

Featured Tech Videos