(caller)[1] =~ /^(?:t|xt|lib|blib)/
-and when either '.git' or '.svn' is present in the current directory (with
-the intention of only forcing extra tests on the author side) - or when '.git'
-or '.svn' is present two directories up along with 'dist.ini' (which would
-indicate we are in a 'dzil test' operation, via L<Dist::Zilla>) -
-or when the PERL_STRICTURES_EXTRA environment variable is set, in which case
+and when either C<.git> or C<.svn> is present in the current directory (with
+the intention of only forcing extra tests on the author side) - or when C<.git>
+or C<.svn> is present two directories up along with C<dist.ini> (which would
+indicate we are in a C<dzil test> operation, via L<Dist::Zilla>) -
+or when the C<PERL_STRICTURES_EXTRA> environment variable is set, in which case
use strictures 1;
no multidimensional;
no bareword::filehandles;
-Note that _EXTRA may at some point add even more tests, with only a minor
-version increase, but any changes to the effect of 'use strictures' in
+Note that C<PERL_STRICTURES_EXTRA> may at some point add even more tests, with only a minor
+version increase, but any changes to the effect of C<use strictures> in
normal mode will involve a major version bump.
If any of the extra testing modules are not present, strictures will
-complain loudly, once, via warn(), and then shut up. But you really
+complain loudly, once, via C<warn()>, and then shut up. But you really
should consider installing them, they're all great anti-footgun tools.
=head1 DESCRIPTION
I've been writing the equivalent of this module at the top of my code for
about a year now. I figured it was time to make it shorter.
-Things like the importer in 'use Moose' don't help me because they turn
+Things like the importer in C<use Moose> don't help me because they turn
warnings on but don't make them fatal - which from my point of view is
useless because I want an exception to tell me my code isn't warnings clean.
Therefore, strictures turns on additional checking, but only when it thinks
it's running in a test file in a VCS checkout - though if this causes
undesired behaviour this can be overridden by setting the
-PERL_STRICTURES_EXTRA environment variable.
+C<PERL_STRICTURES_EXTRA> environment variable.
If additional useful author side checks come to mind, I'll add them to the
-_EXTRA code path only - this will result in a minor version increase (i.e.
+C<PERL_STRICTURES_EXTRA> code path only - this will result in a minor version increase (i.e.
1.000000 to 1.001000 (1.1.0) or similar). Any fixes only to the mechanism of
this code will result in a subversion increas (i.e. 1.000000 to 1.000001
(1.0.1)).
-If the behaviour of 'use strictures' in normal mode changes in any way, that
+If the behaviour of C<use strictures> in normal mode changes in any way, that
will constitute a major version increase - and the code already checks
when its version is tested to ensure that
=head2 VERSION
-This method traps the strictures->VERSION(1) call produced by a use line
+This method traps the C<< strictures->VERSION(1) >> call produced by a use line
with a version number on it and does the version check.
=head1 EXTRA TESTING RATIONALE
-Every so often, somebody complains that they're deploying via 'git pull'
+Every so often, somebody complains that they're deploying via C<git pull>
and that they don't want strictures to enable itself in this case - and that
setting C<PERL_STRICTURES_EXTRA> to 0 isn't acceptable (additional ways to
disable extra testing would be welcome but the discussion never seems to get
time crashes which he/she then fixes, and the rest of the testing is
completely valid for all environments.
-The point of the extra testing - especially 'no indirect' - is to catch
+The point of the extra testing - especially C<no indirect> - is to catch
mistakes that newbie users won't even realise are mistakes without
help. For example,
protection as possible for newbies - who won't think about whether there's
an option to turn on or not" - so having only the environment variable
is not sufficient to achieve that (I get to explain that you need to add
-'use strict' at least once a week on freenode #perl - newbies sometimes
+C<use strict> at least once a week on freenode #perl - newbies sometimes
completely skip steps because they don't understand that that step
is important).
projects / p5sagit/strictures.git / commitdiff