File Coverage

blib/lib/Perl/Critic/Policy/Community/WarningsSwitch.pm

Criterion	Covered	Total	%
statement	26	27	96.3
branch	4	4	100.0
condition	2	3	66.6
subroutine	10	11	90.9
pod	4	5	80.0
total	46	50	92.0

package Perl::Critic::Policy::Community::WarningsSwitch;

use strict;
use warnings;

use Perl::Critic::Utils qw(:severities :classification :ppi);
use parent 'Perl::Critic::Policy';

our $VERSION = 'v1.0.2';

use constant DESC => 'Using -w switch';
use constant EXPL => 'Don\'t use -w (or -W), it\'s too eager. use warnings; instead.';

sub supported_parameters { () }
sub default_severity { $SEVERITY_LOW }
sub default_themes { 'community' }
sub applies_to { 'PPI::Document' }

sub violates {
	my ($self, $elem) = @_;
	my $shebang = $elem->first_token;
	return () unless $shebang->isa('PPI::Token::Comment') and $shebang->content =~ m/^#!/;

	return $self->violation(DESC, EXPL, $elem) if $shebang->content =~ m/\h-[a-zA-Z]*[wW]/;

	return ();
}

1;

=head1 NAME

Perl::Critic::Policy::Community::WarningsSwitch - Scripts should not use the -w
switch on the shebang line

=head1 DESCRIPTION

The C<-w> switch enables warnings globally in a perl program, including for any
modules that did not explicitly enable or disable any warnings. The C<-W>
switch enables warnings even for modules that explicitly disabled them. The
primary issue with this is enabling warnings for code that you did not write.
Some of these modules may not be designed to run with warnings enabled, but
still work fine. Instead, use L<warnings> within your own code only.

  #!/usr/bin/perl -w # not ok
  #!/usr/bin/perl -W # not ok
  use warnings;      # ok

=head1 AFFILIATION

This policy is part of L<Perl::Critic::Community>.

=head1 CONFIGURATION

This policy is not configurable except for the standard options.

=head1 AUTHOR

Dan Book, C<[e-mail]>

=head1 COPYRIGHT AND LICENSE

Copyright 2015, Dan Book.

This library is free software; you may redistribute it and/or modify it under
the terms of the Artistic License version 2.0.

=head1 SEE ALSO

L<Perl::Critic>, L<warnings>