Preferred bug tracker

Please visit the preferred bug tracker to report your issue.

This queue is for tickets about the Perl-Critic CPAN distribution.

Report information
The Basics
Id:
79951
Status:
rejected
Priority:
Low/Low
Queue:

People
Owner:
Nobody in particular
Requestors:
IXA [...] cpan.org
Cc:
AdminCc:

BugTracker
Severity:
(no value)
Broken in:
(no value)
Fixed in:
(no value)



Subject: New policy: CodeLayout::ProhibitSpaceIndentation
Here's a policy to prohibit indentation with spaces, for projects that use hard tabs. I am aware of the fact there is a contradicting CodeLayout::ProhibitHardTabs, but still think it has value. Attached are the code and the .run test, modeled after the other tests in Perl::Critic distribution.
Subject: ProhibitSpaceIndentation.run

Message body not shown because it is not plain text.

Subject: ProhibitSpaceIndentation.pm
package Perl::Critic::Policy::CodeLayout::ProhibitSpaceIndentation; use strict; use warnings; use Readonly; our $VERSION = '1.00'; use Perl::Critic::Utils qw{ :booleans :severities }; use base qw(Perl::Critic::Policy); Readonly::Scalar my $DESC => q{Spaces used for indentation}; # Match possibly some blank lines, then indentation with at least one space # (possibly among tabs). Readonly::Scalar my $SPACE_INDENT_REGEX => qr/^(\n*)\t* +\t*/; sub supported_parameters { return (); } sub default_severity { return $SEVERITY_LOW; } sub default_themes { return qw(cosmetic); } sub applies_to { return 'PPI::Token'; } sub violates { my ($self, $elem, undef) = @_; # Only a violation at line start if ($elem->location->[1] == 1 && $elem =~ $SPACE_INDENT_REGEX) { return $self->violation($DESC, undef, $elem); } else { return; } } 1; __END__ =head1 NAME Perl::Critic::Policy::CodeLayout::ProhibitSpaceIndentation - Use tabs instead of spaces. =head1 DESCRIPTION For projects which have a policy of using tabs for indentation, you want to ensure there are no spaces used for that purpose. This Policy catches all such occurrences so that you can be sure when the tab sizes are reconfigured, spaces won't make indented code look wrong. This policy can be used together with L<Perl::Critic::Policy::CodeLayout::ProhibitHardTabs|CodeLayout::ProhibitHardTabs> by setting C<allow_leading_tabs> option of the latter to C<1>. Putting hard tabs in your source code (or POD) is one of the worst things you can do to your co-workers and colleagues, especially if those tabs are anywhere other than a leading position. Because various applications and devices represent tabs differently, they can cause you code to look vastly different to other people. Any decent editor can be configured to expand tabs into spaces. L<Perl::Tidy|Perl::Tidy> also does this for you. This Policy catches all tabs in your source code, including POD, quotes, and HEREDOCs. The contents of the C<__DATA__> section are not examined. =head1 CONFIGURATION This Policy is not configurable except for the standard options. =head1 NOTES If there are blank lines before a violating line, the first blank line will be reported as the violation location, because all the whitespace forms a single token which Perl::Critic gives to the policy. =head1 AUTHOR Infoxchange Australia <devs@infoxchange.net.au> =head1 COPYRIGHT Copyright (c) 2012 Infoxchange Australia. 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. =cut
Subject: Re: [rt.cpan.org #79951] New policy: CodeLayout::ProhibitSpaceIndentation
Date: Mon, 01 Oct 2012 21:12:29 -0500
To: bug-Perl-Critic@rt.cpan.org
From: Elliot Shank <elliotjs@cpan.org>
On 10/1/12 7:28 PM, Infoxchange Australia via RT wrote:
Show quoted text
> I am aware of the fact there is a contradicting > CodeLayout::ProhibitHardTabs, but still think it has value.
I agree this is useful, but I don't think shipping contradictory policies in the core distribution is a good idea. Maybe P-C-More?
There is also https://metacpan.org/release/Perl-Critic-Policy-CodeLayout-TabIndentSpaceAlign But I agree with Elliot. All the Policies that ship with the Perl::Critic core must be self-consistent. That is, it should be possible to comply with all of them at the same time using the default configuration. This is a fine Policy, and I'm happy to see alternate points of view. But I'm afraid this can't go into the core. So I recommend that you release this in your own distribution and I'll gladly add a reference to your dist in the Perl::Critic docs. If you can't release it yourself for some reason, then we can adopt it into Perl-Critic-More. -- Jeffrey Thalhammer Imaginative Software Systems www.imaginative-software.com
Uploaded independently. Just wanted to check with you before doing that.


This service runs on Request Tracker, is sponsored by The Perl Foundation, and maintained by Best Practical Solutions.

Please report any issues with rt.cpan.org to rt-cpan-admin@bestpractical.com.