Perltidy reads a perl script and writes an indented, reformatted script.
-Many users will find enough information in L<"EXAMPLES"> to get
-started. New users may benefit from the short tutorial
+Many users will find enough information in L<"EXAMPLES"> to get
+started. New users may benefit from the short tutorial
which can be found at
http://perltidy.sourceforge.net/tutorial.html
through a formatter. The default formatting tries to follow the
recommendations in perlstyle(1), but it can be controlled in detail with
numerous input parameters, which are described in L<"FORMATTING
-OPTIONS">.
+OPTIONS">.
When the B<-html> flag is given, the output is passed through an HTML
-formatter which is described in L<"HTML OPTIONS">.
+formatter which is described in L<"HTML OPTIONS">.
=head1 EXAMPLES
perltidy somefile.pl
This will produce a file F<somefile.pl.tdy> containing the script reformatted
-using the default options, which approximate the style suggested in
+using the default options, which approximate the style suggested in
perlstyle(1). The source file F<somefile.pl> is unchanged.
perltidy *.pl
Execute perltidy on file F<somefile.pl>, with 3 columns for each level of
indentation (B<-i=3>) instead of the default 4 columns. There will not be any
tabs in the reformatted script, except for any which already exist in comments,
-pod documents, quotes, and here documents. Output will be F<somefile.pl.tdy>.
+pod documents, quotes, and here documents. Output will be F<somefile.pl.tdy>.
perltidy -i=3 -et=8 somefile.pl
Execute perltidy on file F<somefile.pl> with all defaults except use "cuddled
elses" (B<-ce>) and a maximum line length of 72 columns (B<-l=72>) instead of
-the default 80 columns.
+the default 80 columns.
perltidy -g somefile.pl
Write an html snippet with only the PRE section to F<somefile.pl.html>.
This is useful when code snippets are being formatted for inclusion in a
-larger web page. No style sheet will be written in this case.
+larger web page. No style sheet will be written in this case.
perltidy -html -ss >mystyle.css
before any files are processed. As a result, it does not matter
whether flags are before or after any filenames. However, the relative
order of parameters is important, with later parameters overriding the
-values of earlier parameters.
+values of earlier parameters.
For each parameter, there is a long name and a short name. The short
names are convenient for keyboard input, while the long names are
=over 4
-=item B<-h>, B<--help>
+=item B<-h>, B<--help>
Show summary of usage and exit.
-=item B<-o>=filename, B<--outfile>=filename
+=item B<-o>=filename, B<--outfile>=filename
Name of the output file (only if a single input file is being
processed). If no output file is specified, and output is not
perltidy somefile.pl -st >somefile.new.pl
-This option may only be used if there is just a single input file.
+This option may only be used if there is just a single input file.
The default is B<-nst> or B<--nostandard-output>.
=item B<-se>, B<--standard-error-output>
Thus, you may place B<-se> in a F<.perltidyrc> and override it when
desired with B<-nse> on the command line.
-=item B<-oext>=ext, B<--output-file-extension>=ext
+=item B<-oext>=ext, B<--output-file-extension>=ext
Change the extension of the output file to be F<ext> instead of the
default F<tdy> (or F<html> in case the -B<-html> option is used).
See L<Specifying File Extensions>.
-=item B<-opath>=path, B<--output-path>=path
+=item B<-opath>=path, B<--output-path>=path
When perltidy creates a filename for an output file, by default it merely
appends an extension to the path and basename of the input file. This
Modify the input file or files in-place and save the original with the
extension F<.bak>. Any existing F<.bak> file will be deleted. See next
item for changing the default backup extension, and for eliminating the
-backup file altogether.
+backup file altogether.
A B<-b> flag will be ignored if input is from standard input or goes to
-standard output, or if the B<-html> flag is set.
+standard output, or if the B<-html> flag is set.
In particular, if you want to use both the B<-b> flag and the B<-pbp>
(--perl-best-practices) flag, then you must put a B<-nst> flag after the
B<-pbp> flag because it contains a B<-st> flag as one of its components,
which means that output will go to the standard output stream.
-=item B<-bext>=ext, B<--backup-file-extension>=ext
+=item B<-bext>=ext, B<--backup-file-extension>=ext
This parameter serves two purposes: (1) to change the extension of the backup
file to be something other than the default F<.bak>, and (2) to indicate
A backup file of the source is always written, but you can request that it
be deleted at the end of processing if there were no errors. This is risky
unless the source code is being maintained with a source code control
-system.
+system.
To indicate that the backup should be deleted include one forward slash,
B</>, in the extension. If any text remains after the slash is removed
<-bext='/backup'> F<.backup> Delete if no errors
<-bext='original/'> F<.original> Delete if no errors
-=item B<-w>, B<--warning-output>
+=item B<-w>, B<--warning-output>
Setting B<-w> causes any non-critical warning
messages to be reported as errors. These include messages
and cautions about indirect object usage. The default, B<-nw> or
B<--nowarning-output>, is not to include these warnings.
-=item B<-q>, B<--quiet>
+=item B<-q>, B<--quiet>
-Deactivate error messages (for running under an editor).
+Deactivate error messages (for running under an editor).
For example, if you use a vi-style editor, such as vim, you may execute
perltidy as a filter from within the editor using something like
any error message may mess up your screen, so be prepared to use your
"undo" key.
-=item B<-log>, B<--logfile>
+=item B<-log>, B<--logfile>
Save the F<.LOG> file, which has many useful diagnostics. Perltidy always
creates a F<.LOG> file, but by default it is deleted unless a program bug is
this flag is to assist in debugging nesting errors. The value of C<n> is
optional. If you set the flag B<-g> without the value of C<n>, it will be
taken to be 1, meaning that every line will be written to the log file. This
-can be helpful if you are looking for a brace, paren, or bracket nesting error.
+can be helpful if you are looking for a brace, paren, or bracket nesting error.
Setting B<-g> also causes the logfile to be saved, so it is not necessary to
-also include B<-log>.
+also include B<-log>.
If no B<-g> flag is given, a value of 50 will be used, meaning that at least
every 50th line will be recorded in the logfile. This helps prevent
-excessively long log files.
+excessively long log files.
Setting a negative value of C<n> is the same as not setting B<-g> at all.
-=item B<-npro> B<--noprofile>
+=item B<-npro> B<--noprofile>
Ignore any F<.perltidyrc> command file. Normally, perltidy looks first in
your current directory for a F<.perltidyrc> file of parameters. (The format
If you set the B<-npro> flag, perltidy will not look for this file.
-=item B<-pro=filename> or B<--profile=filename>
+=item B<-pro=filename> or B<--profile=filename>
To simplify testing and switching .perltidyrc files, this command may be
used to specify a configuration file which will override the default
perltidy -pro=testcfg
-would cause file F<testcfg> to be used instead of the
+would cause file F<testcfg> to be used instead of the
default F<.perltidyrc>.
A pathname begins with three dots, e.g. ".../.perltidyrc", indicates that
working upwards. This makes it easier to have multiple projects each with
their own .perltidyrc in their root directories.
-=item B<-opt>, B<--show-options>
+=item B<-opt>, B<--show-options>
-Write a list of all options used to the F<.LOG> file.
+Write a list of all options used to the F<.LOG> file.
Please see B<--dump-options> for a simpler way to do this.
-=item B<-f>, B<--force-read-binary>
+=item B<-f>, B<--force-read-binary>
Force perltidy to process binary files. To avoid producing excessive
error messages, perltidy skips files identified by the system as non-text.
However, valid perl scripts containing binary data may sometimes be identified
as non-text, and this flag forces perltidy to process them.
-=item B<-ast>, B<--assert-tidy>
+=item B<-ast>, B<--assert-tidy>
This flag asserts that the input and output code streams are identical, or in
other words that the input code is already 'tidy' according to the formatting
Note: you will not see this message if you have error messages turned off with the
-quiet flag.
-=item B<-asu>, B<--assert-untidy>
+=item B<-asu>, B<--assert-untidy>
This flag asserts that the input and output code streams are different, or in
other words that the input code is 'untidy' according to the formatting
parameters. If this is not the case, an error message noting this is produced.
This flag has no other effect on the functioning of perltidy.
-=item B<-sal=s>, B<--sub-alias-list=s>
+=item B<-sal=s>, B<--sub-alias-list=s>
This flag causes one or more words to be treated the same as if they were the keyword 'sub'. The string B<s> contains one or more alias words, separated by spaces or commas.
For example,
- perltidy -sal='method fun _sub M4'
+ perltidy -sal='method fun _sub M4'
will cause the perltidy to treate the words 'method', 'fun', '_sub' and 'M4' to be treated the same as if they were 'sub'. Note that if the alias words are separated by spaces then the string of words should be placed in quotes.
Note that several other parameters accept a list of keywords, including 'sub' (see L<Specifying Block Types>).
You do not need to include any sub aliases in these lists. Just include keyword 'sub' if you wish, and all aliases are automatically included.
+=item B<-gal=s>, B<--grep-alias-list=s>
+
+This flag allows a code block following an external 'list operator' function to be formatted as if it followed one of the builtin keywords B<grep>, B<map> or B<sort>. The string B<s> contains the names of one or more such list operators, separated by spaces or commas.
+
+By 'list operator' is meant a function which is invoked in the form
+
+ word {BLOCK} @list
+
+Perltidy tries to keep code blocks for these functions intact, since they are usually short, and does not automatically break after the closing brace since a list may follow. It also does some special handling of continuation indentation.
+
+For example, the code block arguments to functions 'My_grep' and 'My_map' can be given formatting like 'grep' with
+
+ perltidy -gal='My_grep My_map'
+
+By default, the following list operators in List::Util are automatically included:
+
+ all any first none notall reduce reductions
+
+Any operators specified with B<--grep-alias-list> are added to this list.
+The next parameter can be used to remove words from this default list.
+
+=item B<-gaxl=s>, B<--grep-alias-exclusion-list=s>
+
+The B<-gaxl=s> flag provides a method for removing any of the default list operators given above
+by listing them in the string B<s>. To remove all of the default operators use B<-gaxl='*'>.
+
=back
=head1 FORMATTING OPTIONS
L<Skipping Selected Sections of Code> for a way to avoid tidying specific
sections of code.
-=item B<-i=n>, B<--indent-columns=n>
+=item B<-i=n>, B<--indent-columns=n>
Use n columns per indentation level (default n=4).
The default maximum line length is n=80 characters. Perltidy will try
to find line break points to keep lines below this length. However, long
-quotes and side comments may cause lines to exceed this length.
+quotes and side comments may cause lines to exceed this length.
The default length of 80 comes from the past when this was the standard CRT
screen width. Many programmers prefer to increase this to something like 120.
and data structures because eventually the amount of leading whitespace used
for indicating indentation takes up most or all of the available line width,
leaving little or no space for the actual code or data. One solution is to use
-a vary long line length. Another solution is to use the B<-vmll> flag, which
+a very long line length. Another solution is to use the B<-vmll> flag, which
basically tells perltidy to ignore leading whitespace when measuring the line
-length.
+length.
To be precise, when the B<-vmll> parameter is set, the maximum line length of a
line of code will be M+L*I, where
When this flag is set, the choice of breakpoints for a block of code should be
essentially independent of its nesting depth. However, the absolute line
lengths, including leading whitespace, can still be arbitrarily large. This
-problem can be avoided by including the next parameter.
+problem can be avoided by including the next parameter.
The default is not to do this (B<-nvmll>).
structures. When the nesting depth exceeds the value B<n> the leading
whitespace will be reduced and start at a depth of 1 again. The result is that
blocks of code will shift back to the left rather than moving arbitrarily far
-to the right. This occurs cyclically to any depth.
+to the right. This occurs cyclically to any depth.
For example if one level of indentation equals 4 spaces (B<-i=4>, the default),
and one uses B<-wc=15>, then if the leading whitespace on a line exceeds about
Using tab characters will almost certainly lead to future portability
and maintenance problems, so the default and recommendation is not to
use them. For those who prefer tabs, however, there are two different
-options.
+options.
Except for possibly introducing tab indentation characters, as outlined
below, perltidy does not introduce any tab characters into your file,
=item B<-et=n>, B<--entab-leading-whitespace>
This flag causes each B<n> initial space characters to be replaced by
-one tab character.
+one tab character.
The value of the integer B<n> can be any value but can be coordinated with the
number of spaces used for intentation. For example, B<-et=4 -ci=4 -i=4> will
produce one tab for each indentation level and and one for each continuation
indentation level. You may want to coordinate the value of B<n> with what your
-display software assumes for the spacing of a tab.
+display software assumes for the spacing of a tab.
=item B<-t>, B<--tabs>
tab scheme is specified for the output stream then perltidy must guess how many
spaces correspond to each leading tab. This number of spaces B<n>
corresponding to each leading tab of the input stream may be specified with
-B<-dt=n>. The default is B<n=8>.
+B<-dt=n>. The default is B<n=8>.
This flag has no effect if a tab scheme is specified for the output stream,
because then the input stream is assumed to use the same tab scheme and
=back
-=item B<-xs>, B<--extended-syntax>
+=item B<-xs>, B<--extended-syntax>
A problem with formatting Perl code is that some modules can introduce new
syntax. This flag allows perltidy to handle certain common extensions
-to the standard syntax without complaint.
+to the standard syntax without complaint.
For example, without this flag a structure such as the following would generate
a syntax error and the braces would not be balanced:
For another method of handling extended syntax see the section L<Skipping Selected Sections of Code>.
-=item B<-io>, B<--indent-only>
+=item B<-io>, B<--indent-only>
This flag is used to deactivate all whitespace and line break changes
within non-blank lines of code.
a large script).
Setting this flag is equivalent to setting B<--freeze-newlines> and
-B<--freeze-whitespace>.
+B<--freeze-whitespace>.
If you also want to keep your existing blank lines exactly
-as they are, you can add B<--freeze-blank-lines>.
+as they are, you can add B<--freeze-blank-lines>.
With this option perltidy is still free to modify the indenting (and
outdenting) of code and comments as it normally would. If you also want to
=item B<-enc=s>, B<--character-encoding=s>
-This flag indicates the character encoding, if any, of the input data stream.
+This flag indicates if the input data stream use a character encoding.
Perltidy does not look for the encoding directives in the soure stream, such
as B<use utf8>, and instead relies on this flag to determine the encoding.
(Note that perltidy often works on snippets of code rather than complete files
so it cannot rely on B<use utf8> directives).
-The possible values for B<s> are (1) the name of an encoding recognized by the
-Encode.pm module, (2) B<none> if no encoding is used, or (3) <guess> if
-perltidy should guess.
+The possible values for B<s> are:
-For example, the value B<utf8> causes the stream to be read and written as
-UTF-8. If the input stream cannot be decoded with a specified encoding then
-processing is not done.
+ -enc=none if no encoding is used, or
+ -enc=utf8 for encoding in utf8
+ -enc=guess if perltidy should guess between these two possibilities.
The value B<none> causes the stream to be processed without special encoding
assumptions. This is appropriate for files which are written in single-byte
-character encodings such as latin-1.
+character encodings such as latin-1.
+
+The value B<utf8> causes the stream to be read and written as
+UTF-8. If the input stream cannot be decoded with this encoding then
+processing is not done.
The value B<guess> tells perltidy to guess between either utf8 encoding or no
-encoding (meaning one character per byte). The guess uses the Encode::Guess
-module and this restricted range of guesses covers the most common cases.
-Testing showed that considering any greater number of encodings as guess
-suspects is too risky.
+encoding (meaning one character per byte). The B<guess> option uses the
+Encode::Guess module which has been found to be reliable at detecting
+if a file is encoded in utf8 or not.
-The current default is B<guess>.
+The current default is B<guess>.
The abbreviations B<-utf8> or B<-UTF8> are equivalent to B<-enc=utf8>, and the
-abbreviation B<-guess> is equivalent to <-enc=guess>. So to process a file
+abbreviation B<-guess> is equivalent to B<-enc=guess>. So to process a file
named B<file.pl> which is encoded in UTF-8 you can use:
perltidy -utf8 file.pl
or
+
perltidy -guess file.pl
-To process a file in B<euc-jp> you could use
+or simply
+
+ perltidy file.pl
+
+since B<-guess> is the default.
+
+To process files with an encoding other than UTF-8, it would be necessary to
+write a short program which calls the Perl::Tidy module with some pre- and
+post-processing to handle decoding and encoding.
+
+=item B<-eos=s>, B<--encode-output-strings=s>
- perltidy -enc=euc-jp file.pl
+This flag has been added to resolve an issue involving the interface between
+Perl::Tidy and calling programs, and in particular B<Code::TidyAll (tidyall)>.
+By default Perl::Tidy returns unencoded strings to the calling
+program, but some programs expect encoded strings. Setting this flag causes
+Perl::Tidy to return encoded output strings which it decoded. For some
+background information see
+L<https://github.com/perltidy/perltidy/issues/83> and
+L<https://github.com/houseabsolute/perl-code-tidyall/issues/84>.
-A perltidy output file is unencoded if the input file is unencoded, and
-otherwise it is encoded as B<utf8>, even if the input encoding was not
-B<utf8>.
+If you only run the B<perltidy> binary this flag has no effect.
+
+If you use B<tidyall> with encoded files and encounter irregularities such as
+B<wide character> messages you should set this flag.
+
+Additional information can be found in the man pages for the B<Perl::Tidy> module.
=item B<-gcs>, B<--use-unicode-gcstring>
This flag controls whether or not perltidy may use module Unicode::GCString to
-obtain accurate display widths of wide characters. The default
+obtain accurate display widths of wide characters. The default
is B<--nouse-unicode-gcstring>.
If this flag is set, and text is encoded, perltidy will look for the module
Continuation indentation is extra indentation spaces applied when
a long line is broken. The default is n=2, illustrated here:
- my $level = # -ci=2
+ my $level = # -ci=2
( $max_index_to_go >= 0 ) ? $levels_to_go[0] : $last_output_level;
The same example, with n=0, is a little harder to read:
- my $level = # -ci=0
+ my $level = # -ci=0
( $max_index_to_go >= 0 ) ? $levels_to_go[0] : $last_output_level;
The value given to B<-ci> is also used by some commands when a small
space is required. Examples are commands for outdenting labels,
-B<-ola>, and control keywords, B<-okw>.
+B<-ola>, and control keywords, B<-okw>.
-When default values are not used, it is recommended that either
+When default values are not used, it is recommended that either
(1) the value B<n> given with B<-ci=n> be no more than about one-half of the
number of spaces assigned to a full indentation level on the B<-i=n> command, or
)
)
-=item B<-sil=n> B<--starting-indentation-level=n>
+=item B<-sil=n> B<--starting-indentation-level=n>
By default, perltidy examines the input file and tries to determine the
starting indentation level. While it is often zero, it may not be
-zero for a code snippet being sent from an editing session.
+zero for a code snippet being sent from an editing session.
To guess the starting indentation level perltidy simply assumes that
indentation scheme used to create the code snippet is the same as is being used
If the default method does not work correctly, or you want to change the
starting level, use B<-sil=n>, to force the starting level to be n.
-=item B<List indentation> using B<-lp>, B<--line-up-parentheses>
+=item B<List indentation> using B<--line-up-parentheses>, B<-lp> or B<--extended--line-up-parentheses> , B<-xlp>
+
+These flags provide an alternative indentation method for list data. The
+original flag for this is B<-lp>, but it has some limitations (explained below)
+which are avoided with the newer B<-xlp> flag. So B<-xlp> is probably the better
+choice for new work, but the B<-lp> flag is retained to minimize changes to
+existing formatting.
+If you enter both B<-lp> and B<-xlp>, then B<-xlp> will be used.
-By default, perltidy indents lists with 4 spaces, or whatever value
-is specified with B<-i=n>. Here is a small list formatted in this way:
+
+In the default indentation method perltidy indents lists with 4 spaces, or
+whatever value is specified with B<-i=n>. Here is a small list formatted in
+this way:
# perltidy (default)
@month_of_year = (
'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
);
-Use the B<-lp> flag to add extra indentation to cause the data to begin
-past the opening parentheses of a sub call or list, or opening square
-bracket of an anonymous array, or opening curly brace of an anonymous
-hash. With this option, the above list would become:
+The B<-lp> or B<-xlp> flags add extra indentation to cause the data to begin
+past the opening parentheses of a sub call or list, or opening square bracket
+of an anonymous array, or opening curly brace of an anonymous hash. With this
+option, the above list would become:
- # perltidy -lp
+ # perltidy -lp or -xlp
@month_of_year = (
'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
);
-If the available line length (see B<-l=n> ) does not permit this much
+If the available line length (see B<-l=n> ) does not permit this much
space, perltidy will use less. For alternate placement of the
closing paren, see the next section.
-This option has no effect on code BLOCKS, such as if/then/else blocks,
+These flags have no effect on code BLOCKS, such as if/then/else blocks,
which always use whatever is specified with B<-i=n>.
-In situations where perltidy does not have complete freedom to choose line
-breaks it may temporarily revert to its default indentation method. This can
-occur for example if there are blank lines, block comments, multi-line quotes,
-or side comments between the opening and closing parens, braces, or brackets.
+Some limitiations on these flags are:
-In addition, any parameter which significantly restricts the ability of
-perltidy to choose newlines will conflict with B<-lp> and will cause
-B<-lp> to be deactivated. These include B<-io>, B<-fnl>, B<-nanl>, and
-B<-ndnl>. The reason is that the B<-lp> indentation style can require
-the careful coordination of an arbitrary number of break points in
-hierarchical lists, and these flags may prevent that.
+=over 4
-The B<-lp> option may not be used together with the B<-t> tabs option.
-It may, however, be used with the B<-et=n> tab method.
+=item *
+A limitation on B<-lp>, but not B<-xlp>, occurs in situations where perltidy
+does not have complete freedom to choose line breaks. Then it may temporarily revert
+to its default indentation method. This can occur for example if there are
+blank lines, block comments, multi-line quotes, or side comments between the
+opening and closing parens, braces, or brackets. It will also occur if a
+multi-line anonymous sub occurs within a container since that will impose
+specific line breaks (such as line breaks after statements).
-=item B<-lpxl=s>, B<--line-up-parentheses-exclusion-list>
+=item *
-This is an experimental parameter; the details might change as experience
-with it is gained.
+For both the B<-lp> and B<-xlp> flags, any parameter which significantly
+restricts the ability of perltidy to choose newlines will conflict with these
+flags and will cause them to be deactivated. These include B<-io>, B<-fnl>,
+B<-nanl>, and B<-ndnl>.
-The B<-lp> indentation style works well for some types of coding but can
-produce very long lines when variables have long names and/or containers are
-very deeply nested. The B<-lpxl=s> flag is intended to help mitigate this problem by
-providing control over the containers to which the B<-lp> indentation style is
-applied. The B<-lp> flag by default is "greedy" and applies to as many
-containers as possible. This flag specifies a list of things which should
-B<not> be use B<-lp> indentation.
+=item *
-This list is a string with space-separated items. Each item consists of up to
-three pieces of information in this order: (1) an optional letter code (2) a
-required container type, and (3) an optional numeric code.
+The B<-lp> and B<-xlp> options may not be used together with the B<-t> tabs option.
+They may, however, be used with the B<-et=n> tab method
-The only required piece of information is a container type, which is one of
-'(', '[', or '{'. For example the string
+=back
- -lpxl='[ {'
+There are some potential disadvantages of this indentation method compared to
+the default method that should be noted:
-means do B<NOT> include use -lp formatting within square-bracets or braces. The only unspecified
-container is '(', so this string means that only the contents within parens will use -lp indentation.
+=over 4
-An optional numeric code may follow any of the container types to further refine the selection based
-on container contents. The numeric codes are:
+=item *
- '0' or blank: no check on contents
- '1' reject -lp unless the contents is a simple list without sublists
- '2' reject -lp unless the contents is a simple list without sublists, without
- code blocks, and without ternary operators
+The available line length can quickly be used up if variable names are
+long. This can cause deeply nested code to quickly reach the line length
+limit, and become badly formatted, much sooner than would occur with the
+default indentation method.
-For example,
+=item *
- -lpxl = '[ { (2'
+Since the indentation depends on the lengths of variable names, small
+changes in variable names can cause changes in indentation over many lines in a
+file. This means that minor name changes can produce significant file
+differences. This can be annoying and does not occur with the default
+indentation method.
-means only apply -lp to parenthesized lists which do not contain any sublists,
-code blocks or ternary expressions.
+=back
+
+Some things that can be done to minimize these problems are:
+
+=over 4
+
+=item *
+
+Increase B<--maximum-line-length=n> above the default B<n=80> characters if
+necessary.
+
+=item *
+
+If you use B<-xlp> then long side comments can limit the indentation over
+multiple lines. Consider adding the flag B<--ignore-side-comment-lengths> to
+prevent this, or minimizing the use of side comments.
+
+=item *
+
+Apply this style in a limited way. By default, it applies to all list
+containers (not just lists in parentheses). The next section describes how to
+limit this style to, for example, just function calls. The default indentation
+method will be applied elsewhere.
+
+=back
+
+=item B<-lpil=s>, B<--line-up-parentheses-inclusion-list> and B<-lpxl=s>, B<--line-up-parentheses-exclusion-list>
+
+The following discussion is written for B<-lp> but applies equally to the newer B<-xlp> version.
+By default, the B<-lp> flag applies to as many containers as possible.
+The set of containers to which the B<-lp> style applies can be reduced by
+either one of these two flags:
+
+Use B<-lpil=s> to specify the containers to which B<-lp> applies, or
-A third optional item of information which can be given for parens is an alphanumeric
+use B<-lpxl=s> to specify the containers to which B<-lp> does NOT apply.
+
+Only one of these two flags may be used. Both flags can achieve the same
+result, but the B<-lpil=s> flag is much easier to describe and use and is
+recommended. The B<-lpxl=s> flag was the original implementation and is
+only retained for backwards compatibility.
+
+This list B<s> for these parametes is a string with space-separated items.
+Each item consists of up to three pieces of information in this order: (1) an
+optional letter code (2) a required container type, and (3) an optional numeric
+code.
+
+The only required piece of information is a container type, which is one of
+'(', '[', or '{'. For example the string
+
+ -lpil='('
+
+means use -lp formatting only on lists within parentheses, not lists in square-bracets or braces.
+The same thing could alternatively be specified with
+
+ -lpxl = '[ {'
+
+which says to exclude lists within square-brackets and braces. So what remains is lists within parentheses.
+
+A second optional item of information which can be given for parentheses is an alphanumeric
letter which is used to limit the selection further depending on the type of
token immediately before the paren. The possible letters are currently 'k',
-'K', 'f', 'F', 'w', and 'W', with these meanings:
+'K', 'f', 'F', 'w', and 'W', with these meanings for matching whatever precedes an opening paren:
'k' matches if the previous nonblank token is a perl builtin keyword (such as 'if', 'while'),
'K' matches if 'k' does not, meaning that the previous token is not a keyword.
'w' matches if either 'k' or 'f' match.
'W' matches if 'w' does not.
+For example:
+
+ -lpil = 'f('
+
+means only apply -lp to function calls, and
+
+ -lpil = 'w('
+
+means only apply -lp to parenthesized lists which follow a function or a keyword.
+
+This last example could alternatively be written using the B<-lpxl=s> flag as
+
+ -lpxl = '[ { W('
+
+which says exclude B<-lp> for lists within square-brackets, braces, and parens NOT preceded by
+a keyword or function. Clearly, the B<-lpil=s> method is easier to understand.
+
+An optional numeric code may follow any of the container types to further refine the selection based
+on container contents. The numeric codes are:
+
+ '0' or blank: no check on contents is made
+ '1' exclude B<-lp> unless the contents is a simple list without sublists
+ '2' exclude B<-lp> unless the contents is a simple list without sublists, without
+ code blocks, and without ternary operators
+
For example,
- -lpxl = '[ { F(2'
+ -lpil = 'f(2'
-means only apply -lp to parenthesized lists which follow a function call and
-which do not contain any sublists, code blocks or ternary expressions. The logic
-of writing these codes is somewhat counter-intuitive because they describe what is not
-getting the -lp indentation. So the 'F' indicates that non-function calls are
-not getting -lp, or in other words that function calls are getting the -lp indentation.
+means only apply -lp to function call lists which do not contain any sublists,
+code blocks or ternary expressions.
=item B<-cti=n>, B<--closing-token-indentation>
-The B<-cti=n> flag controls the indentation of a line beginning with
+The B<-cti=n> flag controls the indentation of a line beginning with
a C<)>, C<]>, or a non-block C<}>. Such a line receives:
-cti = 0 no extra indentation (default)
If desired, this control can be applied independently to each of the
closing container token types. In fact, B<-cti=n> is merely an
-abbreviation for B<-cpi=n -csbi=n -cbi=n>, where:
+abbreviation for B<-cpi=n -csbi=n -cbi=n>, where:
B<-cpi> or B<--closing-paren-indentation> controls B<)>'s,
-B<-csbi> or B<--closing-square-bracket-indentation> controls B<]>'s,
-B<-cbi> or B<--closing-brace-indentation> controls non-block B<}>'s.
+B<-csbi> or B<--closing-square-bracket-indentation> controls B<]>'s,
+B<-cbi> or B<--closing-brace-indentation> controls non-block B<}>'s.
=item B<-icp>, B<--indent-closing-paren>
=item B<-nib>, B<--non-indenting-braces>
Normally, lines of code contained within a pair of block braces receive one
-additional level of indentation. This flag, which is enabled by default,
+additional level of indentation. This flag, which is enabled by default,
causes perltidy to look for
opening block braces which are followed by a special side comment. This special
side comment is B<#<<<> by default. If found, the code between this opening brace and its
don't want this behavior, you can use B<-nnib> to deactivate it. To make it
easy to remember, the default string is the same as the string for starting a
B<format-skipping> section. There is no confusion because in that case it is
-for a block comment rather than a side-comment.
+for a block comment rather than a side-comment.
The special side comment can be changed with the next parameter.
fixit($i);
}
-Use B<-nola> to not outdent labels.
+Use B<-nola> to not outdent labels. To control line breaks after labels see L<bal=n, --break-after-labels=n>.
=item B<Outdenting Keywords>
fixit($i);
}
-The default is not to do this.
+The default is not to do this.
=item B<Specifying Outdented Keywords:> B<-okwl=string>, B<--outdent-keyword-list=string>
When n is 0, there is always a space to the right of a '(' and to the left
of a ')'. For n=2 there is never a space. For n=1, the default, there
is a space unless the quantity within the parens is a single token, such
-as an identifier or quoted string.
+as an identifier or quoted string.
Likewise, the parameter B<-sbt=n> or B<--square-bracket-tightness=n>
controls the space within square brackets, as illustrated below.
$width = $col[ $j + $k ] - $col[ $j ]; # -sbt=0
$width = $col[ $j + $k ] - $col[$j]; # -sbt=1 (default)
- $width = $col[$j + $k] - $col[$j]; # -sbt=2
+ $width = $col[$j + $k] - $col[$j]; # -sbt=2
Curly braces which do not contain code blocks are controlled by
-the parameter B<-bt=n> or B<--brace-tightness=n>.
+the parameter B<-bt=n> or B<--brace-tightness=n>.
$obj->{ $parsed_sql->{ 'table' }[0] }; # -bt=0
$obj->{ $parsed_sql->{'table'}[0] }; # -bt=1 (default)
And finally, curly braces which contain blocks of code are controlled by the
parameter B<-bbt=n> or B<--block-brace-tightness=n> as illustrated in the
-example below.
+example below.
%bf = map { $_ => -M $_ } grep { /\.deb$/ } dirents '.'; # -bbt=0 (default)
%bf = map { $_ => -M $_ } grep {/\.deb$/} dirents '.'; # -bbt=1
The flag B<-tso> causes certain perl token sequences (secret operators)
which might be considered to be a single operator to be formatted "tightly"
-(without spaces). The operators currently modified by this flag are:
+(without spaces). The operators currently modified by this flag are:
- 0+ +0 ()x!! ~~<> ,=> =( )=
+ 0+ +0 ()x!! ~~<> ,=> =( )=
For example the sequence B<0 +>, which converts a string to a number,
would be formatted without a space: B<0+> when the B<-tso> flag is set. This
=item B<-asc>, B<--add-semicolons>
-Setting B<-asc> allows perltidy to add any missing optional semicolon at the end
+Setting B<-asc> allows perltidy to add any missing optional semicolon at the end
of a line which is followed by a closing curly brace on the next line. This
is the default, and may be deactivated with B<-nasc> or B<--noadd-semicolons>.
arise between them and all of the other rules that it uses. One
conflict that can arise is if, between two tokens, the left token wants
a space and the right one doesn't. In this case, the token not wanting
-a space takes priority.
+a space takes priority.
It is necessary to have a list of all token types in order to create
this type of input. Such a list can be obtained by the command
B<--dump-token-types>. Also try the B<-D> flag on a short snippet of code
-and look at the .DEBUG file to see the tokenization.
+and look at the .DEBUG file to see the tokenization.
B<WARNING> Be sure to put these tokens in quotes to avoid having them
misinterpreted by your command shell.
system($foo );
system($foo);
-To find if a token is of type B<Z> you can use B<perltidy -DEBUG>. For the
+To find if a token is of type B<Z> you can use B<perltidy -DEBUG>. For the
first line above the result is
1: system($foo );
When an opening paren follows a Perl keyword, no space is introduced after the
keyword, unless it is (by default) one of these:
- my local our and or xor eq ne if else elsif until unless
+ my local our and or xor eq ne if else elsif until unless
while for foreach return switch case given when
These defaults can be modified with two commands:
B<-nsak=s> or B<--nospace-after-keyword=s> removes keywords.
-where B<s> is a list of keywords (in quotes if necessary). For example,
+where B<s> is a list of keywords (in quotes if necessary). For example,
my ( $a, $b, $c ) = @_; # default
my( $a, $b, $c ) = @_; # -nsak="my local our"
B<-sfp> or B<--space-function-paren>
- myfunc( $a, $b, $c ); # default
+ myfunc( $a, $b, $c ); # default
myfunc ( $a, $b, $c ); # -sfp
You will probably also want to use the flag B<-skp> (previous item) too.
sub filename { return $0 }
In this particular case the syntax error can be removed if the line order is
-reversed, so that Perl parses 'sub filename' first.
+reversed, so that Perl parses 'sub filename' first.
=item B<-fpva> or B<--function-paren-vertical-alignment>
if elsif unless while until for foreach
-These can be changed with the parameter B<-kpitl=s> described in the next section.
+These can be changed with the parameter B<-kpitl=s> described in the next section.
=item B<-kpitl=string> or B<--keyword-paren-inner-tightness=string>
In the following example some extra space has been inserted on the second
line between the two open parens. This extra space is called "logical padding"
and is intended to help align similar things vertically in some logical
-or ternary expressions.
+or ternary expressions.
- # perltidy [default formatting]
+ # perltidy [default formatting]
$same =
( ( $aP eq $bP )
&& ( $aS eq $bS )
Here is an example involving a ternary operator:
- # perltidy [default formatting]
+ # perltidy [default formatting]
$bits =
$top > 0xffff ? 32
: $top > 0xff ? 16
=item B<-iscl>, B<--ignore-side-comment-lengths>
This parameter causes perltidy to ignore the length of side comments when
-setting line breaks. The default, B<-niscl>, is to include the length of
+setting line breaks. The default, B<-niscl>, is to include the length of
side comments when breaking lines to stay within the length prescribed
by the B<-l=n> maximum line length parameter. For example, the following
long single line would remain intact with -l=80 and -iscl:
perltidy -l=80
$vmsfile =~ s/;[\d\-]*$//
; # Clip off version number; we can use a newer version as well
-
+
=item B<-hsc>, B<--hanging-side-comments>
A comment is considered to be a hanging side comment if (1) it immediately
follows a line with a side comment, or another hanging side comment, and
(2) there is some leading whitespace on the line.
-To deactivate this feature, use B<-nhsc> or B<--nohanging-side-comments>.
+To deactivate this feature, use B<-nhsc> or B<--nohanging-side-comments>.
If block comments are preceded by a blank line, or have no leading
whitespace, they will not be mistaken as hanging side comments.
cutoff limit for adding closing side comments. This limit may be
changed with the B<-csci> command, described below.
-The command B<-dcsc> (or B<--delete-closing-side-comments>) reverses this
+The command B<-dcsc> (or B<--delete-closing-side-comments>) reverses this
process and removes these comments.
Several commands are available to modify the behavior of these two basic
=over 4
-=item B<-csci=n>, or B<--closing-side-comment-interval=n>
+=item B<-csci=n>, or B<--closing-side-comment-interval=n>
where C<n> is the minimum number of lines that a block must have in
order for a closing side comment to be added. The default value is
Now the C<if> and C<else> blocks are commented. However, now this has
become very cluttered.
-=item B<-cscp=string>, or B<--closing-side-comment-prefix=string>
+=item B<-cscp=string>, or B<--closing-side-comment-prefix=string>
where string is the prefix used before the name of the block type. The
default prefix, shown above, is C<## end>. This string will be added to
closing side comment will be placed just a single space to the right of
its closing brace.
-=item B<-cscl=string>, or B<--closing-side-comment-list>
+=item B<-cscl=string>, or B<--closing-side-comment-list>
where C<string> is a list of block types to be tagged with closing side
comments. By default, all code block types preceded by a keyword or
-cscl="sub : BEGIN END"
-=item B<-csct=n>, or B<--closing-side-comment-maximum-text=n>
+=item B<-csct=n>, or B<--closing-side-comment-maximum-text=n>
The text appended to certain block types, such as an C<if> block, is
whatever lies between the keyword introducing the block, such as C<if>,
C<n=20> caused this text to be truncated, as indicated by the C<...>. See
the next flag for additional control of the abbreviated text.
-=item B<-cscb>, or B<--closing-side-comments-balanced>
+=item B<-cscb>, or B<--closing-side-comments-balanced>
As discussed in the previous item, when the
closing-side-comment-maximum-text limit is exceeded the comment text must
The default is B<-cscb>.
-=item B<-csce=n>, or B<--closing-side-comment-else-flag=n>
+=item B<-csce=n>, or B<--closing-side-comment-else-flag=n>
The default, B<n=0>, places the text of the opening C<if> statement after any
terminal C<else>.
If B<n=1> is used, the results will be the same as B<n=2> whenever the
resulting line length is less than the maximum allowed.
-=item B<-cscb>, or B<--closing-side-comments-balanced>
+=item B<-cscb>, or B<--closing-side-comments-balanced>
When using closing-side-comments, and the closing-side-comment-maximum-text
-limit is exceeded, then the comment text must be abbreviated.
+limit is exceeded, then the comment text must be abbreviated.
It is terminated with three dots if the B<-cscb> flag is negated:
perltidy -csc -ncscb
perltidy -csc -cscb
} ## end foreach my $foo (sort { $b cmp $a ... })
-The default is B<-cscb>.
+The default is B<-cscb>.
-=item B<-cscw>, or B<--closing-side-comment-warnings>
+=item B<-cscw>, or B<--closing-side-comment-warnings>
This parameter is intended to help make the initial transition to the use of
-closing side comments.
+closing side comments.
It causes two
things to happen if a closing side comment replaces an existing, different
closing side comment: first, an error message will be issued, and second, the
original side comment will be placed alone on a new specially marked comment
-line for later attention.
+line for later attention.
The intent is to avoid clobbering existing hand-written side comments
which happen to match the pattern of closing side comments. This flag
=back
-B<Important Notes on Closing Side Comments:>
+B<Important Notes on Closing Side Comments:>
=over 4
Please note that adding or deleting of closing side comments takes
place only through the commands B<-csc> or B<-dcsc>. The other commands,
-if used, merely modify the behavior of these two commands.
+if used, merely modify the behavior of these two commands.
=item *
=item B<-sbc>, B<--static-block-comments>
When B<-sbc> is used, a block comment with a special leading pattern, C<##> by
-default, will be treated specially.
+default, will be treated specially.
-Comments so identified are treated as follows:
+Comments so identified are treated as follows:
=over 4
=item *
no new blank line will be
-inserted before such a comment, and
+inserted before such a comment, and
=item *
such a comment will never become
-a hanging side comment.
+a hanging side comment.
=back
@month_of_year = ( # -nsbc
'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
-
+
## 'Dec', 'Nov'
'Nov', 'Dec'
);
This parameter defines the prefix used to identify static block comments
when the B<-sbc> parameter is set. The default prefix is C<##>,
-corresponding to C<-sbcp=##>. The prefix is actually part of a perl
-pattern used to match lines and it must either begin with C<#> or C<^#>.
+corresponding to C<-sbcp=##>. The prefix is actually part of a perl
+pattern used to match lines and it must either begin with C<#> or C<^#>.
In the first case a prefix ^\s* will be added to match any leading
whitespace, while in the second case the pattern will match only
comments with no leading whitespace. For example, to
A pattern which can be useful is:
- -sbcp=^#{2,}[^\s#]
+ -sbcp=^#{2,}[^\s#]
This pattern requires a static block comment to have at least one character
which is neither a # nor a space. It allows a line containing only '#'
This parameter defines the prefix used to identify static side comments
when the B<-ssc> parameter is set. The default prefix is C<##>,
-corresponding to C<-sscp=##>.
+corresponding to C<-sscp=##>.
Please note that B<-sscp> merely defines the pattern used to identify
static side comments; it will not be used unless the switch B<-ssc> is
Additional text may appear on the special comment lines provided that it
is separated from the marker by at least one space, as in the above examples.
+Any number of code-skipping or format-skipping sections may appear in a file.
+If an opening code-skipping or format-skipping comment is not followed by a
+corresponding closing comment, then skipping continues to the end of the file.
+If a closing code-skipping or format-skipping comment appears in a file but
+does not follow a corresponding opening comment, then it is treated as an
+ordinary comment without any special meaning.
+
It is recommended to use B<--code-skipping> only if you need to hide a block of
an extended syntax which would produce errors if parsed by perltidy, and use
B<--format-skipping> otherwise. This is because the B<--format-skipping>
you enter must begin with a # and should be in quotes as necessary to get past
the command shell of your system. It is actually the leading text of a pattern
that is constructed by appending a '\s', so you must also include backslashes
-for characters to be taken literally rather than as patterns.
+for characters to be taken literally rather than as patterns.
Some examples show how example strings become patterns:
-fsb='#\{\{\{' becomes /^#\{\{\{\s/ which matches #{{{ but not #{{{{
-fsb='#\*\*' becomes /^#\*\*\s/ which matches #** but not #***
- -fsb='#\*{2,}' becomes /^#\*{2,}\s/ which matches #** and #*****
+ -fsb='#\*{2,}' becomes /^#\*{2,}\s/ which matches #** and #*****
=item B<-fse=string>, B<--format-skipping-end=string>
The B<-fse=string> is the corresponding parameter used to change the
ending marker for format skipping. The default is equivalent to
--fse='#<<<'.
+-fse='#<<<'.
The beginning and ending strings may be the same, but it is preferable
to make them different for clarity.
If you do not want any changes to the line breaks within
lines of code in your script, set
B<-fnl>, and they will remain fixed, and the rest of the commands in
-this section and sections
+this section and sections
L<Controlling List Formatting>,
-L<Retaining or Ignoring Existing Line Breaks>.
+L<Retaining or Ignoring Existing Line Breaks>.
You may want to use B<-noll> with this.
Note: If you also want to keep your blank lines exactly
# -ce
if ($task) {
yyy();
- } else {
+ } else {
zzz();
}
if ($task) {
yyy();
}
- else {
+ else {
zzz();
}
on the same line. Other keywords and function names which are formatted with
this "cuddled" style are B<elsif>, B<continue>, B<catch>, B<finally>.
-Other block types can be formatted by specifying their names on a
-separate parameter B<-cbl>, described in a later section.
+Other block types can be formatted by specifying their names on a
+separate parameter B<-cbl>, described in a later section.
Cuddling between a pair of code blocks requires that the closing brace of the
first block start a new line. If this block is entirely on one line in the
If there are blank lines between cuddled blocks they will be eliminated. If
there are comments after the closing brace where cuddling would occur then
cuddling will be prevented. If this occurs, cuddling will restart later in the
-chain if possible.
+chain if possible.
=item B<-cb>, B<--cuddled-blocks>
-This flag is equivalent to B<-ce>.
+This flag is equivalent to B<-ce>.
-=item B<-cbl>, B<--cuddled-block-list>
+=item B<-cbl>, B<--cuddled-block-list>
The built-in default cuddled block types are B<else, elsif, continue, catch, finally>.
or equivalently
- -cbl=sort,map,grep
+ -cbl=sort,map,grep
Note however that these particular block types are typically short so there might not be much
opportunity for the cuddled format style.
Using commas avoids the need to protect spaces with quotes.
As a diagnostic check, the flag B<--dump-cuddled-block-list> or B<-dcbl> can be
-used to view the hash of values that are generated by this flag.
+used to view the hash of values that are generated by this flag.
Finally, note that the B<-cbl> flag by itself merely specifies which blocks are formatted
with the cuddled format. It has no effect unless this formatting style is activated with
B<-ce>.
-=item B<-cblx>, B<--cuddled-block-list-exclusive>
+=item B<-cblx>, B<--cuddled-block-list-exclusive>
When cuddled else formatting is selected with B<-ce>, setting this flag causes
perltidy to ignore its built-in defaults and rely exclusively on the block types
options are:
cbo=0 Never force a short block to break.
- cbo=1 If the first of a pair of blocks is broken in the input file,
+ cbo=1 If the first of a pair of blocks is broken in the input file,
then break the second [DEFAULT].
cbo=2 Break open all blocks for maximal cuddled formatting.
The option B<cbo=2> produces maximal cuddling but will not allow any short blocks.
-=item B<-bl>, B<--opening-brace-on-new-line>
+=item B<-bl>, B<--opening-brace-on-new-line>, or B<--brace-left>
-Use the flag B<-bl> to place the opening brace on a new line:
+Use the flag B<-bl> to place an opening block brace on a new line:
- if ( $input_file eq '-' ) # -bl
- {
- important_function();
+ if ( $input_file eq '-' )
+ {
+ ...
}
-This flag applies to all structural blocks, including named sub's (unless
-the B<-sbl> flag is set -- see next item).
+By default it applies to all structural blocks except B<sort map grep eval> and
+anonymous subs.
-The default style, B<-nbl>, places an opening brace on the same line as
-the keyword introducing it. For example,
+The default is B<-nbl> which places an opening brace on the same line as
+the keyword introducing it if possible. For example,
- if ( $input_file eq '-' ) { # -nbl (default)
+ # default
+ if ( $input_file eq '-' ) {
+ ...
+ }
-=item B<-sbl>, B<--opening-sub-brace-on-new-line>
+When B<-bl> is set, the blocks to which this applies can be controlled with the
+parameters B<--brace-left-list> and B<-brace-left-exclusion-list> described in the next sections.
-The flag B<-sbl> can be used to override the value of B<-bl> for
-the opening braces of named sub's. For example,
+=item B<-bll=s>, B<--brace-left-list=s>
+
+Use this parameter to change the types of block braces for which the
+B<-bl> flag applies; see L<Specifying Block Types>. For example,
+B<-bll='if elsif else sub'> would apply it to only C<if/elsif/else>
+and named sub blocks. The default is all blocks, B<-bll='*'>.
+
+=item B<-blxl=s>, B<--brace-left-exclusion-list=s>
+
+Use this parameter to exclude types of block braces for which the
+B<-bl> flag applies; see L<Specifying Block Types>. For example,
+the default settings B<-bll='*'> and B<-blxl='sort map grep eval asub'>
+mean all blocks except B<sort map grep eval> and anonymous sub blocks.
+
+Note that the lists B<-bll=s> and B<-blxl=s> control the behavior of the
+B<-bl> flag but have no effect unless the B<-bl> flag is set.
+
+=item B<-sbl>, B<--opening-sub-brace-on-new-line>
+
+The flag B<-sbl> provides a shortcut way to turn on B<-bl> just for named
+subs. The same effect can be achieved by turning on B<-bl>
+with the block list set as B<-bll='sub'>.
+
+For example,
perltidy -sbl
}
}
-This flag is negated with B<-nsbl>. If B<-sbl> is not specified,
-the value of B<-bl> is used.
+This flag is negated with B<-nsbl>, which is the default.
-=item B<-asbl>, B<--opening-anonymous-sub-brace-on-new-line>
+=item B<-asbl>, B<--opening-anonymous-sub-brace-on-new-line>
The flag B<-asbl> is like the B<-sbl> flag except that it applies
to anonymous sub's instead of named subs. For example
This flag is negated with B<-nasbl>, and the default is B<-nasbl>.
-=item B<-bli>, B<--brace-left-and-indent>
+=item B<-bli>, B<--brace-left-and-indent>
-The flag B<-bli> is the same as B<-bl> but in addition it causes one
-unit of continuation indentation ( see B<-ci> ) to be placed before
+The flag B<-bli> is similar to the B<-bl> flag but in addition it causes one
+unit of continuation indentation ( see B<-ci> ) to be placed before
an opening and closing block braces.
-For example,
+For example, perltidy -bli gives
- if ( $input_file eq '-' ) # -bli
+ if ( $input_file eq '-' )
{
important_function();
}
-By default, this extra indentation occurs for blocks of type:
-B<if>, B<elsif>, B<else>, B<unless>, B<for>, B<foreach>, B<sub>,
-B<while>, B<until>, and also with a preceding label. The next item
-shows how to change this.
+By default, this extra indentation occurs for block types:
+B<if>, B<elsif>, B<else>, B<unless>, B<while>, B<for>, B<foreach>, B<do>, and
+also B<named subs> and blocks preceded by a B<label>. The next item shows how to
+change this.
+
+B<Note>: The B<-bli> flag is similar to the B<-bl> flag, with the difference being
+that braces get indented. But these two flags are implemented independently,
+and have different default settings for historical reasons. If desired, a
+mixture of effects can be achieved if desired by turning them both on with
+different B<-list> settings. In the event that both settings are selected for
+a certain block type, the B<-bli> style has priority.
-=item B<-blil=s>, B<--brace-left-and-indent-list=s>
+=item B<-blil=s>, B<--brace-left-and-indent-list=s>
Use this parameter to change the types of block braces for which the
-B<-bli> flag applies; see L<Specifying Block Types>. For example,
-B<-blil='if elsif else'> would apply it to only C<if/elsif/else> blocks.
+B<-bli> flag applies; see L<Specifying Block Types>.
+
+The default is B<-blil='if else elsif unless while for foreach do : sub'>.
+
+=item B<-blixl=s>, B<--brace-left-and-indent-exclusion-list=s>
+
+Use this parameter to exclude types of block braces for which the B<-bli> flag
+applies; see L<Specifying Block Types>.
-=item B<-bar>, B<--opening-brace-always-on-right>
+This might be useful in conjunction with selecting all blocks B<-blil='*'>.
+The default setting is B<-blixl=' '>, which does not exclude any blocks.
+
+Note that the two parameters B<-blil> and B<-blixl> control the behavior of
+the B<-bli> flag but have no effect unless the B<-bli> flag is set.
+
+=item B<-bar>, B<--opening-brace-always-on-right>
The default style, B<-nbl> places the opening code block brace on a new
line if it does not fit on the same line as the opening keyword, like
-bbhb=2 break if list is 'complex' (see note below)
-bbhb=3 always break
-For example,
+For example,
# perltidy -bbhb=3
$romanNumerals =
Similar flags for controlling parens and square brackets are given in the subsequent section.
-=back
+=back
=item B<-bbhbi=n>, B<--break-before-hash-brace-and-indent=n>
-bbpi=1 outdent by one continuation level
-bbpi=2 indent one full indentation level
-=item B<-wn>, B<--weld-nested-containers>
+=item B<-wn>, B<--weld-nested-containers>
The B<-wn> flag causes closely nested pairs of opening and closing container
symbols (curly braces, brackets, or parens) to be "welded" together, meaning
# default formatting
do {
{
- next if $x == $y;
+ next if $x == $y;
}
} until $x++ > $z;
sub declaration following an outer opening container symbol which is not a
code block brace, or (3) have an outer opening paren separated from the inner
opening symbol by any single non-container symbol or something that looks like
-a function evaluation, as illustrated in the next examples.
+a function evaluation, as illustrated in the next examples.
Any container symbol may serve as both the inner container of one pair and as
the outer container of an adjacent pair. Consequently, any number of adjacent
$sx * int( $xr->numify() ) & $sy * int( $yr->numify() ) ) ),
$m ) );
-This format option is quite general but there are some limitations.
+This format option is quite general but there are some limitations.
One limitation is that any line length limit still applies and can cause long
-welded sections to be broken into multiple lines.
+welded sections to be broken into multiple lines.
Another limitation is that an opening symbol which delimits quoted text cannot
be included in a welded pair. This is because quote delimiters are treated
-specially in perltidy.
+specially in perltidy.
Finally, the stacking of containers defined by this flag have priority over
any other container stacking flags. This is because any welding is done first.
-=item B<-wnxl=s>, B<--weld-nested-exclusion-list>
+=item B<-wnxl=s>, B<--weld-nested-exclusion-list>
The B<-wnxl=s> flag provides some control over the types of containers which
can be welded. The B<-wn> flag by default is "greedy" in welding adjacent
containers. If it welds more types of containers than desired, this flag
provides a capability to reduce the amount of welding by specifying a list
-of things which should B<not> be welded.
+of things which should B<not> be welded.
The logic in perltidy to apply this is straightforward. As each container
token is being considered for joining a weld, any exclusion rules are consulted
-wnxl='[ { q'
means do B<NOT> include square-bracets, braces, or quotes in any welds. The only unspecified
-container is '(', so this string means that only welds involving parens will be made.
+container is '(', so this string means that only welds involving parens will be made.
To illustrate, following welded snippet consists of a chain of three welded
containers with types '(' '[' and 'q':
For example, compare
- # perltidy -wn
+ # perltidy -wn
if ( defined( $_Cgi_Query{
$Config{'methods'}{'authentication'}{'remote'}{'cgi'}{'username'}
} ) )
Opening tokens (except for block braces) are controlled by B<-vt=n>, or
B<--vertical-tightness=n>, where
- -vt=0 always break a line after opening token (default).
- -vt=1 do not break unless this would produce more than one
+ -vt=0 always break a line after opening token (default).
+ -vt=1 do not break unless this would produce more than one
step in indentation in a line.
-vt=2 never break a line after opening token
Closing tokens (except for block braces) are controlled by B<-vtc=n>, or
B<--vertical-tightness-closing=n>, where
- -vtc=0 always break a line before a closing token (default),
- -vtc=1 do not break before a closing token which is followed
- by a semicolon or another closing token, and is not in
+ -vtc=0 always break a line before a closing token (default),
+ -vtc=1 do not break before a closing token which is followed
+ by a semicolon or another closing token, and is not in
a list environment.
-vtc=2 never break before a closing token.
-vtc=3 Like -vtc=1 except always break before a closing token
=back
-Here are some examples:
+Here are some examples:
# perltidy -lp -vt=0 -vtc=0
%romanNumerals = (
The difference between B<-vt=1> and B<-vt=2> is shown here:
- # perltidy -lp -vt=1
+ # perltidy -lp -vt=1
$init->add(
mysprintf( "(void)find_threadsv(%s);",
cstring( $threadsv_names[ $op->targ ] )
)
);
- # perltidy -lp -vt=2
+ # perltidy -lp -vt=2
$init->add( mysprintf( "(void)find_threadsv(%s);",
cstring( $threadsv_names[ $op->targ ] )
)
The B<-bbvt=n> flag is just like the B<-vt=n> flag but applies
to opening code block braces.
- -bbvt=0 break after opening block brace (default).
- -bbvt=1 do not break unless this would produce more than one
+ -bbvt=0 break after opening block brace (default).
+ -bbvt=1 do not break unless this would produce more than one
step in indentation in a line.
-bbvt=2 do not break after opening block brace.
possible values of this string, see L<Specifying Block Types>
For example, if we want to just apply this style to C<if>,
-C<elsif>, and C<else> blocks, we could use
+C<elsif>, and C<else> blocks, we could use
C<perltidy -bli -bbvt=1 -bbvtl='if elsif else'>.
There is no vertical tightness control for closing block braces; with
The flag B<-sobb> is an abbreviation for B<-bbvt=2 -bbvtl='*'>. This
will case a cascade of opening block braces to appear on a single line,
-although this an uncommon occurrence except in test scripts.
+although this an uncommon occurrence except in test scripts.
=item B<-sct>, B<--stack-closing-tokens> and related flags
-scbb or --stack-closing-block-brace
The flag B<-sct> is an abbreviation for stacking the non-block closing
-tokens, B<-scp -schb -scsb>.
+tokens, B<-scp -schb -scsb>.
Stacking of closing block braces, B<-scbb>, causes a cascade of isolated
closing block braces to be combined into a single line as in the following
By default, perltidy first deletes all old line break locations, and then it
looks for good break points to match the desired line length. Use B<-ndnl>
or B<--nodelete-old-newlines> to force perltidy to retain all old line break
-points.
+points.
=item B<-anl>, B<--add-newlines>
By default, perltidy will add line breaks when necessary to create
continuations of long lines and to improve the script appearance. Use
-B<-nanl> or B<--noadd-newlines> to prevent any new line breaks.
+B<-nanl> or B<--noadd-newlines> to prevent any new line breaks.
This flag does not prevent perltidy from eliminating existing line
breaks; see B<--freeze-newlines> to completely prevent changes to line
perltidy ever sees it.
By default, perltidy breaks B<after> these token types:
- % + - * / x != == >= <= =~ !~ < > | &
+ % + - * / x != == >= <= =~ !~ < > | &
= **= += *= &= <<= &&= -= /= |= >>= ||= //= .= %= ^= x=
And perltidy breaks B<before> these token types by default:
-wba="."
-As another example, the following command would cause a break before
+As another example, the following command would cause a break before
math operators C<'+'>, C<'-'>, C<'/'>, and C<'*'>:
-wbb="+ - / *"
The -baao sets the default to be to break after all of the following operators:
- % + - * / x != == >= <= =~ !~ < > | &
+ % + - * / x != == >= <= =~ !~ < > | &
= **= += *= &= <<= &&= -= /= |= >>= ||= //= .= %= ^= x=
. : ? && || and or err xor
except an B<=> one could use --bbao -wba='=' rather than listing every
single perl operator except B<=> on a -wbb flag.
+=item B<bal=n, --break-after-labels=n>
+
+This flag controls whether or not a line break occurs after a label. There
+are three possible valuse for B<n>:
+
+ -bal=0 break if there is a break in the input [DEFAULt]
+ -bal=1 always break after a label
+ -bal=2 never break after a label
+
+For example,
+
+ # perltidy -bal=1
+ RETURN:
+ return;
+
+ # perltidy -bal=2
+ RETURN: return;
+
=back
=head2 Controlling List Formatting
# perltidy (default)
my @list = ( 1, 1, 1, 1, 2, 1, 1, 3, 3, 1, 1, 4, 6, 4, 1, );
-This formatting loses important information. If we place a side comment on one
-of the lines, for example, we get the following result with with default formatting
-parameters:
+This formatting loses the nice structure. If we place a side comment anywhere
+between the opening and closing parens, the original line break points are
+retained. For example,
my @list = (
- 1, # a side comment, comment, or blank keeps list intact
+ 1, # a side comment forces the original line breakpoints to be kept
1, 1,
1, 2, 1,
1, 3, 3, 1,
1, 4, 6, 4, 1,
);
+The side comment can be a single hash symbol without any text.
We could achieve the same result with a blank line or full comment
-anywhere between the opening and closing parens.
+anywhere between the opening and closing parens. Vertical alignment
+of the list items will still occur if possible.
For another possibility see
the -fs flag in L<Skipping Selected Sections of Code>.
=item B<-boc>, B<--break-at-old-comma-breakpoints>
The B<-boc> flag is another way to prevent comma-separated lists from being
-reformatted. Using B<-boc> on the above example, plus additional flags to retain
+reformatted. Using B<-boc> on the above example, plus additional flags to retain
the original style, yields
# perltidy -boc -lp -pt=2 -vt=1 -vtc=1
1, 3, 3, 1,
1, 4, 6, 4, 1,);
-A disadvantage of this flag is that all tables in the file
-must already be nicely formatted.
-
+A disadvantage of this flag compared to the methods discussed above is that all
+tables in the file must already be nicely formatted.
=item B<-mft=n>, B<--maximum-fields-per-table=n>
of perltidy.
# perltidy -mft=2
- @month_of_year = (
+ @month_of_year = (
'Jan', 'Feb',
'Mar', 'Apr',
'May', 'Jun',
these commas. (However, it will have no effect if old comma breaks are
being forced because B<-boc> is used). The possible values of B<n> are:
- n=0 break at all commas after =>
+ n=0 break at all commas after =>
n=1 stable: break at all commas after => if container is open,
EXCEPT FOR one-line containers
n=2 break at all commas after =>, BUT try to form the maximum
one-line container lengths
- n=3 do not treat commas after => specially at all
+ n=3 do not treat commas after => specially at all
n=4 break everything: like n=0 but ALSO break a short container with
a => not followed by a comma when -vt=0 is used
n=5 stable: like n=1 but ALSO break at open one-line containers when
For example, given this snippet:
- return unless $cmd = $cmd || ($dot
+ return unless $cmd = $cmd || ($dot
&& $Last_Shell) || &prompt('|');
# perltidy -bol [default]
'track.id' => {-ident => 'none_search.id'},
})->as_query;
-This flag will also look for and keep a 'cuddled' style of calls,
-in which lines begin with a closing paren followed by a call arrow,
+This flag will also look for and keep a 'cuddled' style of calls,
+in which lines begin with a closing paren followed by a call arrow,
as in this example:
# perltidy -bom -wn
'track.id' => { -ident => 'none_search.id' },
} )->as_query;
-You may want to include the B<-weld-nested-containers> flag in this case to keep
+You may want to include the B<-weld-nested-containers> flag in this case to keep
nested braces and parens together, as in the last line.
=item B<-bos>, B<--break-at-old-semicolon-breakpoints>
$z = sqrt( $x**2 + $y**2 )
;
-The default is not to do this, B<-nbos>.
+The default is not to do this, B<-nbos>.
=item B<-bok>, B<--break-at-old-keyword-breakpoints>
If the attributes are on a single line in the source code then they will remain
on a single line if possible.
-To prevent this, and thereby always form longer lines, use B<-nboa>.
+To prevent this, and thereby always form longer lines, use B<-nboa>.
=item B<Keeping old breakpoints at specific token types>
-Two command line parameters provide detailed control over whether
-perltidy should keep an old line break before or after a specific
-token type:
+It is possible to override the choice of line breaks made by perltidy, and
+force it to follow certain line breaks in the input stream, with these two
+parameters:
B<-kbb=s> or B<--keep-old-breakpoints-before=s>, and
...;
};
+For the container tokens '{', '[' and '(' and, their closing counterparts, use the token symbol. Thus,
+the command to keep a break after all opening parens is:
+
+ perltidy -kba='('
+
+It is possible to be more specific in matching parentheses by preceding them
+with a letter. The possible letters are 'k', 'K', 'f', 'F', 'w', and 'W', with
+these meanings (these are the same as used in the
+B<--weld-nested-exclusion-list> and B<--line-up-parentheses-exclusion-list>
+parameters):
+
+ 'k' matches if the previous nonblank token is a perl builtin keyword (such as 'if', 'while'),
+ 'K' matches if 'k' does not, meaning that the previous token is not a keyword.
+ 'f' matches if the previous token is a function other than a keyword.
+ 'F' matches if 'f' does not.
+ 'w' matches if either 'k' or 'f' match.
+ 'W' matches if 'w' does not.
+
+So for example the the following parameter will keep breaks after opening function call
+parens:
+
+ perltidy -kba='f('
+
+B<NOTE>: To match all opening curly braces, and no other opening tokens, please
+prefix the brace it with an asterisk, like this: '*{'. Otherwise a warning
+message will occur. This is necessary to avoid problems while the input scheme
+is being updated and generalized. A single bare curly brace previously matched
+all container tokens, and tentatively still does. Likewise, to match all
+closing curly braces, and no other closing tokens, use '*}'.
+
=item B<-iob>, B<--ignore-old-breakpoints>
Use this flag to tell perltidy to ignore existing line breaks to the
maximum extent possible. This will tend to produce the longest possible
containers, regardless of type, which do not exceed the line length
-limit. But please note that this parameter has priority over all
+limit. But please note that this parameter has priority over all
other parameters requesting that certain old breakpoints be kept.
+To illustrate, consider the following input text:
+
+ has subcmds => (
+ is => 'ro',
+ default => sub { [] },
+ );
+
+The default formatting will keep the container broken, giving
+
+ # perltidy [default]
+ has subcmds => (
+ is => 'ro',
+ default => sub { [] },
+ );
+
+If old breakpoints are ignored, the list will be flattened:
+
+ # perltidy -iob
+ has subcmds => ( is => 'ro', default => sub { [] }, );
+
+Besides flattening lists, this parameter also applies to lines broken
+at certain logical breakpoints such as 'if' and 'or'.
+
+Even if this is parameter is not used globally, it provides a convenient way to
+flatten selected lists from within an editor.
+
=item B<-kis>, B<--keep-interior-semicolons>
Use the B<-kis> flag to prevent breaking at a semicolon if
dbmclose(%expanded); undef %expanded;
The statements are still subject to the specified value
-of B<maximum-line-length> and will be broken if this
+of B<maximum-line-length> and will be broken if this
maximum is exceeded.
=back
Blank lines can improve the readability of a script if they are carefully
placed. Perltidy has several commands for controlling the insertion,
-retention, and removal of blank lines.
+retention, and removal of blank lines.
=over 4
2. If the number of old blank lines in the script is less than B<n> then
additional blanks will be inserted to make the total B<n> regardless of the
-value of B<-mbl=k>.
+value of B<-mbl=k>.
3. If the number of old blank lines in the script equals or exceeds B<n> then
this parameter has no effect, however the total will not exceed
=item B<-blbp=n>, B<--blank-lines-before-packages=n>
The parameter B<-blbp=n> requests that least B<n> blank lines precede a package
-which does not follow a comment. The default is B<-blbp=1>.
+which does not follow a comment. The default is B<-blbp=1>.
This parameter interacts with the value B<k> of the parameter
B<--maximum-consecutive-blank-lines=k> (B<-mbl=k>) in the same way as described
=item B<-bbs>, B<--blanks-before-subs>
For compatibility with previous versions, B<-bbs> or B<--blanks-before-subs>
-is equivalent to F<-blbp=1> and F<-blbs=1>.
+is equivalent to F<-blbp=1> and F<-blbs=1>.
-Likewise, B<-nbbs> or B<--noblanks-before-subs>
-is equivalent to F<-blbp=0> and F<-blbs=0>.
+Likewise, B<-nbbs> or B<--noblanks-before-subs>
+is equivalent to F<-blbp=0> and F<-blbs=0>.
=item B<-bbb>, B<--blanks-before-blocks>
=item B<-lbl=n> B<--long-block-line-count=n>
-This controls how often perltidy is allowed to add blank lines before
+This controls how often perltidy is allowed to add blank lines before
certain block types (see previous section). The default is 8. Entering
a value of B<0> is equivalent to entering a very large number.
Now suppose the script continues to be developed, but at some later date we
decide we don't want these spaces after all. We might expect that running with
the flags B<-blao=0> and B<-blbc=0> will undo them. However, by default
-perltidy retains single blank lines, so the blank lines remain.
+perltidy retains single blank lines, so the blank lines remain.
We can easily fix this by telling perltidy to ignore old blank lines by
including the added parameter B<-kbl=0> and rerunning. Then the unwanted blank
ignored, perhaps even some that were added by hand to improve formatting. So
please be cautious when using these parameters.
-=item B<-mbl=n> B<--maximum-consecutive-blank-lines=n>
+=item B<-mbl=n> B<--maximum-consecutive-blank-lines=n>
This parameter specifies the maximum number of consecutive blank lines which
will be output within code sections of a script. The default is n=1. If the
with the B<-kbl=2> flag of the next section).
This flag obviously does not apply to pod sections,
-here-documents, and quotes.
+here-documents, and quotes.
=item B<-kbl=n>, B<--keep-old-blank-lines=n>
The B<-kbl=n> flag gives you control over how your existing blank lines are
-treated.
+treated.
The possible values of B<n> are:
n=1 stable: keep old blanks, but limited by the value of the B<-mbl=n> flag
n=2 keep all old blank lines, regardless of the value of the B<-mbl=n> flag
-The default is B<n=1>.
+The default is B<n=1>.
=item B<-sob>, B<--swallow-optional-blank-lines>
B<-kgbl=s> or B<--keyword-group-blanks-list=s>; B<s> is a quoted string of keywords
-B<-kgbs=s> or B<--keyword-group-blanks-size=s>; B<s> gives the number of keywords required to form a group.
+B<-kgbs=s> or B<--keyword-group-blanks-size=s>; B<s> gives the number of keywords required to form a group.
B<-kgbb=n> or B<--keyword-group-blanks-before=n>; B<n> = (0, 1, or 2) controls a leading blank
our my">, but any list of keywords may be used. Comment lines may also be included in a keyword group, even though they are not keywords. To include ordinary block comments, include the symbol B<BC>. To include static block comments (which normally begin with '##'), include the symbol B<SBC>.
B<-kgbs=s> or B<--keyword-group-blanks-size=s>, where B<s> is a string
-describing the number of consecutive keyword statements forming a group. If
-B<s> is an integer then it is the minimum number required for a group. A
-maximum value may also be given with the format B<s=min.max>, where B<min> is
-the minimum number and B<max> is the maximum number, and the min and max values
-are separated by one or more dots. No groups will be found if the maximum is
-less than the minimum. The maximum is unlimited if not given. The default is
-B<s=5>. Some examples:
+describing the number of consecutive keyword statements forming a group (Note:
+statements separated by blank lines in the input file are considered
+consecutive for purposes of this count). If B<s> is an integer then it is the
+minimum number required for a group. A maximum value may also be given with
+the format B<s=min.max>, where B<min> is the minimum number and B<max> is the
+maximum number, and the min and max values are separated by one or more dots.
+No groups will be found if the maximum is less than the minimum. The maximum
+is unlimited if not given. The default is B<s=5>. Some examples:
s min max number for group
3 3 unlimited 3 or more
1.1 1 1 1
1..3 1 3 1 to 3
1.0 1 0 (no match)
-
+
+There is no really good default value for this parameter. If it is set too
+small, then an excessive number of blank lines may be generated. However, some
+users may prefer reducing the value somewhat below the default, perhaps to
+B<s=3>.
B<-kgbb=n> or B<--keyword-group-blanks-before=n> specifies whether
a blank should appear before the first line of the group, as follows:
statements are initially scanned, any existing blank lines are included in the
collection. Any such orignial blank lines will be deleted before any other
insertions are made when the parameter B<-kgbd> is set. The default is not to
-do this, B<-nkgbd>.
+do this, B<-nkgbd>.
B<-kgbr=n> or B<--keyword-group-blanks-repeat-count=n> specifies B<n>, the
maximum number of times this logic will be applied to any file. The special
B<-kgb> or B<--keyword-group-blanks> is an abbreviation equivalent to setting
B<-kgbb=1 -kgba=1 -kgbi>. This turns on keyword group formatting with a set of
-default values.
+default values.
B<-nkgb> or B<--nokeyword-group-blanks> is equivalent to B<-kgbb=0 -kgba
nkgbi>. This flag turns off keyword group blank lines and is the default
-setting.
+setting.
-Here are a few notes about the functioning of this technique.
+Here are a few notes about the functioning of this technique.
=over 4
input controls or code validity. For example, a blank line will not be placed
within a here-doc or within a section of code marked with format skipping
comments. And in general, a blank line will only be introduced at the end of a
-group if the next statement is a line of code.
+group if the next statement is a line of code.
=item *
-lp -bl -noll -pt=2 -bt=2 -sbt=2 -icp
+To use this style with B<-xlp> instead of B<-lp> use B<-gnu -xlp>.
+
=item B<-pbp>, B<--perl-best-practices>
B<-pbp> is an abbreviation for the parameters in the book B<Perl Best Practices>
by Damian Conway:
-l=78 -i=4 -ci=4 -st -se -vt=2 -cti=0 -pt=1 -bt=1 -sbt=1 -bbt=1 -nsfs -nolq
- -wbb="% + - * / x != == >= <= =~ !~ < > | & =
+ -wbb="% + - * / x != == >= <= =~ !~ < > | & =
**= += *= &= <<= &&= -= /= |= >>= ||= //= .= %= ^= x="
Please note that this parameter set includes -st and -se flags, which make
perltidy act as a filter on one file only. These can be overridden by placing
-B<-nst> and/or B<-nse> after the -pbp parameter.
+B<-nst> and/or B<-nse> after the -pbp parameter.
Also note that the value of continuation indentation, -ci=4, is equal to the
value of the full indentation, -i=4. It is recommended that the either (1) the
There are a few points to note regarding one-line blocks. A one-line
block is something like this,
+ if ( -e $file ) { print "'$file' exists\n" }
where the contents within the curly braces is short enough to fit
on a single line.
If an existing one-line block is longer than the maximum line length,
however, it will be broken into multiple lines. When this happens, perltidy
checks for and adds any optional terminating semicolon (unless the B<-nasc>
-option is used) if the block is a code block.
+option is used) if the block is a code block.
The main exception is that perltidy will attempt to form new one-line
blocks following the keywords C<map>, C<eval>, and C<sort>, because
Sometimes it might be desirable to convert a script to have one-line blocks
whenever possible. Although there is currently no flag for this, a simple
workaround is to execute perltidy twice, once with the flag B<-noadd-newlines>
-and then once again with normal parameters, like this:
+and then once again with normal parameters, like this:
cat infile | perltidy -nanl | perltidy >outfile
This flag controls the placement of semicolons at the end of one-line blocks.
Semicolons are optional before a closing block brace, and frequently they are
omitted at the end of a one-line block containing just a single statement.
-By default, perltidy follows the input file regarding these semicolons,
+By default, perltidy follows the input file regarding these semicolons,
but this behavior can be controlled by this flag. The values of n are:
n=0 remove terminal semicolons in one-line blocks having a single statement
}
If the parameter B<-olbn=1> is given, then the line will be left intact if it
-is a single line in the source, or it will be broken into multiple lines if it
+is a single line in the source, or it will be broken into multiple lines if it
is broken in multiple lines in the source.
aligned in the following statement:
$data = $pkg->new(
- PeerAddr => join( ".", @port[ 0 .. 3 ] ),
+ PeerAddr => join( ".", @port[ 0 .. 3 ] ),
PeerPort => $port[4] * 256 + $port[5],
Proto => 'tcp'
);
-Vertical alignment can be completely turned off using B<-novalign>, a flag
-mainly intended for debugging. However, vertical alignment can be forced to
+Vertical alignment can be completely turned off using the B<-novalign> flag
+mentioned below. However, vertical alignment can be forced to
stop and restart by selectively introducing blank lines. For example, a blank
has been inserted in the following code to keep somewhat similar things
aligned.
existing controls then vertical alignment cannot occur. Likewise, if a space is
added with one of the controls, then vertical alignment might occur.
-For example,
+For example,
# perltidy -nwls='=>'
$data = $pkg->new(
Proto=> 'tcp'
);
+=over 4
+
+=item B<Completely turning off vertical alignment with -novalign>
+
+The default is to use vertical alignment, but bertical alignment can be
+completely turned of with the B<-novalign> flag.
+
+A lower level of control of vertical alignment is possible with three parameters
+B<-vc>, B<-vsc>, and B<-vbc>. These independently control alignment
+of code, side comments and block comments. They are described in the
+next section.
+
+The parameter B<-valign> is in fact an alias for B<-vc -vsc -vbc>, and its
+negative B<-novalign> is an alias for B<-nvc -nvsc -nvbc>.
+
+=item B<Controlling code alignment with --valign-code or -vc>
+
+The B<-vc> flag enables alignment of code symbols such as B<=>. The default is B<-vc>.
+For detailed control of which symbols to align, see the B<-valign-exclude-list> parameter
+below.
+
+=item B<Controlling side comment alignment with --valign-side-comments or -vsc>
+
+The B<-vsc> flag enables alignment of side comments and is enabled by default. If side
+comment aligment is disabled with B<-nvsc> they will appear at a fixed space from the
+preceding code token. The default is B<-vsc>
+
+=item B<Controlling block comment alignment with --valign-block-comments or -vbc>
+
+When B<-vbc> is enabled, block comments can become aligned for example if one
+comment of a consecutive sequence of comments becomes outdented due a length in
+excess of the maximum line length. If this occurs, the entire group of
+comments will remain aligned and be outdented by the same amount. This coordinated
+alignment will not occur if B<-nvbc> is set. The default is B<-vbc>.
+
+=item B<Finer alignment control with --valign-exclusion-list=s or -vxl=s and --valign-inclusion-list=s or -vil=s>
+
+More detailed control of alignment types is available with these two
+parameters. Most of the vertical alignments in typical programs occur at one
+of the tokens ',', '=', and '=>', but many other alignments are possible and are given in the following list:
+
+ = **= += *= &= <<= &&= -= /= |= >>= ||= //= .= %= ^= x=
+ { ( ? : , ; => && || ~~ !~~ =~ !~ // <=> ->
+ if unless and or err for foreach while until
+
+These alignments are all enabled by default, but they can be selectively disabled by including one or more of these tokens in the space-separated list B<valign-exclusion-list=s>.
+For example, the following would prevent alignment at B<=> and B<if>:
+
+ --valign-exclusion-list='= if'
+
+If it is simpler to specify only the token types which are to be aligned, then
+include the types which are to be aligned in the list of B<--valign-inclusion-list>.
+You may leave the B<valign-exclusion-list> undefined, or use the special symbol B<*> for the exclusion list.
+For example, the following parameters enable alignment only at commas and 'fat commas':
+
+ --valign-inclusion-list=', =>'
+ --valign-exclusion-list='*' ( this is optional and may be omitted )
+
+These parameter lists should consist of space-separated tokens from the above
+list of possible alignment tokens, or a '*'. If an unrecognized token
+appears, it is simply ignored. And if a specific token is entered in both lists by
+mistake then the exclusion list has priority.
+
+The default values of these parameters enable all alignments and are equivalent to
+
+ --valign-exclusion-list=' '
+ --valign-inclusion-list='*'
+
+To illustrate, consider the following snippet with default formatting
+
+ # perltidy
+ $co_description = ($color) ? 'bold cyan' : ''; # description
+ $co_prompt = ($color) ? 'bold green' : ''; # prompt
+ $co_unused = ($color) ? 'on_green' : 'reverse'; # unused
+
+To exclude all alignments except the equals (i.e., include only equals) we could use:
+
+ # perltidy -vil='='
+ $co_description = ($color) ? 'bold cyan' : ''; # description
+ $co_prompt = ($color) ? 'bold green' : ''; # prompt
+ $co_unused = ($color) ? 'on_green' : 'reverse'; # unused
+
+To exclude only the equals we could use:
+
+ # perltidy -vxl='='
+ $co_description = ($color) ? 'bold cyan' : ''; # description
+ $co_prompt = ($color) ? 'bold green' : ''; # prompt
+ $co_unused = ($color) ? 'on_green' : 'reverse'; # unused
+
+Notice in this last example that although only the equals alignment was
+excluded, the ternary alignments were also lost. This happens because the
+vertical aligner sweeps from left-to-right and usually stops if an important
+alignment cannot be made for some reason.
+
+But also notice that side comments remain aligned because their alignment is
+controlled separately with the parameter B<--valign-side_comments> described above.
+
+=back
+
=head2 Other Controls
=over 4
When perltidy writes a formatted text file, it has the ability to also
send selected text to a file with a F<.TEE> extension. This text can
-include comments and pod documentation.
+include comments and pod documentation.
The command B<-tac> or B<--tee-all-comments> will write all comments
B<and> all pod documentation.
B<--tee-block-comments> and B<-tsc> or B<--tee-side-comments>.
(Hanging side comments will be written with side comments here.)
-The negatives of these commands also work, and are the defaults.
+The negatives of these commands also work, and are the defaults.
=item B<Using a F<.perltidyrc> command file>
create a F<.perltidyrc> file to avoid typing commonly-used parameters.
Perltidy will first look in your current directory for a command file
named F<.perltidyrc>. If it does not find one, it will continue looking
-for one in other standard locations.
+for one in other standard locations.
These other locations are system-dependent, and may be displayed with
the command C<perltidy -dpro>. Under Unix systems, it will first look
-sbt=0 # square brackets not tight
The parameters in the F<.perltidyrc> file are installed first, so any
-parameters given on the command line will have priority over them.
+parameters given on the command line will have priority over them.
To avoid confusion, perltidy ignores any command in the .perltidyrc
file which would cause some kind of dump and an exit. These are:
-h -v -ddf -dln -dop -dsn -dtt -dwls -dwrs -ss
There are several options may be helpful in debugging a F<.perltidyrc>
-file:
+file:
=over 4
=item *
A very helpful command is B<--dump-profile> or B<-dpro>. It writes a
-list of all configuration filenames tested to standard output, and
+list of all configuration filenames tested to standard output, and
if a file is found, it dumps the content to standard output before
exiting. So, to find out where perltidy looks for its configuration
-files, and which one if any it selects, just enter
+files, and which one if any it selects, just enter
perltidy -dpro
=item *
-The parameters in the F<.perltidyrc> file can be switched off with
+The parameters in the F<.perltidyrc> file can be switched off with
the B<-npro> option.
=item *
perltidy --oneliner ...
-(Either C<-oneliner> or C<--oneliner> may be used).
+(Either C<-oneliner> or C<--oneliner> may be used).
=item Skipping leading non-perl commands with B<-x> or B<--look-for-hash-bang>
B<--dump-defaults> or B<-ddf> will write the default option set to standard output and quit
-B<--dump-profile> or B<-dpro> will write the name of the current
+B<--dump-profile> or B<-dpro> will write the name of the current
configuration file and its contents to standard output and quit.
B<--dump-options> or B<-dop> will write current option set to standard
-output and quit.
+output and quit.
-B<--dump-long-names> or B<-dln> will write all command line long names (passed
+B<--dump-long-names> or B<-dln> will write all command line long names (passed
to Get_options) to standard output and quit.
-B<--dump-short-names> or B<-dsn> will write all command line short names
+B<--dump-short-names> or B<-dsn> will write all command line short names
to standard output and quit.
-B<--dump-token-types> or B<-dtt> will write a list of all token types
+B<--dump-token-types> or B<-dtt> will write a list of all token types
to standard output and quit.
B<--dump-want-left-space> or B<-dwls> will write the hash %want_left_space
around tokens.
B<--no-memoize> or B<-nmem> will turn of memoizing.
-Memoization can reduce run time when running perltidy repeatedly in a
+Memoization can reduce run time when running perltidy repeatedly in a
single process. It is on by default but can be deactivated for
testing with B<-nmem>.
B<--file-size-order> or B<-fso> will cause files to be processed in order of
increasing size, when multiple files are being processed. This is useful
during program development, when large numbers of files with varying sizes are
-processed, because it can reduce virtual memory usage.
+processed, because it can reduce virtual memory usage.
B<--maximum-file-size-mb=n> or B<-maxfs=n> specifies the maximum file size in
megabytes that perltidy will attempt to format. This parameter is provided to
perltidy -maxfs=20
-This only applies to files specified by filename on the command line.
+This only applies to files specified by filename on the command line.
B<--maximum-level-errors=n> or B<-maxle=n> specifies the maximum number of
indentation level errors are allowed before perltidy skips formatting and just
B<--maximum-unexpected-errors=n> or B<-maxue=n> specifies the maximum number of
unexpected tokenization errors are allowed before formatting is skipped and a
-script is output verbatim. The intention is to avoid accidentally formatting
+script is output verbatim. The intention is to avoid accidentally formatting
a non-perl script, such as an html file for example. This check can be turned
off by setting B<n=0>.
A recommended value is B<n=3>. However, the default is B<n=0> (skip this check)
-to avoid causing problems with scripts which have extended syntaxes.
+to avoid causing problems with scripts which have extended syntaxes.
-B<-DEBUG> will write a file with extension F<.DEBUG> for each input file
+B<-DEBUG> will write a file with extension F<.DEBUG> for each input file
showing the tokenization of all lines of code.
=item B<Working with MakeMaker, AutoLoader and SelfLoader>
The first $VERSION line of a file which might be eval'd by MakeMaker
-is passed through unchanged except for indentation.
+is passed through unchanged except for indentation.
Use B<--nopass-version-line>, or B<-npvl>, to deactivate this feature.
If the AutoLoader module is used, perltidy will continue formatting
B<Please Note>: In this case, perltidy does not do any formatting to the
input file, and it does not write a formatted file with extension
F<.tdy>. This means that two perltidy runs are required to create a
-fully reformatted, html copy of a script.
+fully reformatted, html copy of a script.
=item The B<-pre> flag for code snippets
pod2html, and this prefix will be removed before they are passed to
pod2html. The flags which have the additional C<pod> prefix are:
- --[no]podheader --[no]podindex --[no]podrecurse --[no]podquiet
+ --[no]podheader --[no]podindex --[no]podrecurse --[no]podquiet
--[no]podverbose --podflush
The flags which are unchanged from their use in pod2html are:
--backlink=s --cachedir=s --htmlroot=s --libpods=s --title=s
- --podpath=s --podroot=s
+ --podpath=s --podroot=s
where 's' is an appropriate character string. Not all of these flags are
available in older versions of Pod::Html. See your Pod::Html documentation for
B<-hcx=n>, where B<xxxxxx> is one of the following words, and B<x> is the
corresponding abbreviation:
- Token Type xxxxxx x
+ Token Type xxxxxx x
---------- -------- --
comment comment c
number numeric n
pod text pod-text pd
A default set of colors has been defined, but they may be changed by providing
-values to any of the following parameters, where B<n> is either a 6 digit
+values to any of the following parameters, where B<n> is either a 6 digit
hex RGB color value or an ascii name for a color, such as 'red'.
-To illustrate, the following command will produce an html
+To illustrate, the following command will produce an html
file F<somefile.pl.html> with "aqua" keywords:
perltidy -html -hck=00ffff somefile.pl
Many more names are supported in specific browsers, but it is safest
to use the hex codes for other colors. Helpful color tables can be
-located with an internet search for "HTML color tables".
+located with an internet search for "HTML color tables".
Besides color, two other character attributes may be set: bold, and italics.
To set a token type to use bold, use the flag
B<--html-bold-xxxxxx> or B<-hbx>, where B<xxxxxx> or B<x> are the long
-or short names from the above table. Conversely, to set a token type to
+or short names from the above table. Conversely, to set a token type to
NOT use bold, use B<--nohtml-bold-xxxxxx> or B<-nhbx>.
Likewise, to set a token type to use an italic font, use the flag
a leading '.' should be used. If the extension C<ext> begins with
C<A-Z>, C<a-z>, or C<0-9>, then it will be appended to the filename with
an intermediate '.' (or perhaps a '_' on VMS systems). Otherwise, it
-will be appended directly.
+will be appended directly.
For example, suppose the file is F<somefile.pl>. For C<-bext=old>, a '.' is
added to give F<somefile.pl.old>. For C<-bext=.old>, no additional '.' is
added, so again the backup file is F<somefile.pl.old>. For C<-bext=~>, then no
-dot is added, and the backup file will be F<somefile.pl~> .
+dot is added, and the backup file will be F<somefile.pl~> .
=head1 SWITCHES WHICH MAY BE NEGATED
baao bar bbao bbb bbc bbs bl bli boa boc
bok bol bom bos bot cblx ce conv cs csc
cscb cscw dac dbc dcbl dcsc ddf dln dnl dop
- dp dpro dsc dsm dsn dtt dwls dwrs dws f
- fll fpva frm fs fso gcs hbc hbcm hbco hbh
- hbhh hbi hbj hbk hbm hbn hbp hbpd hbpu hbq
- hbs hbsc hbv hbw hent hic hicm hico hih hihh
- hii hij hik him hin hip hipd hipu hiq his
- hisc hiv hiw hsc html ibc icb icp iob isbc
- iscl kgb kgbd kgbi kis lal log lop lp lsl
- mem nib ohbr okw ola olc oll olq opr opt
- osbc osbr otr ple pod pvl q sac sbc sbl
- scbb schb scp scsb sct se sfp sfs skp sob
- sobb sohb sop sosb sot ssc st sts t tac
- tbc toc tp tqw trp ts tsc tso vmll w
- wn x xci xs
+ dp dpro dsc dsm dsn dtt dwls dwrs dws eos
+ f fll fpva frm fs fso gcs hbc hbcm hbco
+ hbh hbhh hbi hbj hbk hbm hbn hbp hbpd hbpu
+ hbq hbs hbsc hbv hbw hent hic hicm hico hih
+ hihh hii hij hik him hin hip hipd hipu hiq
+ his hisc hiv hiw hsc html ibc icb icp iob
+ isbc iscl kgb kgbd kgbi kis lal log lop lp
+ lsl mem nib ohbr okw ola olc oll olq opr
+ opt osbc osbr otr ple pod pvl q sac sbc
+ sbl scbb schb scp scsb sct se sfp sfs skp
+ sob sobb sohb sop sosb sot ssc st sts t
+ tac tbc toc tp tqw trp ts tsc tso vbc
+ vc vmll vsc w wn x xci xlp xs
Equivalently, the prefix 'no' or 'no-' on the corresponding long names may be
used.
=item B<What perltidy does not parse and format>
-Perltidy indents but does not reformat comments and C<qw> quotes.
+Perltidy indents but does not reformat comments and C<qw> quotes.
Perltidy does not in any way modify the contents of here documents or
quoted text, even if they contain source code. (You could, however,
reformat them separately). Perltidy does not format 'format' sections
When standard input is used, the log file, if saved, is F<perltidy.LOG>,
and any errors are written to F<perltidy.ERR> unless the B<-se> flag is
-set. These are saved in the current working directory.
+set. These are saved in the current working directory.
=item B<Files overwritten>
A exit value of 0 indicates that perltidy ran to completion with no error messages.
-A non-zero exit value indicates some kind of problem was detected.
+A non-zero exit value indicates some kind of problem was detected.
An exit value of 1 indicates that perltidy terminated prematurely, usually due
to some kind of errors in the input parameters. This can happen for example if
=head1 VERSION
-This man page documents perltidy version 20210717
+This man page documents perltidy version 20220217
=head1 BUG REPORTS
A list of current bugs and issues can be found at the CPAN site L<https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Tidy>
-To report a new bug or problem, use the link on this page.
+To report a new bug or problem, use the link on this page.
The source code repository is at L<https://github.com/perltidy/perltidy>.
=head1 COPYRIGHT
-Copyright (c) 2000-2021 by Steve Hancock
+Copyright (c) 2000-2022 by Steve Hancock
=head1 LICENSE
projects / perltidy.git / blobdiff