/ 
Perl-Critic-Policy-CodeLayout-TabIndentSpaceAlign-v1.1.0
River stage one • 2 direct dependents • 2 total dependents
/ Perl::Critic::Policy::CodeLayout::TabIndentSpaceAlign

NAME

Perl::Critic::Policy::CodeLayout::TabIndentSpaceAlign - Use tabs for indenting, spaces for aligning.

VERSION

Version 1.1.0

AFFILIATION

This is a standalone policy not part of a larger PerlCritic Policies group.

DESCRIPTION

Hard tabs are a perfectly fine way to indent code for accessibility and usability purposes, allowing different users to tweak indentation settings to suit their needs and habits. However, hard tabs should not be used for formatting / aligning, as this makes the display dependent on the tab-to-space ratio of the user.

Perl/Critic/Policy/CodeLayout/ProhibitHardTabs has a setting that allows leading tabs, but this not not fully represent the paradigm where tabs are reserved for indenting and spaces for formatting/aligning. In particular, it does not prevent indenting with spaces, while this module detects and prevents it.

This Policy examines your source code, including POD, quotes, and HEREDOCs. The contents of the __DATA__ section are not examined.

CONFIGURATION

There is no configuration option available for this policy.

NOTES

Beware that Perl::Critic may report the location of the string that contains the tab, not the actual location of the tab, so you may need to do some hunting.

FUNCTIONS

supported_parameters()

Return an array with information about the parameters supported.

my @supported_parameters = $policy->supported_parameters();

default_severity()

Return the default severify for this policy.

my $default_severity = $policy->default_severity();

default_themes()

Return the default themes this policy is included in.

my $default_themes = $policy->default_themes();

applies_to()

Return the class of elements this policy applies to.

my $class = $policy->applies_to();

violates()

Check an element for violations against this policy.

my $policy->violates(
	$element,
	$document,
);

_has_violations_in_multiline_string()

Return a boolean indicating if a multiline string has violations against this policy.

my $string_has_violations = _has_violations_in_multiline_string( $string );

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/guillaumeaubert/Perl-Critic-Policy-CodeLayout-TabIndentSpaceAlign/issues. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Perl::Critic::Policy::CodeLayout::TabIndentSpaceAlign

You can also look for information at:

AUTHOR

Guillaume Aubert, <aubertg at cpan.org>.

ACKNOWLEDGEMENTS

I originally developed this project for ThinkGeek (http://www.thinkgeek.com/). Thanks for allowing me to open-source it!

COPYRIGHT & LICENSE

Copyright 2012-2017 Guillaume Aubert.

This code is free software; you can redistribute it and/or modify it under the same terms as Perl 5 itself.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE file for more details.