.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Perl::Critic::Policy::Miscellanea::TextDomainUnused 3pm" .TH Perl::Critic::Policy::Miscellanea::TextDomainUnused 3pm "2021-02-28" "perl v5.32.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Perl::Critic::Policy::Miscellanea::TextDomainUnused \- check for Locale::TextDomain imported but unused .SH "DESCRIPTION" .IX Header "DESCRIPTION" This policy is part of the \f(CW\*(C`Perl::Critic::Pulp\*(C'\fR add-on. It reports when you have \f(CW\*(C`Locale::TextDomain\*(C'\fR like .PP .Vb 1 \& use Locale::TextDomain (\*(AqMyMessageDomain\*(Aq); .Ve .PP but then don't use any of its functions or variables .PP .Vb 4 \& _\|_ _\|_x _\|_n _\|_nx _\|_xn \& _\|_p _\|_px _\|_np _\|_npx \& N_\|_ N_\|_n N_\|_p N_\|_np \& %_\|_ $_\|_ .Ve .PP \&\f(CW\*(C`Locale::TextDomain\*(C'\fR is not needed when not used, but it's also not actively harmful so this policy is only low severity and under the \&\f(CW\*(C`cosmetic\*(C'\fR theme (see \*(L"\s-1POLICY THEMES\*(R"\s0 in Perl::Critic). .PP The check is good if you've got \f(CW\*(C`Locale::TextDomain\*(C'\fR as boilerplate code in most of your program, but in some modules it's unused. You can remove it entirely from non-interactive modules, or comment it out from modules which might have messages but don't yet. The best thing picked up is when your boilerplate has got into a programmatic module which shouldn't say anything at the user level. .PP The saving from removing unused \f(CW\*(C`Locale::TextDomain\*(C'\fR is modest, just some imports and a hash entry holding the \*(L"textdomain\*(R" for the package. .PP It's easy to imagine a general kind of \*(L"module imported but unused\*(R" policy check, but in practice its hard for perlcritic to know the automatic imports of every module, and quite a few modules have side-effects, so this TextDomainUnused policy just starts with one case of an unused include. .SS "Interpolated Variables" .IX Subsection "Interpolated Variables" The variables \f(CW\*(C`%_\|_\*(C'\fR and \f(CW\*(C`$_\|_\*(C'\fR are recognised in double-quote interpolated strings just by looking for a \f(CW\*(C`$_\|_\*(C'\fR somewhere in the string, eg. .PP .Vb 1 \& print "*** $_\|_{\*(AqA Message\*(Aq} ***\en"; # ok .Ve .PP It's not hard to trick the recognition with escapes, or a hash slice style, but in general taking any \f(CW\*(C`$_\|_\*(C'\fR to be a TextDomain use is close enough. (Perhaps in the future \s-1PPI\s0 will do a full parse of interpolated expressions.) .SH "SEE ALSO" .IX Header "SEE ALSO" Perl::Critic::Pulp, Perl::Critic, Locale::TextDomain, Perl::Critic::Policy::Miscellanea::TextDomainPlaceholders .SH "HOME PAGE" .IX Header "HOME PAGE" .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2019, 2021 Kevin Ryde .PP Perl-Critic-Pulp is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. .PP Perl-Critic-Pulp is distributed in the hope that it will be useful, but \&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with Perl-Critic-Pulp. If not, see .