NAME

Perl::Critic::Policy::ValuesAndExpressions::RequireNumberSeparators - Write " 141_234_397.0145 " instead of " 141234397.0145 ".

AFFILIATION

This Policy is part of the core Perl::Critic distribution.

DESCRIPTION

Long numbers can be difficult to read. To improve legibility, Perl allows numbers to be split into groups of digits separated by underscores. This policy requires number sequences of more than three digits to be separated.

    $long_int = 123456789;   #not ok
    $long_int = 123_456_789; #ok

    $long_float = 12345678.001;   #not ok
    $long_float = 12_345_678.001; #ok

CONFIGURATION

The minimum absolute value of numbers that must contain separators can be configured via the "min_value" option. The default is 10,000; thus, all numbers >= 10,000 and <= -10,000 must have separators. For example:

    [ValuesAndExpressions::RequireNumberSeparators]
    min_value = 100000    # That's one-hundred-thousand!

NOTES

As it is currently written, this policy only works properly with decimal (base 10) numbers. And it is obviously biased toward Western notation. I'll try and address those issues in the future.

AUTHOR

Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT

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.