Grinnz / Perl-Critic-Community

Perl::Critic::Community - Community-inspired Perl::Critic policies
https://metacpan.org/pod/Perl::Critic::Community
Other
8 stars 10 forks source link

=pod

=head1 NAME

Perl::Critic::Community - Community-inspired Perl::Critic policies

=head1 SYNOPSIS

$ perlcritic --theme community script.pl $ perlcritic --theme community lib/

.perlcriticrc

theme = community severity = 1

=head1 DESCRIPTION

A set of L policies to enforce the practices generally recommended by subsets of the Perl community, particularly on L<IRC|perlcommunity/IRC>. Formerly known as L. Because this policy "theme" is designed to be used with zero configuration on the command line, some duplication will occur if it is used in combination with core L policies.

=head1 AFFILIATION

This module has no functionality, but instead contains documentation for this distribution and acts as a means of pulling other modules into a bundle. All of the Policy modules contained herein will have an "AFFILIATION" section announcing their participation in this grouping.

=head1 POLICIES

=over

=item L

Don't use C<&> to call subroutines

=item L

Don't assign an anonymous arrayref to an array

=item L

Don't use bareword filehandles other than built-ins

=item L

Don't declare variables conditionally

=item L

Don't end a subroutine with a conditional block

=item L

Avoid features that have been deprecated or removed from Perl

=item L

Various modules discouraged from use

=item L

Don't use C<$a> or C<$b> as variable names outside C<sort()>

=item L

Don't use C<each()> to iterate through a hash

=item L

Don't use C with no arguments

=item L

Don't call methods indirectly

=item L

Don't use undeclared foreach loop iterators

=item L

Don't loop over hashes

=item L

Don't use C to write web applications

=item L

Don't use multidimensional array emulation

=item L

Always use the three-argument form of C<open()>

=item L

Don't use L without specifying a bool overload and enabling fallback

=item L

Module files should declare a package matching the filename

=item L

Don't use L without specifying an import list

=item L

Various modules with preferred alternatives

=item L

Don't use function prototypes

=item L

Always use L and L, or a module that imports these

=item L

Interpreter-based threads are officially discouraged

=item L

Don't write context-sensitive functions using C<wantarray()>

=item L

Scripts should not use the C<-w> switch on the shebang line

=item L

Don't use C with implicit assignment to C<$_>

=back

=head1 CONFIGURATION AND ENVIRONMENT

All policies included are in the "community" theme. See the L documentation for how to make use of this.

=head1 AUTHOR

Dan Book, Cdbook@cpan.org

=head1 CONTRIBUTORS

=over

=item Graham Knop (haarg)

=item H.Merijn Brand (Tux)

=item John SJ Anderson (genehack)

=item Matt S Trout (mst)

=item William Taylor (willt)

=back

=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

=cut