5 - No significant bugs have been found since the last release but users
6 of programs which call the Perl::Tidy module should note the first
7 item below, which changes a default setting. The main change to
8 existing formatting is the second item below, which adds vertical
9 alignment to 'use' statements.
11 - The flag --encode-output-strings, or -eos, is now set 'on' by default.
12 This has no effect on the use of the 'perltidy' binary script, but could
13 change the behavior of some programs which use the Perl::Tidy module on
14 files encoded in UTF-8. If any problems are noticed, an emergency fix
15 can be made by reverting to the old default by setting -neos. For
16 an explanation of why this change needs to be made see:
18 https://github.com/perltidy/perltidy/issues/92
20 https://github.com/perltidy/perltidy/blob/master/docs/eos_flag.md
22 - Added vertical alignment for qw quotes and empty parens in 'use'
23 statements (see issue #git 93). This new alignment is 'on' by default
24 and will change formatting as shown below. If this is not wanted it can
25 be turned off with the parameter -vxl='q' (--valign-exclude-list='q').
27 # old default, or -vxl='q'
28 use Getopt::Long qw(GetOptions);
29 use Fcntl qw(O_RDONLY O_WRONLY O_EXCL O_CREAT);
30 use Symbol qw(gensym);
34 use Getopt::Long qw(GetOptions);
35 use Fcntl qw(O_RDONLY O_WRONLY O_EXCL O_CREAT);
36 use Symbol qw(gensym);
39 - The parameter -kbb (--keep-break-before) now ignores a request to break
40 before an opening token, such as '('. Likewise, -kba (--keep-break-after)
41 now ignores a request to break after a closing token, such as ')'. This
42 change was made to avoid a rare instability discovered in random testing.
44 - Previously, if a -dsc command was used to delete all side comments,
45 then any special side comments for controlling non-indenting braces got
46 deleted too. Now, these control side comments are retained when -dsc is
47 set unless a -nnib (--nonon-indenting-braces) flag is also set to
50 - This version runs about 10 percent faster on large files than the previous
51 release due to optimizations made with the help of Devel::NYTProf. Much
52 of the gain came from faster processing of blank tokens and comments.
54 - This version of perltidy was stress-tested for many cpu hours with
55 random input parameters. No failures to converge, internal fault checks,
56 undefined variable references or other irregularities were seen.
60 - A new flag, --encode-output-strings, or -eos, has been added to resolve
61 issue git #83. This issue involves the interface between Perl::Tidy and
62 calling programs, and Code::TidyAll (tidyall) in particular. The problem
63 is that perltidy by default returns decoded character strings, but
64 tidyall expects encoded strings. This flag provides a fix for that.
66 So, tidyall users who process encoded (utf8) files should update to this
67 version of Perl::Tidy and use -eos for tidyall. For further info see:
69 https://github.com/houseabsolute/perl-code-tidyall/issues/84, and
70 https://github.com/perltidy/perltidy/issues/83
72 If there are other applications having utf8 problems at the interface
73 with Perl::Tidy, this flag probably may need to be set.
75 - The default value of the new flag, --encode-output-strings, -eos, is currently
76 -neos BUT THIS MAY CHANGE in a future release because the current
77 default is inconvenient. So authors of programs which receive character
78 strings back from Perl::Tidy should set this flag, if necessary,
79 to avoid any problems when the default changes. For more information see the
80 above links and the Perl::Tidy man pages for example coding.
82 - The possible values of the string 's' for the flag '--character-encoding=s'
83 have been limited to 'utf8' (or UTF-8), 'none', or 'guess'. Previously an
84 arbitrary encoding could also be specified, but as a result of discussions
85 regarding git #83 it became clear that this could cause trouble
86 since the output encoding was still restricted to UTF-8. Users
87 who need to work in other encodings can write a short program calling
88 Perl::Tidy with pre- and post-processing to handle encoding/decoding.
90 - A new flag --break-after-labels=i, or -bal=i, was added for git #86. This
91 controls line breaks after labels, to provide a uniform style, as follows:
93 -bal=0 follows the input line breaks [DEFAULT]
94 -bal=1 always break after a label
95 -bal=2 never break after a label
110 - Fix issue git #82, an error handling something like ${bareword} in a
111 possible indirect object location. Perl allows this, now perltidy does too.
113 - The flags -kbb=s or --keep-old-breakpoints-before=s, and its counterpart
114 -kba=s or --keep-old-breakpoints-after=s have expanded functionality
115 for the container tokens: { [ ( } ] ). The updated man pages have
118 - Two new flags have been added to provide finer vertical alignment control,
119 --valign-exclusion-list=s (-vxl=s) and --valign-inclusion-list=s (-vil=s).
120 This has been requested several times, most recently in git #79, and it
121 finally got done. For example, -vil='=>' means just align on '=>'.
123 - A new flag -gal=s, --grep-alias-list=s, has been added as suggested in
124 git #77. This allows code blocks passed to list operator functions to
125 be formatted in the same way as a code block passed to grep, map, or sort.
126 By default, the following list operators in List::Util are included:
128 all any first none notall reduce reductions
130 They can be changed with the flag -gaxl=s, -grep-alias-exclusion-list=s
132 - A new flag -xlp has been added which can be set to avoid most of the
133 limitations of the -lp flag regarding side comments, blank lines, and
134 code blocks. See the man pages for more info. This fixes git #64 and git #74.
135 The older -lp flag still works.
137 - A new flag -lpil=s, --line-up-parentheses-inclusion-list=s, has been added
138 as an alternative to -lpxl=s, --line-up-parentheses-exclusion-list=s.
139 It supplies equivalent information but is much easier to describe and use.
140 It works for both the older -lp version and the newer -xlp.
142 - The coding for the older -lp flag has been updated to avoid some problems
143 and limitations. The new coding allows the -lp indentation style to
144 mix smoothly with the standard indentation in a single file. Some problems
145 where -lp and -xci flags were not working well together have been fixed, such
146 as happened in issue rt140025. As a result of these updates some minor
147 changes in existing code using the -lp style may occur.
149 - This version of perltidy was stress-tested for many cpu hours with
150 random input parameters. No failures to converge, internal fault checks,
151 undefined variable references or other irregularities were seen.
153 - Numerous minor fixes have been made, mostly very rare formatting
154 instabilities found in random testing.
158 - No significant bugs have been found since the last release, but several
159 minor issues have been fixed. Vertical alignment has been improved for
160 lists of call args which are not contained within parens (next item).
162 - Vertical alignment of function calls without parens has been improved with
163 the goal of making vertical alignment essentially the same with or
164 without parens around the call args. Some examples:
167 mkTextConfig $c, $x, $y, -anchor => 'se', $color;
168 mkTextConfig $c, $x + 30, $y, -anchor => 's', $color;
169 mkTextConfig $c, $x + 60, $y, -anchor => 'sw', $color;
170 mkTextConfig $c, $x, $y + 30, -anchor => 'e', $color;
173 mkTextConfig $c, $x, $y, -anchor => 'se', $color;
174 mkTextConfig $c, $x + 30, $y, -anchor => 's', $color;
175 mkTextConfig $c, $x + 60, $y, -anchor => 'sw', $color;
176 mkTextConfig $c, $x, $y + 30, -anchor => 'e', $color;
179 is id_2obj($id), undef, "unregistered object not retrieved";
180 is scalar keys %$ob_reg, 0, "object registry empty";
181 is register($obj), $obj, "object returned by register";
182 is scalar keys %$ob_reg, 1, "object registry nonempty";
183 is id_2obj($id), $obj, "registered object retrieved";
186 is id_2obj($id), undef, "unregistered object not retrieved";
187 is scalar keys %$ob_reg, 0, "object registry empty";
188 is register($obj), $obj, "object returned by register";
189 is scalar keys %$ob_reg, 1, "object registry nonempty";
190 is id_2obj($id), $obj, "registered object retrieved";
192 This will cause some changes in alignment, hopefully for the better,
193 particularly in test code which often uses numerous parenless function
194 calls with functions like 'ok', 'is', 'is_deeply', ....
196 - Two new parameters were added to control the block types to which the
197 -bl (--opening-brace-on-new-line) flag applies. The new parameters are
198 -block-left-list=s, or -bll=s, and --block-left-exclusion-list=s,
199 or -blxl=s. Previously the -bl flag was 'hardwired' to apply to
200 nearly all blocks. The default values of the new parameters
201 retain the the old default behavior but allow it to be changed.
203 - The default behavior of the -bli (-brace-left-and-indent) flag has changed
204 slightly. Previously, if you set -bli, then the -bl flag would also
205 automatically be set. Consequently, block types which were not included
206 in the default list for -bli would get -bl formatting. This is no longer done,
207 and these two styles are now controlled independently. The manual describes
208 the controls. If you want to recover the exact previous default behavior of
209 the -bli then add the -bl flag.
211 - A partial fix was made for issue for git #74. The -lp formatting style was
212 being lost when a one-line anonymous sub was followed by a closing brace.
214 - Fixed issue git #73, in which the -nfpva flag was not working correctly.
215 Some unwanted vertical alignments of spaced function perens
218 - Updated the man pages to clarify the flags -valign and -novalign
219 for turning vertical alignment on and off (issue git #72).
220 Added parameters -vc -vsc -vbc for separately turning off vertical
221 alignment of code, side comments and block comments.
223 - Fixed issue git #68, where a blank line following a closing code-skipping
224 comment, '#>>V', could be lost.
226 - This version runs 10 to 15 percent faster on large files than the
227 previous release due to optimizations made with the help of NYTProf.
229 - This version of perltidy was stress-tested for many cpu hours with
230 random input parameters. No instabilities, internal fault checks,
231 undefined variable references or other irregularities were seen.
233 - Numerous minor fixes have been made, mostly very rare formatting instabilities
234 found in random testing. An effort has been made to minimize changes to
235 existing formatting that these fixes produce, but occasional changes
236 may occur. Many of these updates are listed at:
238 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
242 - This release is being made mainly because of the next item, in which an
243 error message about an uninitialized value error message could be produced
244 in certain cases when format-skipping is used. The error message was
245 annoying but harmless to formatting.
247 - Fixed an undefined variable message, see git #67. When a format skipping
248 comment '#<<' is placed before the first line of code in a script, a
249 message 'Use of uninitialized value $Ktoken_vars in numeric ...' can
252 - A warning will no longer be given if a script has an opening code-skipping
253 comment '#<<V' which is not terminated with a closing comment '#>>V'. This
254 makes code-skipping and format-skipping behave in a similar way: an
255 opening comment without a corresponding closing comment will cause
256 the rest of a file to be skipped. If there is a question about which lines
257 are skipped, a .LOG file can be produced with the -g flag and it will have
260 - Removed the limit on -ci=n when -xci is set, reference: rt #136415.
261 This update removes a limit in the previous two versions in which the
262 value of -ci=n was limited to the value of -i=n when -xci was set.
263 This limit had been placed to avoid some formatting instabilities,
264 but recent coding improvements allow the limit to be removed.
266 - The -wn and -bbxx=n flags were not working together correctly. This has
269 - This version may produce occasional differences in formatting compared to
270 previous versions, mainly for lines which are near the specified line
271 length limit. This is due to ongoing efforts to eliminate edge cases of
272 formatting instability.
274 - Numerous minor fixes have been made. A complete list is at:
276 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
280 - This release adds several new requested parameters. No significant bugs have
281 been found since the last release, but a number of minor problems have been
284 - Added a new option '--code-skipping', requested in git #65, in which code
285 between comment lines '#<<V' and '#>>V' is passed verbatim to the output
286 stream without error checking. It is simmilar to --format-skipping
287 but there is no error checking of the skipped code. This can be useful for
288 skipping past code which employs an extended syntax.
290 - Added a new option for closing paren placement, -vtc=3, requested in rt #136417.
292 - Added flag -atnl, --add-terminal-newline, to help issue git #58.
293 This flag tells perltidy to terminate the last line of the output stream
294 with a newline character, regardless of whether or not the input stream
295 was terminated with a newline character. This is the default.
296 If this flag is negated, with -natnl, then perltidy will add a terminal
297 newline character to the the output stream only if the input
298 stream is terminated with a newline.
300 - Some nested structures formatted with the -lp indentation option may have
301 some changes in indentation. This is due to updates which were made to
302 prevent formatting instability when line lengths are limited by the maximum line
303 length. Most scripts will not be affected. If this causes unwanted formatting
304 changes, try increasing the --maximum-line-length by a few characters.
306 - Numerous minor fixes have been made. A complete list is at:
308 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
312 - This release fixes several non-critical bugs which have been found since the last
313 release. An effort has been made to keep existing formatting unchanged.
315 - Fixed issue git #57 regarding uninitialized warning flag.
317 - Added experimental flag -lpxl=s requested in issue git #56 to provide some
318 control over which containers get -lp indentation.
320 - Fixed issue git #55 regarding lack of coordination of the --break-before-xxx
321 flags and the --line-up-parens flag.
323 - Fixed issue git #54 regarding irregular application of the --break-before-paren
324 and similar --break-before-xxx flags, in which lists without commas were not
325 being formatted according to these flags.
327 - Fixed issue git #53. A flag was added to turn off alignment of spaced function
328 parens. If the --space-function-paren, -sfp flag is set, a side-effect is that the
329 spaced function parens may get vertically aligned. This can be undesirable,
330 so a new parameter '--function-paren-vertical-alignment', or '-fpva', has been
331 added to turn this vertical alignment off. The default is '-fpva', so that
332 existing formatting is not changed. Use '-nfpva' to turn off unwanted
333 vertical alignment. To illustrate the possibilities:
336 myfun( $aaa, $b, $cc );
337 mylongfun( $a, $b, $c );
340 myfun ( $aaa, $b, $cc );
341 mylongfun ( $a, $b, $c );
343 # perltidy -sfp -nfpva
344 myfun ( $aaa, $b, $cc );
345 mylongfun ( $a, $b, $c );
347 - Fixed issue git #51, a closing qw bare paren was not being outdented when
348 the -nodelete-old-newlines flag was set.
350 - Fixed numerous edge cases involving unusual parameter combinations which
351 could cause alternating output states. Most scripts will not be
352 changed by these fixes.
354 - A more complete list of updates is at
356 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
360 - Fixed issue git #49, -se breaks warnings exit status behavior.
361 The exit status flag was not always being set when the -se flag was set.
363 - Some improvements have been made in the method for aligning side comments.
364 One of the problems that was fixed is that there was a tendency for side comment
365 placement to drift to the right in long scripts. Programs with side comments
366 may have a few changes.
368 - Some improvements have been made in formatting qw quoted lists. This
369 fixes issue git #51, in which closing qw pattern delimiters not always
370 following the settings specified by the --closing-token-indentation=n settings.
371 Now qw closing delimiters ')', '}' and ']' follow these flags, and the
372 delimiter '>' follows the flag for ')'. Other qw pattern delimiters remain
373 indented as the are now. This change will cause some small formatting changes
374 in some existing programs.
376 - Another change involving qw lists is that they get full indentation,
377 rather than just continuation indentation, if
379 (1) the closing delimiter is one of } ) ] > and is on a separate line,
380 (2) the opening delimiter (i.e. 'qw{' ) is also on a separate line, and
381 (3) the -xci flag (--extended-continuation-indentation) is set.
383 This improves formatting when qw lists are contained in other lists. For example,
388 AntiqueWhite3 Bisque1 Bisque2 Bisque3 Bisque4
389 SlateBlue3 RoyalBlue1 SteelBlue2 DeepSkyBlue3
392 LightBlue1 DarkSlateGray1 Aquamarine2 DarkSeaGreen2
393 SeaGreen1 Yellow1 IndianRed1 IndianRed2 Tan1 Tan4
400 AntiqueWhite3 Bisque1 Bisque2 Bisque3 Bisque4
401 SlateBlue3 RoyalBlue1 SteelBlue2 DeepSkyBlue3
404 LightBlue1 DarkSlateGray1 Aquamarine2 DarkSeaGreen2
405 SeaGreen1 Yellow1 IndianRed1 IndianRed2 Tan1 Tan4
409 - Some minor improvements have been made to the rules for formatting
410 some edge vertical alignment cases, usually involving two dissimilar lines.
412 - A more complete list of updates is at
414 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
418 - Fixed issue git #47, incorrect welding of anonymous subs.
419 An incorrect weld format was being made when the --weld-nested-containers option
420 (-wn) was used in to format a function which returns a list of anonymous subs.
421 For example, the following snippet was incorrectly being welded.
424 sub { $all->resolve(@_); () },
426 $results->[$i] = [@_];
427 $all->reject(@$results) if --$remaining <= 0;
432 This was due to an error introduced in v20201201 related to parsing sub
433 signatures. Reformatting with the current version will fix the problem.
437 - This release is being made primarily to make available a several new formatting
438 parameters, in particular -xci, -kbb=s, -kba=s, and -wnxl=s. No significant
439 bugs have been found since the previous release, but numerous minor issues have
440 been found and fixed as listed below.
442 - This version is about 20% faster than the previous version due to optimizations
443 made with the help of Devel::NYTProf.
445 - Added flag -wnxl=s, --weld-nested-exclusion-list=s, to provide control which containers
446 are welded with the --weld-nested-containers parameter. This is related to issue git #45.
448 - Merged pull request git #46 which fixes the docs regarding the -fse flag.
450 - Fixed issue git #45, -vtc=n flag was ignored when -wn was set.
452 - implement request RT #133649, delete-old-newlines selectively. Two parameters,
454 -kbb=s or --keep-old-breakpoints-before=s, and
455 -kba=s or --keep-old-breakpoints-after=s
457 were added to request that old breakpoints be kept before or after
458 selected token types. For example, -kbb='=>' means that newlines before
459 fat commas should be kept.
461 - Fix git #44, fix exit status for assert-tidy/untidy. The exit status was
462 always 0 for --assert-tidy if the user had turned off all error messages with
463 the -quiet flag. This has been fixed.
465 - Add flag -maxfs=n, --maximum-file-size-mb=n. This parameter is provided to
466 avoid causing system problems by accidentally attempting to format an
467 extremely large data file. The default is n=10. The command to increase
468 the limit to 20 MB for example would be -mfs=20. This only applies to
469 files specified by filename on the command line.
471 - Skip formatting if there are too many indentation level errors. This is
472 controlled with -maxle=n, --maximum-level-errors=n. This means that if
473 the ending indentation differs from the starting indentation by more than
474 n levels, the file will be output verbatim. The default is n=1.
475 To skip this check, set n=-1 or set n to a large number.
477 - A related new flag, --maximum-unexpected-errors=n, or -maxue=n, is available
478 but is off by default.
480 - Add flag -xci, --extended-continuation-indentation, regarding issue git #28
481 This flag causes continuation indentation to "extend" deeper into structures.
482 Since this is a fairly new flag, the default is -nxci to avoid disturbing
483 existing formatting. BUT you will probably see some improved formatting
484 in complex data structures by setting this flag if you currently use -ci=n
485 and -i=n with the same value of 'n' (as is the case if you use -pbp,
486 --perl-best-practices, where n=4).
488 - Fix issue git #42, clarify how --break-at-old-logical-breakpoints works.
489 The man page was updated to note that it does not cause all logical breakpoints
490 to be replicated in the output file.
492 - Fix issue git #41, typo in manual regarding -fsb.
494 - Fix issue git #40: when using the -bli option, a closing brace followed by
495 a semicolon was not being indented. This applies to braces which require
496 semicolons, such as a 'do' block.
498 - Added 'state' as a keyword.
500 - A better test for convergence has been added. When iterations are requested,
501 the new test will stop after the first pass if no changes in line break
502 locations are made. Previously, file checksums were used and required at least two
503 passes to verify convergence unless no formatting changes were made. With the new test,
504 only a single pass is needed when formatting changes are limited to adjustments of
505 indentation and whitespace on the lines of code. Extensive testing has been made to
506 verify the correctness of the new convergence test.
508 - Line breaks are now automatically placed after 'use overload' to
509 improve formatting when there are numerous overloaded operators. For
516 - A number of minor problems with parsing signatures and prototypes have
517 been corrected, particularly multi-line signatures. Some signatures
518 had previously been parsed as if they were prototypes, which meant the
519 normal spacing rules were not applied. For example
522 sub echo ($message= 'Hello World!' ) {
527 sub echo ( $message = 'Hello World!' ) {
531 - Numerous minor issues that the average user would not encounter were found
532 and fixed. They can be seen in the more complete list of updates at
534 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
538 - Robustness of perltidy has been significantly improved. Updating is recommended. Continual
539 automated testing runs began about 1 Sep 2020 and numerous issues have been found and fixed.
540 Many involve references to uninitialized variables when perltidy is fed random text and random
543 - Added the token '->' to the list of alignment tokens, as suggested in git
544 #39, so that it can be vertically aligned if a space is placed before them with -wls='->'.
546 - Added parameters -bbhb=n (--break-before-hash-brace=n), -bbsb=n (--break-before-square-bracket=n),
547 and -bbp=n (--break-before-paren=n) suggested in git #38. These provide control over the
548 opening container token of a multiple-line list. Related new parameters -bbhbi=n, -bbsbi=n, -bbpi=n
549 control indentation of these tokens.
551 - Added keyword 'isa'.
555 - Fixed bug git #37, an error when the combination -scbb -csc was used.
556 It occurs in perltidy versions 20200110, 20200619, and 20200822. What happens is
557 that when two consecutive lines with isolated closing braces had new side
558 comments generated by the -csc parameter, a separating newline was missing.
559 The resulting script will not then run, but worse, if it is reformatted with
560 the same parameters then closing side comments could be overwritten and data
563 This problem was found during automated random testing. The parameter
564 -scbb is rarely used, which is probably why this has not been reported. Please
565 upgrade your version.
567 - Added parameter --non-indenting-braces, or -nib, which prevents
568 code from indenting one level if it follows an opening brace marked
569 with a special side comment, '#<<<'. For example,
571 { #<<< a closure to contain lexical vars
573 my $var; # this line does not indent
577 # this line cannot 'see' $var;
579 This is on by default. If your code happens to have some
580 opening braces followed by '#<<<', and you
581 don't want this, you can use -nnib to deactivate it.
583 - Side comment locations reset at a line ending in a level 0 open
584 block, such as when a new multi-line sub begins. This is intended to
585 help keep side comments from drifting to far to the right.
589 - Fix RT #133166, encoding not set for -st. Also reported as RT #133171
592 This is a significant bug in version 20200616 which can corrupt data if
593 perltidy is run as a filter on encoded text.
596 - Fix issue RT #133161, perltidy -html was not working on pod
598 - Fix issue git #33, allow control of space after '->'
600 - Vertical alignment has been improved. Numerous minor issues have
603 - Formatting with the -lp option is improved.
605 - Fixed issue git #32, misparse of bare 'ref' in ternary
607 - When --assert-tidy is used and triggers an error, the first difference
608 between input and output files is shown in the error output. This is
609 a partial response to issue git #30.
613 - Added support for Switch::Plain syntax, issue git #31.
615 - Fixed minor problem where trailing 'unless' clauses were not
616 getting vertically aligned.
618 - Added a parameter --logical-padding or -lop to allow logical padding
619 to be turned off. Requested by git #29. This flag is on by default.
620 The man pages have examples.
622 - Added a parameter -kpit=n to control spaces inside of parens following
623 certain keywords, requested in git#26. This flag is off by default.
625 - Added fix for git#25, improve vertical alignment for long lists with
626 varying numbers of items per line.
628 - calls to the module Perl::Tidy can now capture any output produced
629 by a debug flag or one of the 'tee' flags through the new 'debugfile' and
630 'teefile' call parameters. These output streams are rarely used but
631 they are now treated the same as any 'logfile' stream.
633 - add option --break-at-old-semicolon-breakpoints', -bos, requested
634 in RT#131644. This flag will keep lines beginning with a semicolon.
636 - Added --use-unicode-gcstring to control use of Unicode::GCString for
637 evaluating character widths of encoded data. The default is
638 not to use this (--nouse-unicode-gcstring). If this flag is set,
639 perltidy will look for Unicode::GCString and, if found, will use it
640 to evaluate character display widths. This can improve displayed
641 vertical alignment for files with wide characters. It is a nice
642 feature but it is off by default to avoid conflicting formatting
643 when there are multiple developers. Perltidy installation does not
644 require Unicode::GCString, so users wanting to use this feature need
645 set this flag and also to install Unicode::GCString separately.
647 - Added --character-encoding=guess or -guess to have perltidy guess
648 if a file (or other input stream) is encoded as -utf8 or some
649 other single-byte encoding. This is useful when processing a mixture
650 of file types, such as utf8 and latin-1.
652 Please Note: The default encoding has been set to be 'guess'
653 instead of 'none'. This seems like the best default, since
654 it allows perltidy work properly with both
655 utf8 files and older latin-1 files. The guess mode uses Encode::Guess,
656 which is included in standard perl distributions, and only tries to
657 guess if a file is utf8 or not, never any other encoding. If the guess is
658 utf8, and if the file successfully decodes as utf8, then it the encoding
659 is assumed to be utf8. Otherwise, no encoding is assumed.
660 If you do not want to use this new default guess mode, or have a
661 problem with it, you can set --character-encoding=none (the previous
662 default) or --character-encoding=utf8 (if you deal with utf8 files).
664 - Specific encodings of input files other than utf8 may now be given, for
665 example --character-encoding=euc-jp.
667 - Fix for git#22, Preserve function signature on a single line. An
668 unwanted line break was being introduced when a closing signature paren
669 followed a closing do brace.
671 - Fix RT#132059, the -dac parameter was not working and caused an error exit
673 - When -utf8 is used, any error output is encoded as utf8
675 - Fix for git#19, adjust line break around an 'xor'
677 - Fix for git#18, added warning for missing comma before unknown bare word.
681 - This release adds a flag to control the feature RT#130394 (allow short nested blocks)
682 introduced in the previous release. Unfortunately that feature breaks
683 RPerl installations, so a control flag has been introduced and that feature is now
684 off by default. The flag is:
686 --one-line-block-nesting=n, or -olbn=n, where n is an integer as follows:
688 -olbn=0 break nested one-line blocks into multiple lines [new DEFAULT]
689 -olbn=1 stable; keep existing nested-one line blocks intact [previous DEFAULT]
691 For example, consider this input line:
693 foreach (@list) { if ($_ eq $asked_for) { last } ++$found }
695 The new default behavior (-olbn=0), and behavior prior to version 20191203, is to break it into multiple lines:
698 if ( $_ eq $asked_for ) { last }
702 To keep nested one-line blocks such as this on a single line you can add the parameter -olbn=1.
704 - Fixed issue RT#131288: parse error for un-prototyped constant function without parenthesized
705 call parameters followed by ternary.
707 - Fixed issue RT#131360, installation documentation. Added a note that the binary
708 'perltidy' comes with the Perl::Tidy module. They can both normally be installed with
714 - Fixed issue RT#131115: -bli option not working correctly.
715 Closing braces were not indented in some cases due to a glitch
716 introduced in version 20181120.
718 - Fixed issue RT#130394: Allow short nested blocks. Given the following
720 $factorial = sub { reduce { $a * $b } 1 .. 11 };
722 Previous versions would always break the sub block because it
723 contains another block (the reduce block). The fix keeps
724 short one-line blocks such as this intact.
726 - Implement issue RT#130640: Allow different subroutine keywords.
727 Added a flag --sub-alias-list=s or -sal=s, where s is a string with
728 one or more aliases for 'sub', separated by spaces or commas.
731 perltidy -sal='method fun'
733 will cause the perltidy to treat the words 'method' and 'fun' to be
734 treated the same as if they were 'sub'.
736 - Added flag --space-prototype-paren=i, or -spp=i, to control spacing
737 before the opening paren of a prototype, where i=0, 1, or 2:
739 i=1 follow input [current and default]
742 Previously, perltidy always followed the input.
743 For example, given the following input
748 sub usage(); # i=0 [no space]
749 sub usage(); # i=1 [default; follows input]
750 sub usage (); # i=2 [space]
752 - Fixed issue git#16, minor vertical alignment issue.
754 - Fixed issue git#10, minor conflict of -wn and -ce
756 - Improved some vertical alignments involving two lines.
761 - fixed issue RT#130344: false warning "operator in print statement"
764 - fixed issue RT#130304: standard error output should include filename.
765 When perltidy error messages are directed to the standard error output
766 with -se or --standard-error-output, the message lines now have a prefix
767 'filename:' for clarification in case multiple files
768 are processed, where 'filename' is the name of the input file. If
769 input is from the standard input the displayed filename is '<stdin>',
770 and if it is from a data structure then displayed filename
771 is '<source_stream>'.
773 - implement issue RT#130425: check mode. A new flag '--assert-tidy'
774 will cause an error message if the output script is not identical to
775 the input script. For completeness, the opposite flag '--assert-untidy'
776 has also been added. The next item, RT#130297, insures that the script
777 will exit with a non-zero exit flag if the assertion fails.
779 - fixed issue RT#130297; the perltidy script now exits with a nonzero exit
780 status if it wrote to the standard error output. Prevously only fatal
781 run errors produced a non-zero exit flag. Now, even non-fatal messages
782 requested with the -w flag will cause a non-zero exit flag. The exit
783 flag now has these values:
786 1 = perltidy could not run to completion due to errors
787 2 = perltidy ran to completion with error messages
789 - added warning message for RT#130008, which warns of conflicting input
790 parameters -iob and -bom or -boc.
792 - fixed RT#129850; concerning a space between a closing block brace and
793 opening bracket or brace, as occurs before the '[' in this line:
795 my @addunix = map { File::Spec::Unix->catfile( @ROOT, @$_ ) } ['b'];
797 Formerly, any space was removed. Now it is optional, and the output will
800 - fixed issue git#13, needless trailing whitespace in error message
802 - fixed issue git#9: if the -ce (--cuddled-else) flag is used,
803 do not try to form new one line blocks for a block type
804 specified with -cbl, particularly map, sort, grep
806 - iteration speedup for unchanged code. Previously, when iterations were
807 requested, at least two formatting passes were made. Now just a single pass
808 is made if the formatted code is identical to the input code.
810 - some improved vertical alignments
814 - rt #128477: Prevent inconsistent owner/group and setuid/setgid bits.
815 In the -b (--backup-and-modify-in-place) mode, an attempt is made to set ownership
816 of the output file equal to the input file, if they differ.
817 In all cases, if the final output file ownership differs from input file, any setuid/setgid bits are cleared.
819 - Added option -bom (--break-at-old-method-breakpoints) by
820 merrillymeredith which preserves breakpoints of method chains. Modified to also handle a cuddled call style.
822 - Merged patch to fix Windows EOL translation error with UTF-8 written by
823 Ron Ivy. This update prevents automatic conversion to 'DOS' CRLF line
824 endings. Also, Windows system testing at the appveyor site is working again.
826 - RT #128280, added flag --one-line-block-semicolons=n (-olbs=n)
827 to control semicolons in one-line blocks. The values of n are:
828 n=0 means no semicolons termininating simple one-line blocks
829 n=1 means stable; do not change from input file [DEFAULT and current]
830 n=2 means always add semicolons in one-line blocks
831 The current behavior corresponds to the default n=1.
833 - RT #128216, Minor update to prevent inserting unwanted blank line at
834 indentation level change. This should not change existing scripts.
836 - RT #81852: Improved indentation when quoted word (qw) lists are
837 nested within other containers using the --weld-nested (-wn) flag.
838 The example given previously (below) is now closer to what it would
839 be with a simple list instead of qw:
853 - RT#12764, introduced new feature allowing placement of blanks around
854 sequences of selected keywords. This can be activated with the -kgb*
855 series of parameters described in the manual.
857 - Rewrote vertical algnment module. It is better at finding
858 patterns in complex code. For example,
861 /^-std$/ && do { $std = 1; next; };
862 /^--$/ && do { @link_args = @argv; last; };
863 /^-I(.*)/ && do { $path = $1 || shift @argv; next; };
866 /^-std$/ && do { $std = 1; next; };
867 /^--$/ && do { @link_args = @argv; last; };
868 /^-I(.*)/ && do { $path = $1 || shift @argv; next; };
870 - Add repository URLs to META files
872 - RT #118553, "leave only one newline at end of file". This option was not
873 added because of undesirable side effects, but a new filter script
874 was added which can do this, "examples/delete_ending_blank_lines.pl".
878 - fix RT#127736 Perl-Tidy-20181119 has the EXE_FILES entry commented out in
879 Makefile.PL so it doesn't install the perltidy script or its manpage.
884 - Removed test case 'filter_example.t' which was causing a failure on a
885 Windows installation for unknown reasons, possibly due to an unexpected
886 perltidyrc being read by the test script. Added VERSION numbers to all
891 - Fixed RT #126965, in which a ternary operator was misparsed if immediately
892 following a function call without arguments, such as:
893 my $restrict_customer = shift ? 1 : 0;
895 - Fixed RT #125012: bug in -mangle --delete-all-comments
896 A needed blank space before bareword tokens was being removed when comments
899 - Fixed RT #81852: Stacked containers and quoting operators. Quoted words
900 (qw) delimited by container tokens ('{', '[', '(', '<') are now included in
901 the --weld-nested (-wn) flag:
915 - The cuddled-else (-ce) coding was merged with the new cuddled-block (-cb)
916 coding. The change is backward compatible and simplifies input.
917 The --cuddled-block-option=n (-cbo=n) flag now applies to both -ce and -cb
918 formatting. In fact the -cb flag is just an alias for -ce now.
920 - Fixed RT #124594, license text desc. changed from 'GPL-2.0+' to 'gpl_2'
922 - Fixed bug in which a warning about a possible code bug was issued in a
923 script with brace errors.
925 - added option --notimestamp or -nts to eliminate any time stamps in output
926 files. This is used to prevent differences in test scripts from causing
927 failure at installation. For example, the -cscw option will put a date
928 stamp on certain closing side comments. We need to avoid this in order
929 to test this feature in an installation test.
931 - Fixed bug with the entab option, -et=8, in which the leading space of
932 some lines was was not entabbed. This happened in code which was adjusted
933 for vertical alignment and in hanging side comments. Thanks to Glenn.
935 - Fixed RT #127633, undesirable line break after return when -baao flag is set
937 - Fixed RT #127035, vertical alignment. Vertical alignment has been improved
938 in several ways. Thanks especially to Michael Wardman and Glenn for sending
941 - Alignment of the =~ operators has been reactivated.
944 $service_profile =~ s/^\s+|\s+$//g;
945 $host_profile =~ s/^\s+|\s+$//g;
948 $service_profile =~ s/^\s+|\s+$//g;
949 $host_profile =~ s/^\s+|\s+$//g;
951 - Alignment of the // operator has been reactivated.
954 is( pop // 7, 7, 'pop // ... works' );
955 is( pop() // 7, 0, 'pop() // ... works' );
956 is( pop @ARGV // 7, 3, 'pop @array // ... works' );
959 is( pop // 7, 7, 'pop // ... works' );
960 is( pop() // 7, 0, 'pop() // ... works' );
961 is( pop @ARGV // 7, 3, 'pop @array // ... works' );
963 - The rules for alignment of just two lines have been adjusted,
964 hopefully to be a little better overall. In some cases, two
965 lines which were previously unaligned are now aligned, and vice-versa.
968 $expect = "1$expect" if $expect =~ /^e/i;
969 $p = "1$p" if defined $p and $p =~ /^e/i;
972 $expect = "1$expect" if $expect =~ /^e/i;
973 $p = "1$p" if defined $p and $p =~ /^e/i;
976 - RT #106493; source code repository location has been added to docs; it is
977 https://github.com/perltidy/perltidy
979 - The packaging for this version has changed. The Tidy.pm module is much
980 smaller. Supporting modules have been split out from it and placed below
981 it in the path Perl/Tidy/*.
983 - A number of new installation test cases have been added. Updates are now
984 continuously tested at Travis CI against versions back to Perl 5.08.
988 - RT #124469, #124494, perltidy often making empty files. The previous had
989 an index error causing it to fail, particularly in version 5.18 of Perl.
991 Please avoid version 20180219.
995 - RT #79947, cuddled-else generalization. A new flag -cb provides
996 'cuddled-else' type formatting for an arbitrary type of block chain. The
997 default is try-catch-finally, but this can be modified with the
1000 - Fixed RT #124298: add space after ! operator without breaking !! secret
1003 - RT #123749: numerous minor improvements to the -wn flag were made.
1005 - Fixed a problem with convergence tests in which iterations were stopping
1008 - Here doc targets for <<~ type here-docs may now have leading whitespace.
1010 - Fixed RT #124354. The '-indent-only' flag was not working correctly in the
1011 previous release. A bug in version 20180101 caused extra blank lines
1014 - Issue RT #124114. Some improvements were made in vertical alignment
1015 involving 'fat commas'.
1019 - Added new flag -wn (--weld-nested-containers) which addresses these issues:
1020 RT #123749: Problem with promises;
1021 RT #119970: opening token stacking strange behavior;
1022 RT #81853: Can't stack block braces
1024 This option causes closely nested pairs of opening and closing containers
1025 to be "welded" together and essentially be formatted as a single unit,
1026 with just one level of indentation.
1028 Since this is a new flag it is set to be "off" by default but it has given
1029 excellent results in testing.
1031 EXAMPLE 1, multiple blocks, default formatting:
1034 next if $x == $y; # do something here
1041 } } until $x++ > $z;
1043 EXAMPLE 2, three levels of wrapped function calls, default formatting:
1047 translate( param('verb') ), param('tense'),
1055 translate( param('verb') ),
1056 param('tense'), param('person')
1059 # EXAMPLE 3, chained method calls, default formatting:
1060 get('http://mojolicious.org')->then(
1063 say $mojo->res->code;
1064 return get('http://metacpan.org');
1069 say $cpan->res->code;
1074 warn "Something went wrong: $err";
1079 get('http://mojolicious.org')->then( sub {
1081 say $mojo->res->code;
1082 return get('http://metacpan.org');
1085 say $cpan->res->code;
1088 warn "Something went wrong: $err";
1092 - Fixed RT #114359: Missparsing of "print $x ** 0.5;
1094 - Deactivated the --check-syntax flag for better security. It will be
1097 - Corrected minimum perl version from 5.004 to 5.008 based on perlver
1098 report. The change is required for coding involving wide characters.
1100 - For certain severe errors, the source file will be copied directly to the
1101 output without formatting. These include ending in a quote, ending in a
1102 here doc, and encountering an unidentified character.
1106 - RT #123749, partial fix. "Continuation indentation" is removed from lines
1107 with leading closing parens which are part of a call chain.
1108 For example, the call to pack() is is now outdented to the starting
1109 indentation in the following experession:
1113 -text => "New Document",
1114 -command => \&new_document
1122 -text => "New Document",
1123 -command => \&new_document
1129 This modification improves readability of complex expressions, especially
1130 when the user uses the same value for continuation indentation (-ci=n) and
1131 normal indentation (-i=n). Perltidy was already programmed to
1132 do this but a minor bug was preventing it.
1134 - RT #123774, added flag to control space between a backslash and a single or
1135 double quote, requested by Robert Rothenberg. The issue is that lines like
1140 confuse syntax highlighters unless a space is left between the backslash and
1143 The new flag to control this is -sbq=n (--space-backslash-quote=n),
1144 where n=0 means no space, n=1 means follow existing code, n=2 means always
1145 space. The default is n=1, meaning that a space will be retained if there
1146 is one in the source code.
1148 - Fixed RT #123492, support added for indented here doc operator <<~ added
1149 in v5.26. Thanks to Chris Weyl for the report.
1151 - Fixed docs; --closing-side-comment-list-string should have been just
1152 --closing-side-comment-list. Thanks to F.Li.
1154 - Added patch RT #122030] Perl::Tidy sometimes does not call binmode.
1155 Thanks to Irilis Aelae.
1157 - Fixed RT #121959, PERLTIDY doesn't honor the 'three dot' notation for
1158 locating a config file using environment variables. Thanks to John
1161 - Minor improvements to formatting, in which some additional vertical
1162 aligmnemt is done. Thanks to Keith Neargarder.
1164 - RT #119588. Vertical alignment is no longer done for // operator.
1168 - Fixed debian #862667: failure to check for perltidy.ERR deletion can lead
1169 to overwriting arbitrary files by symlink attack. Perltidy was continuing
1170 to write files after an unlink failure. Thanks to Don Armstrong
1173 - Fixed RT #116344, perltidy fails on certain anonymous hash references:
1174 in the following code snippet the '?' was misparsed as a pattern
1175 delimiter rather than a ternary operator.
1176 return ref {} ? 1 : 0;
1178 - Fixed RT #113792: misparsing of a fat comma (=>) right after
1179 the __END__ or __DATA__ tokens. These keywords were getting
1180 incorrectly quoted by the following => operator.
1182 - Fixed RT #118558. Custom Getopt::Long configuration breaks parsing
1183 of perltidyrc. Perltidy was resetting the users configuration too soon.
1185 - Fixed RT #119140, failure to parse double diamond operator. Code to
1186 handle this new operator has been added.
1188 - Fixed RT #120968. Fixed problem where -enc=utf8 didn't work
1189 with --backup-and-modify-in-place. Thanks to Heinz Knutzen for this patch.
1191 - Fixed minor formatting issue where one-line blocks for subs with signatures
1192 were unnecessarily broken
1194 - RT #32905, patch to fix utf-8 error when output was STDOUT.
1196 - RT #79947, improved spacing of try/catch/finally blocks. Thanks to qsimpleq
1199 - Fixed #114909, Anonymous subs with signatures and prototypes misparsed as
1200 broken ternaries, in which a statement such as this was not being parsed
1202 return sub ( $fh, $out ) : prototype(*$) { ... }
1204 - Implemented RT #113689, option to introduces spaces after an opening block
1205 brace and before a closing block brace. Four new optional controls are
1206 added. The first two define the minimum number of blank lines to be
1209 -blao=i or --blank-lines-after-opening-block=i
1210 -blbc=i or --blank-lines-before-closing-block=i
1212 where i is an integer, the number of lines (the default is 0).
1214 The second two define the types of blocks to which the first two apply
1216 -blaol=s or --blank-lines-after-opening-block-list=s
1217 -blbcl=s or --blank-lines-before-closing-block-list=s
1219 where s is a string of possible block keywords (default is just 'sub',
1220 meaning a named subroutine).
1222 For more information please see the documentation.
1224 - The method for specifying block types for certain input parameters has
1225 been generalized to distinguish between normal named subroutines and
1226 anonymous subs. The keyword for normal subroutines remains 'sub', and
1227 the new keyword for anonymous subs is 'asub'.
1229 - Minor documentation changes. The BUGS sections now have a link
1230 to CPAN where most open bugs and issues can be reviewed and bug reports
1231 can be submitted. The information in the AUTHOR and CREDITS sections of
1232 the man pages have been removed from the man pages to streamline the
1233 documentation. This information is still in the source code.
1237 - RT #112534. Corrected a minor problem in which an unwanted newline
1238 was placed before the closing brace of an anonymous sub with
1239 a signature, if it was in a list. Thanks to Dmytro Zagashev.
1241 - Corrected a minor problem in which occasional extra indentation was
1242 given to the closing brace of an anonymous sub in a list when the -lp
1247 - RT #104427. Added support for signatures.
1249 - RT #111512. Changed global warning flag $^W = 1 to use warnings;
1250 Thanks to Dmytro Zagashev.
1252 - RT #110297, added support for new regexp modifier /n
1253 Thanks to Dmytro Zagashev.
1255 - RT #111519. The -io (--indent-only) and -dac (--delete-all-comments)
1256 can now both be used in one pass. Thanks to Dmitry Veltishev.
1258 - Patch to avoid error message with 'catch' used by TryCatch, as in
1262 Thanks to Nick Tonkin.
1264 - RT #32905, UTF-8 coding is now more robust. Thanks to qsimpleq
1265 and Dmytro for patches.
1267 - RT #106885. Added string bitwise operators ^. &. |. ~. ^.= &.= |.=
1269 - Fixed RT #107832 and #106492, lack of vertical alignment of two lines
1270 when -boc flag (break at old commas) is set. This bug was
1271 inadvertently introduced in previous bug fix RT #98902.
1273 - Some common extensions to Perl syntax are handled better.
1274 In particular, the following snippet is now foratted cleanly:
1276 method deposit( Num $amount) {
1277 $self->balance( $self->balance + $amount );
1280 A new flag -xs (--extended-syntax) was added to enable this, and the default
1283 In previous versions, and now only when -nxs is set, this snippet of code
1284 generates the following error message:
1286 "syntax error at ') {', didn't see one of: case elsif for foreach given if switch unless until when while"
1290 - Fixed RT# 105484, Invalid warning about 'else' in 'switch' statement. The
1291 warning happened if a 'case' statement did not use parens.
1293 - Fixed RT# 101547, misparse of // caused error message. Also..
1295 - Fixed RT# 102371, misparse of // caused unwated space in //=
1297 - Fixed RT# 100871, "silent failure of HTML Output on Windows".
1298 Changed calls to tempfile() from:
1299 my ( $fh_tmp, $tmpfile ) = tempfile();
1300 to have the full path name:
1301 my ( $fh_tmp, $tmpfile ) = File::Temp::tempfile()
1302 because of problems in the Windows version reported by Dean Pearce.
1304 - Fixed RT# 99514, calling the perltidy module multiple times with
1305 a .perltidyrc file containing the parameter --output-line-ending
1306 caused a crash. This was a glitch in the memoization logic.
1308 - Fixed RT#99961, multiple lines inside a cast block caused unwanted
1309 continuation indentation.
1311 - RT# 32905, broken handling of UTF-8 strings.
1312 A new flag -utf8 causes perltidy assume UTF-8 encoding for input and
1313 output of an io stream. Thanks to Sebastian Podjasek for a patch.
1314 This feature may not work correctly in older versions of Perl.
1315 It worked in a linux version 5.10.1 but not in a Windows version 5.8.3 (but
1316 otherwise perltidy ran correctly).
1318 - Warning files now report perltidy VERSION. Suggested by John Karr.
1320 - Fixed long flag --nostack-closing-tokens (-nsct has always worked though).
1321 This was due to a typo. This also fixed --nostack-opening-tokens to
1322 behave correctly. Thanks to Rob Dixon.
1326 - Fixed RT #94902: abbreviation parsing in .perltidyrc files was not
1327 working for multi-line abbreviations. Thanks to Eric Fung for
1330 - Fixed RT #95708, misparsing of a hash when the first key was a perl
1331 keyword, causing a semicolon to be incorrectly added.
1333 - Fixed RT #94338 for-loop in a parenthesized block-map. A code block within
1334 parentheses of a map, sort, or grep function was being mistokenized. In
1335 rare cases this could produce in an incorrect error message. The fix will
1336 produce some minor formatting changes. Thanks to Daniel Trizen
1337 discovering and documenting this.
1339 - Fixed RT #94354, excess indentation for stacked tokens. Thanks to
1340 Colin Williams for supplying a patch.
1342 - Added support for experimental postfix dereferencing notation introduced in
1343 perl 5.20. RT #96021.
1345 - Updated documentation to clarify the behavior of the -io flag
1346 in response to RT #95709. You can add -noll or -l=0 to prevent
1347 long comments from being outdented when -io is used.
1349 - Added a check to prevent a problem reported in RT #81866, where large
1350 scripts which had been compressed to a single line could not be formatted
1351 because of a check for VERSION for MakeMaker. The workaround was to
1352 use -nvpl, but this shouldn't be necessary now.
1354 - Fixed RT #96101; Closing brace of anonymous sub in a list was being
1355 indented. For example, the closing brace of the anonymous sub below
1356 will now be lined up with the word 'callback'. This problem
1357 occurred if there was no comma after the closing brace of the anonymous sub.
1358 This update may cause minor changes to formatting of code with lists
1359 of anonymous subs, especially TK code.
1366 path => '/_Operate/Transcode and split',
1368 return 1 if not $self->project_opened;
1369 $self->comp('project')->transcode( split => 1 );
1379 path => '/_Operate/Transcode and split',
1381 return 1 if not $self->project_opened;
1382 $self->comp('project')->transcode( split => 1 );
1389 - Fixed RT #94190 and debian Bug #742004: perltidy.LOG file left behind.
1390 Thanks to George Hartzell for debugging this. The problem was
1391 caused by the memoization speedup patch in version 20121207. An
1392 unwanted flag was being set which caused a LOG to be written if
1393 perltidy was called multiple times.
1395 - New default behavior for LOG files: If the source is from an array or
1396 string (through a call to the perltidy module) then a LOG output is only
1397 possible if a logfile stream is specified. This is to prevent
1398 unexpected perltidy.LOG files.
1400 - Fixed debian Bug #740670, insecure temporary file usage. File::Temp is now
1401 used to get a temporary file. Thanks to Don Anderson for a patch.
1403 - Any -b (--backup-and-modify-in-place) flag is silently ignored when a
1404 source stream, destination stream, or standard output is used.
1405 This is because the -b flag may have been in a .perltidyrc file and
1406 warnings break Test::NoWarnings. Thanks to Marijn Brand.
1410 - Fixed RT #88020. --converge was not working with wide characters.
1412 - Fixed RT #78156. package NAMESPACE VERSION syntax not accepted.
1414 - First attempt to fix RT #88588. INDEX END tag change in pod2html breaks
1415 perltidy -html. I put in a patch which should work but I don't yet have
1416 a way of testing it.
1420 - Fixed RT #87107, spelling
1424 - Fixed RT #87502, incorrect of parsing of smartmatch before hash brace
1426 - Added feature request RT #87330, trim whitespace after POD.
1427 The flag -trp (--trim-pod) will trim trailing whitespace from lines of POD
1431 - Fixed RT #86929, #86930, missing lhs of assignment.
1433 - Fixed RT #84922, moved pod from Tidy.pm into Tidy.pod
1437 - The flag -cab=n or --comma-arrow-breakpoints=n has been generalized
1438 to give better control over breaking open short containers. The
1439 possible values are now:
1441 n=0 break at all commas after =>
1442 n=1 stable: break at all commas after => if container is open,
1443 EXCEPT FOR one-line containers
1444 n=2 break at all commas after =>, BUT try to form the maximum
1445 maximum one-line container lengths
1446 n=3 do not treat commas after => specially at all
1447 n=4 break everything: like n=0 but also break a short container with
1448 a => not followed by a comma
1449 n=5 stable: like n=1 but ALSO break at open one-line containers (default)
1451 New values n=4 and n=5 have been added to allow short blocks to be
1452 broken open. The new default is n=5, stable. It should more closely
1453 follow the breaks in the input file, and previously formatted code
1454 should remain unchanged. If this causes problems use -cab=1 to recover
1455 the former behavior. Thanks to Tony Maszeroski for the suggestion.
1457 To illustrate the need for the new options, if perltidy is given
1458 the following code, then the old default (-cab=1) was to close up
1459 the 'index' container even if it was open in the source. The new
1460 default (-cab=5) will keep it open if it was open in the source.
1475 - New debug flag --memoize (-mem). This version contains a
1476 patch supplied by Jonathan Swartz which can significantly speed up
1477 repeated calls to Perl::Tidy::perltidy in a single process by caching
1478 the result of parsing the formatting parameters. A factor of up to 10
1479 speedup was achieved for masontidy (https://metacpan.org/module/masontidy).
1480 The memoization patch is on by default but can be deactivated for
1481 testing with -nmem (or --no-memoize).
1483 - New flag -tso (--tight-secret-operators) causes certain perl operator
1484 sequences (secret operators) to be formatted "tightly" (without spaces).
1485 The most common of these are 0 + and + 0 which become 0+ and +0. The
1486 operators currently modified by this flag are:
1487 =( )= 0+ +0 ()x!! ~~<> ,=>
1488 Suggested by by Philippe Bruhat. See https://metacpan.org/module/perlsecret
1489 This flag is off by default.
1491 - New flag -vmll (--variable-maximum-line-length) makes the maximum
1492 line length increase with the nesting depth of a line of code.
1493 Basically, it causes the length of leading whitespace to be ignored when
1494 setting line breaks, so the formatting of a block of code is independent
1495 of its nesting depth. Try this option if you have deeply nested
1496 code or data structures, perhaps in conjunction with the -wc flag
1497 described next. The default is not todo this.
1499 - New flag -wc=n (--whitespace-cycle=n) also addresses problems with
1500 very deeply nested code and data structures. When this parameter is
1501 used and the nesting depth exceeds the value n, the leading whitespace
1502 will be reduced and start at 1 again. The result is that deeply
1503 nested blocks of code will shift back to the left. This occurs cyclically
1504 to any nesting depth. This flag may be used either with or without -vmll.
1505 The default is not to use this (-wc=0).
1507 - Fixed RT #78764, error parsing smartmatch operator followed by anonymous
1508 hash or array and then a ternary operator; two examples:
1510 qr/3/ ~~ ['1234'] ? 1 : 0;
1511 map { $_ ~~ [ '0', '1' ] ? 'x' : 'o' } @a;
1513 - Fixed problem with specifying spaces around arrows using -wls='->'
1514 and -wrs='->'. Thanks to Alain Valleton for documenting this problem.
1516 - Implemented RT #53183, wishlist, lines of code with the same indentation
1517 level which are contained with multiple stacked opening and closing tokens
1518 (requested with flags -sot -sct) now have reduced indentation.
1524 subject => $subject,
1529 # OLD: perltidy -sot -sct
1532 subject => $subject,
1536 # NEW: perltidy -sot -sct
1539 subject => $subject,
1543 - New flag -act=n (--all-containers-tightness=n) is an abbreviation for
1544 -pt=n -sbt=n -bt=n -bbt=n, where n=0,1, or 2. It simplifies input when all
1545 containers have the same tightness. Using the same example:
1547 # NEW: perltidy -sot -sct -act=2
1550 subject => $subject,
1554 - New flag -sac (--stack-all-containers) is an abbreviation for -sot -sct
1555 This is part of wishlist item RT #53183. Using the same example again:
1557 # NEW: perltidy -sac -act=2
1560 subject => $subject,
1564 - new flag -scbb (--stack-closing-block-brace) causes isolated closing
1565 block braces to stack as in the following example. (Wishlist item RT#73788)
1572 push( @lines, "$w1 $w2 $w3 $w4\n" );
1583 push( @lines, "$w1 $w2 $w3 $w4\n" );
1586 There is, at present, no flag to place these closing braces at the end
1587 of the previous line. It seems difficult to develop good rules for
1588 doing this for a wide variety of code and data structures.
1590 - Parameters defining block types may use a wildcard '*' to indicate
1591 all block types. Previously it was not possible to include bare blocks.
1593 - A flag -sobb (--stack-opening-block-brace) has been introduced as an
1594 alias for -bbvt=2 -bbvtl='*'. So for example the following test code:
1596 {{{{{{{ $testing }}}}}}}
1598 cannot be formatted as above but can at least be kept vertically compact
1599 using perltidy -sobb -scbb
1601 { { { { { { { $testing
1604 Or even, perltidy -sobb -scbb -i=1 -bbt=2
1609 - Error message improved for conflicts due to -pbp; thanks to Djun Kim.
1611 - Fixed RT #80645, error parsing special array name '@$' when used as
1614 - Eliminated the -chk debug flag which was included in version 20010406 to
1615 do a one-time check for a bug with multi-line quotes. It has not been
1618 - Numerous other minor formatting improvements.
1622 - Added flag -iscl (--ignore-side-comment-lengths) which causes perltidy
1623 to ignore the length of side comments when setting line breaks,
1624 RT #71848. The default is to include the length of side comments when
1625 breaking lines to stay within the length prescribed by the -l=n
1626 maximum line length parameter. For example,
1628 Default behavior on a single line with long side comment:
1629 $vmsfile =~ s/;[\d\-]*$//
1630 ; # Clip off version number; we can use a newer version as well
1632 perltidy -iscl leaves the line intact:
1634 $vmsfile =~ s/;[\d\-]*$//; # Clip off version number; we can use a newer version as well
1636 - Fixed RT #78182, side effects with STDERR. Error handling has been
1637 revised and the documentation has been updated. STDERR can now be
1638 redirected to a string reference, and perltidy now returns an
1639 error flag instead of calling die when input errors are detected.
1640 If the error flag is set then no tidied output was produced.
1641 See man Perl::Tidy for an example.
1643 - Fixed RT #78156, erroneous warning message for package VERSION syntax.
1645 - Added abbreviations -conv (--converge) to simplify iteration control.
1646 -conv is equivalent to -it=4 and will insure that the tidied code is
1647 converged to its final state with the minimum number of iterations.
1649 - Minor formatting modifications have been made to insure convergence.
1651 - Simplified and hopefully improved the method for guessing the starting
1652 indentation level of entabbed code. Added flag -dt=n (--default_tabsize=n)
1653 which might be helpful if the guessing method does not work well for
1656 - Added support for stacked labels, upper case X/B in hex and binary, and
1659 - Eliminated warning messages for using keyword names as constants.
1663 - Corrected problem introduced by using a chomp on scalar references, RT #77978
1665 - Added support for Perl 5.14 package block syntax, RT #78114.
1667 - A convergence test is made if three or more iterations are requested with
1668 the -it=n parameter to avoid wasting computer time. Several hundred Mb of
1669 code gleaned from the internet were searched with the results that:
1670 - It is unusual for two iterations to be required unless a major
1671 style change is being made.
1672 - Only one case has been found where three iterations were required.
1673 - No cases requiring four iterations have been found with this version.
1674 For the previous version several cases where found the results could
1675 oscillate between two semi-stable states. This version corrects this.
1677 So if it is important that the code be converged it is okay to set -it=4
1678 with this version and it will probably stop after the second iteration.
1680 - Improved ability to identify and retain good line break points in the
1681 input stream, such as at commas and equals. You can always tell
1682 perltidy to ignore old breakpoints with -iob.
1684 - Fixed glitch in which a terminal closing hash brace followed by semicolon
1685 was not outdented back to the leading line depth like other closing
1686 tokens. Thanks to Keith Neargarder for noting this.
1689 my ( $pre, $post ) = @{
1691 "pp_anonlist" => [ "[", "]" ],
1692 "pp_anonhash" => [ "{", "}" ]
1697 my ( $pre, $post ) = @{
1699 "pp_anonlist" => [ "[", "]" ],
1700 "pp_anonhash" => [ "{", "}" ]
1704 - Removed extra indentation given to trailing 'if' and 'unless' clauses
1705 without parentheses because this occasionally produced undesirable
1706 results. This only applies where parens are not used after the if or
1711 unless my ( $who, $actions ) =
1712 $clause =~ /^($who_re)((?:$action_re)+)$/o;
1716 unless my ( $who, $actions ) =
1717 $clause =~ /^($who_re)((?:$action_re)+)$/o;
1721 - Updated perltidy to handle all quote modifiers defined for perl 5 version 16.
1723 - Side comment text in perltidyrc configuration files must now begin with
1724 at least one space before the #. Thus:
1727 -l=78 # Max line width is 78 cols
1729 -l=78# Max line width is 78 cols
1731 This is probably true of almost all existing perltidyrc files,
1732 but if you get an error message about bad parameters
1733 involving a '#' the first time you run this version, please check the side
1734 comments in your perltidyrc file, and add a space before the # if necessary.
1735 You can quickly see the contents your perltidyrc file, if any, with the
1740 The reason for this change is that some parameters naturally involve
1741 the # symbol, and this can get interpreted as a side comment unless the
1742 parameter is quoted. For example, to define -sphb=# it used to be necessary
1745 to keep the # from becoming part of a comment. This was causing
1746 trouble for new users. Now it can also be written without quotes:
1749 - Fixed bug in processing some .perltidyrc files containing parameters with
1750 an opening brace character, '{'. For example the following was
1751 incorrectly processed:
1752 --static-block-comment-prefix="^#{2,}[^\s#]"
1755 - Added flag -boa (--break-at-old-attribute-breakpoints) which retains
1756 any existing line breaks at attribute separation ':'. This is now the
1757 default, use -nboa to deactivate. Thanks to Daphne Phister for the patch.
1758 For example, given the following code, the line breaks at the ':'s will be
1764 : Get('Name' => 'foo') : Set('Name');
1766 whereas the previous version would have output a single line. If
1767 the attributes are on a single line then they will remain on a single line.
1769 - Added new flags --blank-lines-before-subs=n (-blbs=n) and
1770 --blank-lines-before-packages=n (-blbp=n) to put n blank lines before
1771 subs and packages. The old flag -bbs is now equivalent to -blbs=1 -blbp=1.
1772 and -nbbs is equivalent to -blbs=0 -blbp=0. Requested by M. Schwern and
1775 - Added feature -nsak='*' meaning no space between any keyword and opening
1776 paren. This avoids listing entering a long list of keywords. Requested
1779 - Added option to delete a backup of original file with in-place-modify (-b)
1780 if there were no errors. This can be requested with the flag -bext='/'.
1781 See documentation for details. Requested by M. Schwern and others.
1783 - Fixed bug where the module postfilter parameter was not applied when -b
1784 flag was used. This was discovered during testing.
1786 - Fixed in-place-modify (-b) to work with symbolic links to source files.
1787 Thanks to Ted Johnson.
1789 - Fixed bug where the Perl::Tidy module did not allow -b to be used
1792 - No extra blank line is added before a comment which follows
1793 a short line ending in an opening token, for example like this:
1797 # unless we follow a blank or comment line
1798 $last_line_leading_type !~ /^[#b]$/
1803 # unless we follow a blank or comment line
1804 $last_line_leading_type !~ /^[#b]$/
1807 The blank is not needed for readability in these cases because there
1808 already is already space above the comment. If a blank already
1809 exists there it will not be removed, so this change should not
1810 change code which has previously been formatted with perltidy.
1811 Thanks to R.W.Stauner.
1813 - Likewise, no extra blank line is added above a comment consisting of a
1814 single #, since nothing is gained in readability.
1816 - Fixed error in which a blank line was removed after a #>>> directive.
1817 Thanks to Ricky Morse.
1819 - Unnecessary semicolons after given/when/default blocks are now removed.
1821 - Fixed bug where an unwanted blank line could be added before
1822 pod text in __DATA__ or __END__ section. Thanks to jidani.
1824 - Changed exit flags from 1 to 0 to indicate success for -help, -version,
1825 and all -dump commands. Also added -? as another way to dump the help.
1826 Requested by Keith Neargarder.
1828 - Fixed bug where .ERR and .LOG files were not written except for -it=2 or more
1830 - Fixed bug where trailing blank lines at the end of a file were dropped when
1833 - Fixed bug where a line occasionally ended with an extra space. This reduces
1834 rhe number of instances where a second iteration gives a result different
1837 - Updated documentation to note that the Tidy.pm module <stderr> parameter may
1838 not be a reference to SCALAR or ARRAY; it must be a file.
1840 - Syntax check with perl now work when the Tidy.pm module is processing
1841 references to arrays and strings. Thanks to Charles Alderman.
1843 - Zero-length files are no longer processed due to concerns for data loss
1844 due to side effects in some scenarios.
1846 - block labels, if any, are now included in closing side comment text
1847 when the -csc flag is used. Suggested by Aaron. For example,
1848 the label L102 in the following block is now included in the -csc text:
1850 L102: for my $i ( 1 .. 10 ) {
1852 } ## end L102: for my $i ( 1 .. 10 )
1856 - added new flag -it=n or --iterations=n
1857 This flag causes perltidy to do n complete iterations.
1858 For most purposes the default of n=1 should be satisfactory. However n=2
1859 can be useful when a major style change is being made, or when code is being
1860 beautified on check-in to a source code control system. The run time will be
1861 approximately proportional to n, and it should seldom be necessary to use a
1862 value greater than n=2. Thanks to Jonathan Swartz
1864 - A configuration file pathname begins with three dots, e.g.
1865 ".../.perltidyrc", indicates that the file should be searched for starting
1866 in the current directory and working upwards. This makes it easier to have
1867 multiple projects each with their own .perltidyrc in their root directories.
1868 Thanks to Jonathan Swartz for this patch.
1870 - Added flag --notidy which disables all formatting and causes the input to be
1871 copied unchanged. This can be useful in conjunction with hierarchical
1872 F<.perltidyrc> files to prevent unwanted tidying.
1873 Thanks to Jonathan Swartz for this patch.
1875 - Added prefilters and postfilters in the call to the Tidy.pm module.
1876 Prefilters and postfilters. The prefilter is a code reference that
1877 will be applied to the source before tidying, and the postfilter
1878 is a code reference to the result before outputting.
1880 Thanks to Jonathan Swartz for this patch. He writes:
1881 This is useful for all manner of customizations. For example, I use
1882 it to convert the 'method' keyword to 'sub' so that perltidy will work for
1883 Method::Signature::Simple code:
1885 Perl::Tidy::perltidy(
1886 prefilter => sub { $_ = $_[0]; s/^method (.*)/sub $1 \#__METHOD/gm; return $_ },
1887 postfilter => sub { $_ = $_[0]; s/^sub (.*?)\s* \#__METHOD/method $1/gm; return $_ }
1890 - The starting indentation level of sections of code entabbed with -et=n
1891 is correctly guessed if it was also produced with the same -et=n flag. This
1892 keeps the indentation stable on repeated formatting passes within an editor.
1893 Thanks to Sam Kington and Glenn.
1895 - Functions with prototype '&' had a space between the function and opening
1896 peren. This space now only occurs if the flag --space-function-paren (-sfp)
1897 is set. Thanks to Zrajm Akfohg.
1899 - Patch to never put spaces around a bare word in braces beginning with ^ as in:
1900 my $before = ${^PREMATCH};
1901 even if requested with the -bt=0 flag because any spaces cause a syntax error in perl.
1902 Thanks to Fabrice Dulanoy.
1906 - Allow configuration file to be 'perltidy.ini' for Windows systems.
1907 i.e. C:\Documents and Settings\User\perltidy.ini
1908 and added documentation for setting configuation file under Windows in man
1909 page. Thanks to Stuart Clark.
1911 - Corrected problem of unwanted semicolons in hash ref within given/when code.
1912 Thanks to Nelo Onyiah.
1914 - added new flag -cscb or --closing-side-comments-balanced
1915 When using closing-side-comments, and the closing-side-comment-maximum-text
1916 limit is exceeded, then the comment text must be truncated. Previous
1917 versions of perltidy terminate with three dots, and this can still be
1918 achieved with -ncscb:
1920 perltidy -csc -ncscb
1922 } ## end foreach my $foo (sort { $b cmp $a ...
1924 However this causes a problem with older editors which cannot recognize
1925 comments or are not configured to doso because they cannot "bounce" around in
1926 the text correctly. The B<-cscb> flag tries to help them by
1927 appending appropriate terminal balancing structure:
1931 } ## end foreach my $foo (sort { $b cmp $a ... })
1933 Since there is much to be gained and little to be lost by doing this,
1934 the default is B<-cscb>. Use B<-ncscb> if you do not want this.
1936 Thanks to Daniel Becker for suggesting this option.
1938 - After an isolated closing eval block the continuation indentation will be
1939 removed so that the braces line up more like other blocks. Thanks to Yves Orton.
1958 -A new flag -asbl (or --opening-anonymous-sub-brace-on-new-line) has
1959 been added to put the opening brace of anonymous sub's on a new line,
1960 as in the following snippet:
1968 This was not possible before because the -sbl flag only applies to named
1969 subs. Thanks to Benjamin Krupp.
1971 -Fix tokenization bug with the following snippet
1972 print 'hi' if { x => 1, }->{x};
1973 which resulted in a semicolon being added after the comma. The workaround
1974 was to use -nasc, but this is no longer necessary. Thanks to Brian Duggan.
1976 -Fixed problem in which an incorrect error message could be triggered
1977 by the (unusual) combination of parameters -lp -i=0 -l=2 -ci=0 for
1978 example. Thanks to Richard Jelinek.
1980 -A new flag --keep-old-blank-lines=n has been added to
1981 give more control over the treatment of old blank lines in
1982 a script. The manual has been revised to discuss the new
1983 flag and clarify the treatment of old blank lines. Thanks
1988 -Improved support for perl 5.10: New quote modifier 'p', new block type UNITCHECK,
1989 new keyword break, improved formatting of given/when.
1991 -Corrected tokenization bug of something like $var{-q}.
1993 -Numerous minor formatting improvements.
1995 -Corrected list of operators controlled by -baao -bbao to include
1996 . : ? && || and or err xor
1998 -Corrected very minor error in log file involving incorrect comment
1999 regarding need for upper case of labels.
2001 -Fixed problem where perltidy could run for a very long time
2002 when given certain non-perl text files.
2004 -Line breaks in un-parenthesized lists now try to follow
2005 line breaks in the input file rather than trying to fill
2006 lines. This usually works better, but if this causes
2007 trouble you can use -iob to ignore any old line breaks.
2008 Example for the following input snippet:
2011 "conformability (Not the same dimension)\n",
2012 "\t", $have, " is ", text_unit($hu), "\n",
2013 "\t", $want, " is ", text_unit($wu), "\n",
2017 print "conformability (Not the same dimension)\n", "\t", $have, " is ",
2018 text_unit($hu), "\n", "\t", $want, " is ", text_unit($wu), "\n",;
2021 print "conformability (Not the same dimension)\n",
2022 "\t", $have, " is ", text_unit($hu), "\n",
2023 "\t", $want, " is ", text_unit($wu), "\n",
2028 -Added -fpsc option (--fixed-position-side-comment). Thanks to Ueli Hugenschmidt.
2029 For example -fpsc=40 tells perltidy to put side comments in column 40
2032 -Added -bbao and -baao options (--break-before-all-operators and
2033 --break-after-all-operators) to simplify command lines and configuration
2034 files. These define an initial preference for breaking at operators which can
2035 be modified with -wba and -wbb flags. For example to break before all operators
2036 except an = one could use --bbao -wba='=' rather than listing every
2037 single perl operator (except =) on a -wbb flag.
2039 -Added -kis option (--keep-interior-semicolons). Use the B<-kis> flag
2040 to prevent breaking at a semicolon if there was no break there in the
2041 input file. To illustrate, consider the following input lines:
2043 dbmclose(%verb_delim); undef %verb_delim;
2044 dbmclose(%expanded); undef %expanded;
2045 dbmclose(%global); undef %global;
2047 Normally these would be broken into six lines, but
2048 perltidy -kis gives:
2050 dbmclose(%verb_delim); undef %verb_delim;
2051 dbmclose(%expanded); undef %expanded;
2052 dbmclose(%global); undef %global;
2054 -Improved formatting of complex ternary statements, with indentation
2055 of nested statements.
2057 return defined( $cw->{Selected} )
2059 ? @{ $cw->{Selected} }
2060 : $cw->{Selected}[0]
2064 return defined( $cw->{Selected} )
2066 ? @{ $cw->{Selected} }
2067 : $cw->{Selected}[0]
2070 -Text following un-parenthesized if/unless/while/until statements get a
2071 full level of indentation. Suggested by Jeff Armstrong and others.
2073 return $ship->chargeWeapons("phaser-canon")
2074 if $encounter->description eq 'klingon'
2075 and $ship->firepower >= $encounter->firepower
2076 and $location->status ne 'neutral';
2078 return $ship->chargeWeapons("phaser-canon")
2079 if $encounter->description eq 'klingon'
2080 and $ship->firepower >= $encounter->firepower
2081 and $location->status ne 'neutral';
2085 -Fixed bug where #line directives were being indented. Thanks to
2090 -Fixed problem where an extra blank line was added after an =cut when either
2091 (a) the =cut started (not stopped) a POD section, or (b) -mbl > 1.
2092 Thanks to J. Robert Ray and Bill Moseley.
2096 -ole (--output-line-ending) and -ple (--preserve-line-endings) should
2097 now work on all systems rather than just unix systems. Thanks to Dan
2100 -Fixed problem of a warning issued for multiple subs for BEGIN subs
2101 and other control subs. Thanks to Heiko Eissfeldt.
2103 -Fixed problem where no space was introduced between a keyword or
2104 bareword and a colon, such as:
2106 ( ref($result) eq 'HASH' && !%$result ) ? undef: $result;
2110 -Added a utility program 'break_long_quotes.pl' to the examples directory of
2111 the distribution. It breaks long quoted strings into a chain of concatenated
2112 sub strings no longer than a selected length. Suggested by Michael Renner as
2113 a perltidy feature but was judged to be best done in a separate program.
2115 -Updated docs to remove extra < and >= from list of tokens
2116 after which breaks are made by default. Thanks to Bob Kleemann.
2118 -Removed improper uses of $_ to avoid conflicts with external calls, giving
2119 error message similar to:
2120 Modification of a read-only value attempted at
2121 /usr/share/perl5/Perl/Tidy.pm line 6907.
2122 Thanks to Michael Renner.
2124 -Fixed problem when errorfile was not a plain filename or filehandle
2125 in a call to Tidy.pm. The call
2126 perltidy(source => \$input, destination => \$output, errorfile => \$err);
2127 gave the following error message:
2128 Not a GLOB reference at /usr/share/perl5/Perl/Tidy.pm line 3827.
2129 Thanks to Michael Renner and Phillipe Bruhat.
2131 -Fixed problem where -sot would not stack an opening token followed by
2132 a side comment. Thanks to Jens Schicke.
2134 -improved breakpoints in complex math and other long statements. Example:
2137 log($n) + 0.577215664901532 + ( 1 / ( 2 * $n ) ) -
2138 ( 1 / ( 12 * ( $n**2 ) ) ) + ( 1 / ( 120 * ( $n**4 ) ) );
2141 log($n) + 0.577215664901532 +
2142 ( 1 / ( 2 * $n ) ) -
2143 ( 1 / ( 12 * ( $n**2 ) ) ) +
2144 ( 1 / ( 120 * ( $n**4 ) ) );
2146 -more robust vertical alignment of complex terminal else blocks and ternary
2151 -Eliminated bug where a here-doc invoked through an 'e' modifier on a pattern
2152 replacement text was not recognized. The tokenizer now recursively scans
2153 replacement text (but does not reformat it).
2155 -improved vertical alignment of terminal else blocks and ternary statements.
2156 Thanks to Chris for the suggestion.
2159 if ( IsBitmap() ) { return GetBitmap(); }
2160 elsif ( IsFiles() ) { return GetFiles(); }
2161 else { return GetText(); }
2164 if ( IsBitmap() ) { return GetBitmap(); }
2165 elsif ( IsFiles() ) { return GetFiles(); }
2166 else { return GetText(); }
2170 $opts{"t"} ? 'title'
2171 : $opts{"s"} ? 'subject'
2172 : $opts{"a"} ? 'author'
2177 $opts{"t"} ? 'title'
2178 : $opts{"s"} ? 'subject'
2179 : $opts{"a"} ? 'author'
2182 -improved indentation of try/catch blocks and other externally defined
2183 functions accepting a block argument. Thanks to jae.
2185 -Added support for Perl 5.10 features say and smartmatch.
2187 -Added flag -pbp (--perl-best-practices) as an abbreviation for parameters
2188 suggested in Damian Conway's "Perl Best Practices". -pbp is the same as:
2190 -l=78 -i=4 -ci=4 -st -se -vt=2 -cti=0 -pt=1 -bt=1 -sbt=1 -bbt=1 -nsfs -nolq
2191 -wbb="% + - * / x != == >= <= =~ !~ < > | & >= < =
2192 **= += *= &= <<= &&= -= /= |= >>= ||= .= %= ^= x="
2194 Please note that the -st here restricts input to standard input; use
2195 -nst if necessary to override.
2197 -Eliminated some needless breaks at equals signs in -lp indentation.
2201 Math::Complex->make(LEFT + $x * (RIGHT - LEFT) / SIZE,
2202 TOP + $y * (BOTTOM - TOP) / SIZE);
2204 $c = Math::Complex->make(LEFT + $x * (RIGHT - LEFT) / SIZE,
2205 TOP + $y * (BOTTOM - TOP) / SIZE);
2207 A break at an equals is sometimes useful for preventing complex statements
2208 from hitting the line length limit. The decision to do this was
2209 over-eager in some cases and has been improved. Thanks to Royce Reece.
2211 -qw quotes contained in braces, square brackets, and parens are being
2212 treated more like those containers as far as stacking of tokens. Also
2213 stack of closing tokens ending ');' will outdent to where the ');' would
2214 have outdented if the closing stack is matched with a similar opening stack.
2216 OLD: perltidy -soc -sct
2217 __PACKAGE__->load_components(
2223 NEW: perltidy -soc -sct
2224 __PACKAGE__->load_components( qw(
2228 Thanks to Aran Deltac
2230 -Eliminated some undesirable or marginally desirable vertical alignments.
2231 These include terminal colons, opening braces, and equals, and particularly
2232 when just two lines would be aligned.
2235 my $accurate_timestamps = $Stamps{lnk};
2239 my $accurate_timestamps = $Stamps{lnk};
2242 -Corrected a problem with -mangle in which a space would be removed
2243 between a keyword and variable beginning with ::.
2247 -Attribute argument lists are now correctly treated as quoted strings
2248 and not formatted. This is the most important update in this version.
2249 Thanks to Borris Zentner, Greg Ferguson, Steve Kirkup.
2251 -Updated to recognize the defined or operator, //, to be released in Perl 10.
2252 Thanks to Sebastien Aperghis-Tramoni.
2254 -A useful utility perltidyrc_dump.pl is included in the examples section. It
2255 will read any perltidyrc file and write it back out in a standard format
2256 (though comments are lost).
2258 -Added option to have perltidy read and return a hash with the contents of a
2259 perltidyrc file. This may be used by Leif Eriksen's tidyview code. This
2260 feature is used by the demonstration program 'perltidyrc_dump.pl' in the
2263 -Improved error checking in perltidyrc files. Unknown bare words were not
2266 -The --dump-options parameter now dumps parameters in the format required by a
2269 -V-Strings with underscores are now recognized.
2270 For example: $v = v1.2_3;
2272 -cti=3 option added which gives one extra indentation level to closing
2273 tokens always. This provides more predictable closing token placement
2274 than cti=2. If you are using cti=2 you might want to try cti=3.
2276 -To identify all left-adjusted comments as static block comments, use C<-sbcp='^#'>.
2278 -New parameters -fs, -fsb, -fse added to allow sections of code between #<<<
2279 and #>>> to be passed through verbatim. This is enabled by default and turned
2280 off by -nfs. Flags -fsb and -fse allow other beginning and ending markers.
2281 Thanks to Wolfgang Werner and Marion Berryman for suggesting this.
2283 -added flag -skp to put a space between all Perl keywords and following paren.
2284 The default is to only do this for certain keywords. Suggested by
2287 -added flag -sfp to put a space between a function name and following paren.
2288 The default is not to do this. Suggested by H.Merijn Brand.
2290 -Added patch to avoid breaking GetOpt::Long::Configure set by calling program.
2291 Thanks to Philippe Bruhat.
2293 -An error was fixed in which certain parameters in a .perltidyrc file given
2294 without the equals sign were not recognized. That is,
2295 '--brace-tightness 0' gave an error but '--brace-tightness=0' worked
2296 ok. Thanks to Zac Hansen.
2298 -An error preventing the -nwrs flag from working was corrected. Thanks to
2301 -Corrected some alignment problems with entab option.
2303 -A bug with the combination of -lp and -extrude was fixed (though this
2304 combination doesn't really make sense). The bug was that a line with
2305 a single zero would be dropped. Thanks to Cameron Hayne.
2307 -Updated Windows detection code to avoid an undefined variable.
2308 Thanks to Joe Yates and Russ Jones.
2310 -Improved formatting for short trailing statements following a closing paren.
2311 Thanks to Joe Matarazzo.
2313 -The handling of the -icb (indent closing block braces) flag has been changed
2314 slightly to provide more consistent and predictable formatting of complex
2315 structures. Instead of giving a closing block brace the indentation of the
2316 previous line, it is now given one extra indentation level. The two methods
2317 give the same result if the previous line was a complete statement, as in this
2326 The change also fixes a problem with empty blocks such as:
2336 -A problem with -icb was fixed in which a closing brace was misplaced when
2337 it followed a quote which spanned multiple lines.
2339 -Some improved breakpoints for -wba='&& || and or'
2341 -Fixed problem with misaligned cuddled else in complex statements
2342 when the -bar flag was also used. Thanks to Alex and Royce Reese.
2344 -Corrected documentation to show that --outdent-long-comments is the default.
2345 Thanks to Mario Lia.
2347 -New flag -otr (opening-token-right) is similar to -bar (braces-always-right)
2348 but applies to non-structural opening tokens.
2350 -new flags -sot (stack-opening-token), -sct (stack-closing-token).
2355 -The default has been changed to not do syntax checking with perl.
2356 Use -syn if you want it. Perltidy is very robust now, and the -syn
2357 flag now causes more problems than it's worth because of BEGIN blocks
2358 (which get executed with perl -c). For example, perltidy will never
2359 return when trying to beautify this code if -syn is used:
2361 BEGIN { 1 while { }; }
2363 Although this is an obvious error, perltidy is often run on untested
2364 code which is more likely to have this sort of problem. A more subtle
2367 BEGIN { use FindBin; }
2369 which may hang on some systems using -syn if a shared file system is
2372 -Changed style -gnu to use -cti=1 instead of -cti=2 (see next item).
2373 In most cases it looks better. To recover the previous format, use
2376 -Added flags -cti=n for finer control of closing token indentation.
2377 -cti = 0 no extra indentation (default; same as -nicp)
2378 -cti = 1 enough indentation so that the closing token
2379 aligns with its opening token.
2380 -cti = 2 one extra indentation level if the line has the form
2381 ); ]; or }; (same as -icp).
2383 The new option -cti=1 works well with -lp:
2387 # perltidy -lp -cti=1
2389 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
2390 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
2393 # perltidy -lp -cti=2
2395 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
2396 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
2398 This is backwards compatible with -icp. See revised manual for
2399 details. Suggested by Mike Pennington.
2401 -Added flag '--preserve-line-endings' or '-ple' to cause the output
2402 line ending to be the same as in the input file, for unix, dos,
2403 or mac line endings. Only works under unix. Suggested by
2406 -Added flag '--output-line-ending=s' or '-ole=s' where s=dos or win,
2407 unix, or mac. Only works under unix.
2409 -Files with Mac line endings should now be handled properly under unix
2410 and dos without being passed through a converter.
2412 -You may now include 'and', 'or', and 'xor' in the list following
2413 '--want-break-after' to get line breaks after those keywords rather than
2414 before them. Suggested by Rainer Hochschild.
2416 -Corrected problem with command line option for -vtc=n and -vt=n. The
2417 equals sign was being eaten up by the Windows shell so perltidy didn't
2422 -Corrected cause of warning message with recent versions of Perl:
2423 "Possible precedence problem on bitwise & operator at ..."
2424 Thanks to Jim Files.
2426 -fixed bug with -html with '=for pod2html' sections, in which code/pod
2427 output order was incorrect. Thanks to Tassilo von Parseval.
2429 -fixed bug when the -html flag is used, in which the following error
2430 message, plus others, appear:
2431 did not see <body> in pod2html output
2432 This was caused by a change in the format of html output by pod2html
2433 VERSION 1.04 (included with perl 5.8). Thanks to Tassilo von Parseval.
2435 -Fixed bug where an __END__ statement would be mistaken for a label
2436 if it is immediately followed by a line with a leading colon. Thanks
2439 -Implemented guessing logic for brace types when it is ambiguous. This
2440 has been on the TODO list a long time. Thanks to Boris Zentner for
2443 -Long options may now be negated either as '--nolong-option'
2444 or '--no-long-option'. Thanks to Philip Newton for the suggestion.
2446 -added flag --html-entities or -hent which controls the use of
2447 Html::Entities for html formatting. Use --nohtml-entities or -nhent to
2448 prevent the use of Html::Entities to encode special symbols. The
2449 default is -hent. Html::Entities when formatting perl text to escape
2450 special symbols. This may or may not be the right thing to do,
2451 depending on browser/language combinations. Thanks to Burak Gursoy for
2454 -Bareword strings with leading '-', like, '-foo' now count as 1 token
2455 for horizontal tightness. This way $a{'-foo'}, $a{foo}, and $a{-foo}
2456 are now all treated similarly. Thus, by default, OLD: $a{ -foo } will
2457 now be NEW: $a{-foo}. Suggested by Mark Olesen.
2459 -added 2 new flags to control spaces between keywords and opening parens:
2460 -sak=s or --space-after-keyword=s, and
2461 -nsak=s or --nospace-after-keyword=s, where 's' is a list of keywords.
2463 The new default list of keywords which get a space is:
2465 "my local our and or eq ne if else elsif until unless while for foreach
2466 return switch case given when"
2468 Use -sak=s and -nsak=s to add and remove keywords from this list,
2471 Explanation: Stephen Hildrey noted that perltidy was being inconsistent
2472 in placing spaces between keywords and opening parens, and sent a patch
2473 to give user control over this. The above list was selected as being
2474 a reasonable default keyword list. Previously, perltidy
2475 had a hardwired list which also included these keywords:
2477 push pop shift unshift join split die
2479 but did not have 'our'. Example: if you prefer to make perltidy behave
2480 exactly as before, you can include the following two lines in your
2483 -sak="push pop local shift unshift join split die"
2486 -Corrected html error in .toc file when -frm -html is used (extra ");
2487 browsers were tolerant of it.
2489 -Improved alignment of chains of binary and ?/: operators. Example:
2503 -improved breakpoint choices involving '->'
2505 -Corrected tokenization of things like ${#}. For example,
2506 ${#} is valid, but ${# } is a syntax error.
2508 -Corrected minor tokenization errors with indirect object notation.
2509 For example, 'new A::()' works now.
2511 -Minor tokenization improvements; all perl code distributed with perl 5.8
2512 seems to be parsed correctly except for one instance (lextest.t)
2517 -Implemented scalar attributes. Thanks to Sean Tobin for noting this.
2519 -Fixed glitch introduced in previous release where -pre option
2520 was not outputting a leading html <pre> tag.
2522 -Numerous minor improvements in vertical alignment, including the following:
2524 -Improved alignment of opening braces in many cases. Needed for improved
2525 switch/case formatting, and also suggested by Mark Olesen for sort/map/grep
2526 formatting. For example:
2531 sort { $a->[1] <=> $b->[1] }
2532 map { [ $_, -M ] } @filenames;
2537 sort { $a->[1] <=> $b->[1] }
2538 map { [ $_, -M ] } @filenames;
2540 -Eliminated alignments across unrelated statements. Example:
2542 $borrowerinfo->configure( -state => 'disabled' );
2543 $borrowerinfo->grid( -col => 1, -row => 0, -sticky => 'w' );
2546 $borrowerinfo->configure( -state => 'disabled' );
2547 $borrowerinfo->grid( -col => 1, -row => 0, -sticky => 'w' );
2549 Thanks to Mark Olesen for suggesting this.
2551 -Improved alignement of '='s in certain cases.
2552 Thanks to Norbert Gruener for sending an example.
2554 -Outdent-long-comments (-olc) has been re-instated as a default, since
2555 it works much better now. Use -nolc if you want to prevent it.
2557 -Added check for 'perltidy file.pl -o file.pl', which causes file.pl
2558 to be lost. (The -b option should be used instead). Thanks to mreister
2559 for reporting this problem.
2563 -Switch/case or given/when syntax is now recognized. Its vertical alignment
2564 is not great yet, but it parses ok. The words 'switch', 'case', 'given',
2565 and 'when' are now treated as keywords. If this causes trouble with older
2566 code, we could introduce a switch to deactivate it. Thanks to Stan Brown
2567 and Jochen Schneider for recommending this.
2569 -Corrected error parsing sub attributes with call parameters.
2570 Thanks to Marc Kerr for catching this.
2572 -Sub prototypes no longer need to be on the same line as sub names.
2574 -a new flag -frm or --frames will cause html output to be in a
2575 frame, with table of contents in the left panel and formatted source
2576 in the right panel. Try 'perltidy -html -frm somemodule.pm' for example.
2578 -The new default for -html formatting is to pass the pod through Pod::Html.
2579 The result is syntax colored code within your pod documents. This can be
2580 deactivated with -npod. Thanks to those who have written to discuss this,
2581 particularly Mark Olesen and Hugh Myers.
2583 -the -olc (--outdent-long-comments) option works much better. It now outdents
2584 groups of consecutive comments together, and by just the amount needed to
2585 avoid having any one line exceeding the maximum line length.
2587 -block comments are now trimmed of trailing whitespace.
2589 -if a directory specified with -opath does not exist, it will be created.
2591 -a table of contents to packages and subs is output when -html is used.
2592 Use -ntoc to prevent this.
2594 -fixed an unusual bug in which a 'for' statement following a 'format'
2595 statement was not correctly tokenized. Thanks to Boris Zentner for
2598 -Tidy.pm is no longer dependent on modules IO::Scalar and IO::ScalarArray.
2599 There were some speed issues. Suggested by Joerg Walter.
2601 -The treatment of quoted wildcards (file globs) is now system-independent.
2604 perltidy 'b*x.p[lm]'
2606 would match box.pl, box.pm, brinx.pm under any operating system. Of
2607 course, anything unquoted will be subject to expansion by any shell.
2609 -default color for keywords under -html changed from
2610 SaddleBrown (#8B4513) to magenta4 (#8B008B).
2612 -fixed an arg parsing glitch in which something like:
2614 would trigger the help message and exit, rather than operate on the
2619 -New option '-b' or '--backup-and-modify-in-place' will cause perltidy to
2620 overwrite the original file with the tidied output file. The original
2621 file will be saved with a '.bak' extension (which can be changed with
2622 -bext=s). Thanks to Rudi Farkas for the suggestion.
2624 -An index to all subs is included at the top of -html output, unless
2625 only the <pre> section is written.
2627 -Anchor lines of the form <a name="mysub"></a> are now inserted at key points
2628 in html output, such as before sub definitions, for the convenience of
2629 postprocessing scripts. Suggested by Howard Owen.
2631 -The cuddled-else (-ce) flag now also makes cuddled continues, like
2634 while ( ( $pack, $file, $line ) = caller( $i++ ) ) {
2640 Suggested by Simon Perreault.
2642 -Fixed bug in which an extra blank line was added before an =head or
2643 similar pod line after an __END__ or __DATA__ line each time
2644 perltidy was run. Also, an extra blank was being added after
2645 a terminal =cut. Thanks to Mike Birdsall for reporting this.
2649 -Fixed bug in which space was inserted in a hyphenated hash key:
2650 my $val = $myhash{USER-NAME};
2652 my $val = $myhash{USER -NAME};
2653 Thanks to an anonymous bug reporter at sourceforge.
2655 -Fixed problem with the '-io' ('--indent-only') where all lines
2656 were double spaced. Thanks to Nick Andrew for reporting this bug.
2658 -Fixed tokenization error in which something like '-e1' was
2661 -Corrected a rare problem involving older perl versions, in which
2662 a line break before a bareword caused problems with 'use strict'.
2663 Thanks to Wolfgang Weisselberg for noting this.
2665 -More syntax error checking added.
2667 -Outdenting labels (-ola) has been made the default, in order to follow the
2668 perlstyle guidelines better. It's probably a good idea in general, but
2669 if you do not want this, use -nola in your .perltidyrc file.
2671 -Updated rules for padding logical expressions to include more cases.
2672 Thanks to Wolfgang Weisselberg for helpful discussions.
2674 -Added new flag -osbc (--outdent-static-block-comments) which will
2675 outdent static block comments by 2 spaces (or whatever -ci equals).
2676 Requested by Jon Robison.
2680 -Corrected a bug, introduced in the previous release, in which some
2681 closing side comments (-csc) could have incorrect text. This is
2682 annoying but will be correct the next time perltidy is run with -csc.
2684 -Fixed bug where whitespace was being removed between 'Bar' and '()'
2685 in a use statement like:
2689 -Whenever possible, if a logical expression is broken with leading
2690 '&&', '||', 'and', or 'or', then the leading line will be padded
2691 with additional space to produce alignment. This has been on the
2692 todo list for a long time; thanks to Frank Steinhauer for reminding
2693 me to do it. Notice the first line after the open parens here:
2697 !param("rules.to.$linecount")
2698 && !param("rules.from.$linecount")
2699 && !param("rules.subject.$linecount")
2701 param("rules.fieldname.$linecount")
2702 && param("rules.fieldval.$linecount")
2704 && !param("rules.size.$linecount")
2705 && !param("rules.custom.$linecount")
2710 !param("rules.to.$linecount")
2711 && !param("rules.from.$linecount")
2712 && !param("rules.subject.$linecount")
2714 param("rules.fieldname.$linecount")
2715 && param("rules.fieldval.$linecount")
2717 && !param("rules.size.$linecount")
2718 && !param("rules.custom.$linecount")
2723 -Corrected a mistokenization of variables for a package with a name
2724 equal to a perl keyword. For example:
2728 sub qx{print "Hello from my::qx\n";}
2730 In this case, the leading 'my' was mistokenized as a keyword, and a
2731 space was being place between 'my' and '::'. This has been
2732 corrected. Thanks to Martin Sluka for discovering this.
2734 -A new flag -bol (--break-at-old-logic-breakpoints)
2735 has been added to control whether containers with logical expressions
2736 should be broken open. This is the default.
2738 -A new flag -bok (--break-at-old-keyword-breakpoints)
2739 has been added to follow breaks at old keywords which return lists,
2740 such as sort and map. This is the default.
2742 -A new flag -bot (--break-at-old-trinary-breakpoints) has been added to
2743 follow breaks at trinary (conditional) operators. This is the default.
2745 -A new flag -cab=n has been added to control breaks at commas after
2746 '=>' tokens. The default is n=1, meaning break unless this breaks
2747 open an existing on-line container.
2749 -A new flag -boc has been added to allow existing list formatting
2750 to be retained. (--break-at-old-comma-breakpoints). See updated manual.
2752 -A new flag -iob (--ignore-old-breakpoints) has been added to
2753 prevent the locations of old breakpoints from influencing the output
2756 -Corrected problem where nested parentheses were not getting full
2757 indentation. This has been on the todo list for some time; thanks
2758 to Axel Rose for a snippet demonstrating this issue.
2760 OLD: inner list is not indented
2764 $ret->name, $user->username, $user->host,
2765 $user->server->name, $user->nick, "H"
2773 $ret->name, $user->username, $user->host,
2774 $user->server->name, $user->nick, "H"
2778 -Code cleaned up by removing the following unused, undocumented flags.
2779 They should not be in any .perltidyrc files because they were just
2780 experimental flags which were never documented. Most of them placed
2781 artificial limits on spaces, and Wolfgang Weisselberg convinced me that
2782 most of them they do more harm than good by causing unexpected results.
2784 --maximum-continuation-indentation (-mci)
2785 --maximum-whitespace-columns
2786 --maximum-space-to-comment (-xsc)
2787 --big-space-jump (-bsj)
2789 -Pod file 'perltidy.pod' has been appended to the script 'perltidy', and
2790 Tidy.pod has been append to the module 'Tidy.pm'. Older MakeMaker's
2791 were having trouble.
2793 -A new flag -isbc has been added for more control on comments. This flag
2794 has the effect that if there is no leading space on the line, then the
2795 comment will not be indented, and otherwise it may be. If both -ibc and
2796 -isbc are set, then -isbc takes priority. Thanks to Frank Steinhauer
2797 for suggesting this.
2799 -A new document 'stylekey.pod' has been created to quickly guide new users
2800 through the maze of perltidy style parameters. An html version is
2801 on the perltidy web page. Take a look! It should be very helpful.
2803 -Parameters for controlling 'vertical tightness' have been added:
2804 -vt and -vtc are the main controls, but finer control is provided
2805 with -pvt, -pcvt, -bvt, -bcvt, -sbvt, -sbcvt. Block brace vertical
2806 tightness controls have also been added.
2807 See updated manual and also see 'stylekey.pod'. Simple examples:
2809 # perltidy -lp -vt=1 -vtc=1
2810 @month_of_year = ( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
2811 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec' );
2813 # perltidy -lp -vt=1 -vtc=0
2814 @month_of_year = ( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
2815 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
2818 -Lists which do not format well in uniform columns are now better
2819 identified and formated.
2822 return $c->create( 'polygon', $x, $y, $x + $ruler_info{'size'},
2823 $y + $ruler_info{'size'}, $x - $ruler_info{'size'},
2824 $y + $ruler_info{'size'} );
2829 $x + $ruler_info{'size'},
2830 $y + $ruler_info{'size'},
2831 $x - $ruler_info{'size'},
2832 $y + $ruler_info{'size'}
2836 radlablist($f1, pad('Initial', $p), $b->{Init}->get_panel_ref, 'None ',
2837 'None', 'Default', 'Default', 'Simple', 'Simple');
2841 $b->{Init}->get_panel_ref,
2842 'None ', 'None', 'Default', 'Default', 'Simple', 'Simple');
2844 -Corrected problem where an incorrect html filename was generated for
2845 external calls to Tidy.pm module. Fixed incorrect html title when
2846 Tidy.pm is called with IO::Scalar or IO::Array source.
2848 -Output file permissions are now set as follows. An output script file
2849 gets the same permission as the input file, except that owner
2850 read/write permission is added (otherwise, perltidy could not be
2851 rerun). Html output files use system defaults. Previously chmod 0755
2852 was used in all cases. Thanks to Mark Olesen for bringing this up.
2854 -Missing semicolons will not be added in multi-line blocks of type
2855 sort, map, or grep. This brings perltidy into closer agreement
2856 with common practice. Of course, you can still put semicolons
2857 there if you like. Thanks to Simon Perreault for a discussion of this.
2859 -Most instances of extra semicolons are now deleted. This is
2860 particularly important if the -csc option is used. Thanks to Wolfgang
2861 Weisselberg for noting this. For example, the following line
2862 (produced by 'h2xs' :) has an extra semicolon which will now be
2865 BEGIN { plan tests => 1 };
2867 -New parameter -csce (--closing-side-comment-else-flag) can be used
2868 to control what text is appended to 'else' and 'elsif' blocks.
2869 Default is to just add leading 'if' text to an 'else'. See manual.
2871 -The -csc option now labels 'else' blocks with additinal information
2872 from the opening if statement and elsif statements, if space.
2873 Thanks to Wolfgang Weisselberg for suggesting this.
2875 -The -csc option will now remove any old closing side comments
2876 below the line interval threshold. Thanks to Wolfgang Weisselberg for
2879 -The abbreviation feature, which was broken in the previous version,
2880 is now fixed. Thanks to Michael Cartmell for noting this.
2882 -Vertical alignment is now done for '||=' .. somehow this was
2887 -This version uses modules for the first time, and a standard perl
2888 Makefile.PL has been supplied. However, perltidy may still be
2889 installed as a single script, without modules. See INSTALL for
2892 -The man page 'perl2web' has been merged back into the main 'perltidy'
2893 man page to simplify installation. So you may remove that man page
2894 if you have an older installation.
2896 -Added patch from Axel Rose for MacPerl. The patch prompts the user
2897 for command line arguments before calling the module
2898 Perl::Tidy::perltidy.
2900 -Corrected bug with '-bar' which was introduced in the previous
2901 version. A closing block brace was being indented. Thanks to
2902 Alexandros M Manoussakis for reporting this.
2904 -New parameter '--entab-leading-whitespace=n', or '-et=n', has been
2905 added for those who prefer tabs. This behaves different from the
2906 existing '-t' parameter; see updated man page. Suggested by Mark
2909 -New parameter '--perl-syntax-check-flags=s' or '-pcsf=s' can be
2910 used to change the flags passed to perltidy in a syntax check.
2911 See updated man page. Suggested by Mark Olesen.
2913 -New parameter '--output-path=s' or '-opath=s' will cause output
2914 files to be placed in directory s. See updated man page. Thanks for
2915 Mark Olesen for suggesting this.
2917 -New parameter --dump-profile (or -dpro) will dump to
2918 standard output information about the search for a
2919 configuration file, the name of whatever configuration file
2920 is selected, and its contents. This should help debugging
2921 config files, especially on different Windows systems.
2923 -The -w parameter now notes possible errors of the form:
2925 $comment = s/^\s*(\S+)\..*/$1/; # trim whitespace
2927 -Corrections added for a leading ':' and for leaving a leading 'tcsh'
2928 line untouched. Mark Olesen reported that lines of this form were
2929 accepted by perl but not by perltidy:
2931 : # use -*- perl -*-
2932 eval 'exec perl -wS $0 "$@"' # shell should exec 'perl'
2933 unless 1; # but Perl should skip this one
2935 Perl will silently swallow a leading colon on line 1 of a
2936 script, and now perltidy will do likewise. For example,
2937 this is a valid script, provided that it is the first line,
2940 : print "Hello World\n";
2942 Also, perltidy will now mark a first line with leading ':' followed by
2943 '#' as type SYSTEM (just as a #! line), not to be formatted.
2945 -List formatting improved for certain lists with special
2946 initial terms, such as occur with 'printf', 'sprintf',
2947 'push', 'pack', 'join', 'chmod'. The special initial term is
2948 now placed on a line by itself. For example, perltidy -gnu
2952 "C4", hex($SourceAddr[0]),
2953 hex($SourceAddr[1]), hex($SourceAddr[2]),
2959 hex($SourceAddr[0]), hex($SourceAddr[1]),
2960 hex($SourceAddr[2]), hex($SourceAddr[3]));
2964 @{$$self{states}}, '64', '66', '68',
2965 '70', '72', '74', '76',
2966 '78', '80', '82', '84',
2967 '86', '88', '90', '92',
2968 '94', '96', '98', '100',
2975 '64', '66', '68', '70', '72', '74', '76',
2976 '78', '80', '82', '84', '86', '88', '90',
2977 '92', '94', '96', '98', '100', '102', '104'
2980 -Lists of complex items, such as matricies, are now detected
2981 and displayed with just one item per row:
2984 $this->{'CURRENT'}{'gfx'}{'MatrixSkew'} = Text::PDF::API::Matrix->new(
2985 [ 1, tan( deg2rad($a) ), 0 ], [ tan( deg2rad($b) ), 1, 0 ],
2990 $this->{'CURRENT'}{'gfx'}{'MatrixSkew'} = Text::PDF::API::Matrix->new(
2991 [ 1, tan( deg2rad($a) ), 0 ],
2992 [ tan( deg2rad($b) ), 1, 0 ],
2996 -The perl syntax check will be turned off for now when input is from
2997 standard input or standard output. The reason is that this requires
2998 temporary files, which has produced far too many problems during
2999 Windows testing. For example, the POSIX module under Windows XP/2000
3000 creates temporary names in the root directory, to which only the
3001 administrator should have permission to write.
3003 -Merged patch sent by Yves Orton to handle appropriate
3004 configuration file locations for different Windows varieties
3005 (2000, NT, Me, XP, 95, 98).
3007 -Added patch to properly handle a for/foreach loop without
3008 parens around a list represented as a qw. I didn't know this
3009 was possible until Wolfgang Weisselberg pointed it out:
3011 foreach my $key qw\Uno Due Tres Quadro\ {
3015 But Perl will give a syntax error without the $ variable; ie this will
3018 foreach qw\Uno Due Tres Quadro\ {
3022 -Merged Windows version detection code sent by Yves Orton. Perltidy
3023 now automatically turns off syntax checking for Win 9x/ME versions,
3024 and this has solved a lot of robustness problems. These systems
3025 cannot reliably handle backtick operators. See man page for
3028 -Merged VMS filename handling patch sent by Michael Cartmell. (Invalid
3029 output filenames were being created in some cases).
3031 -Numerous minor improvements have been made for -lp style indentation.
3033 -Long C-style 'for' expressions will be broken after each ';'.
3035 'perltidy -gnu' gives:
3038 for ($status = $db->seq($key, $value, R_CURSOR()) ; $status == 0
3039 and $key eq $origkey ; $status = $db->seq($key, $value, R_NEXT()))
3042 for ($status = $db->seq($key, $value, R_CURSOR()) ;
3043 $status == 0 and $key eq $origkey ;
3044 $status = $db->seq($key, $value, R_NEXT()))
3046 -For the -lp option, a single long term within parens
3047 (without commas) now has better alignment. For example,
3051 $self->throw("Must specify a known host, not $location,"
3052 . " possible values ("
3053 . join (",", sort keys %hosts) . ")");
3056 $self->throw("Must specify a known host, not $location,"
3057 . " possible values ("
3058 . join (",", sort keys %hosts) . ")");
3062 -This version is about 20 percent faster than the previous
3063 version as a result of optimization work. The largest gain
3064 came from switching to a dispatch hash table in the
3067 -perltidy -html will check to see if HTML::Entities is
3068 installed, and if so, it will use it to encode unsafe
3071 -Added flag -oext=ext to change the output file extension to
3072 be different from the default ('tdy' or 'html'). For
3075 perltidy -html -oext=htm filename
3077 will produce filename.htm
3079 -Added flag -cscw to issue warnings if a closing side comment would replace
3080 an existing, different side comments. See the man page for details.
3081 Thanks to Peter Masiar for helpful discussions.
3083 -Corrected tokenization error of signed hex/octal/binary numbers. For
3084 example, the first hex number below would have been parsed correctly
3085 but the second one was not:
3086 if ( ( $tmp >= 0x80_00_00 ) || ( $tmp < -0x80_00_00 ) ) { }
3088 -'**=' was incorrectly tokenized as '**' and '='. This only
3089 caused a problem with the -extrude opton.
3091 -Corrected a divide by zero when -extrude option is used
3093 -The flag -w will now contain all errors reported by 'perl -c' on the
3094 input file, but otherwise they are not reported. The reason is that
3095 perl will report lots of problems and syntax errors which are not of
3096 interest when only a small snippet is being formatted (such as missing
3097 modules and unknown bare words). Perltidy will always report all
3098 significant syntax errors that it finds, such as unbalanced braces,
3099 unless the -q (quiet) flag is set.
3101 -Merged modifications created by Hugh Myers into perltidy.
3102 These include a 'streamhandle' routine which allows perltidy
3103 as a module to operate on input and output arrays and strings
3104 in addition to files. Documentation and new packaging as a
3105 module should be ready early next year; This is an elegant,
3106 powerful update; many thanks to Hugh for contributing it.
3110 -added a tentative patch which tries to keep any existing breakpoints
3111 at lines with leading keywords map,sort,eval,grep. The idea is to
3112 improve formatting of sequences of list operations, as in a schwartzian
3116 my @sorted = map { $_->[0] }
3117 sort { $a->[1] <=> $b->[1] }
3118 map { [ $_, rand ] } @list;
3122 map { $_->[0] } sort { $a->[1] <=> $b->[1] } map { [ $_, rand ] } @list;
3125 my @sorted = map { $_->[0] }
3126 sort { $a->[1] <=> $b->[1] }
3127 map { [ $_, rand ] } @list;
3129 The new alignment is not as nice as the input, but this is an improvement.
3130 Thanks to Yves Orton for this suggestion.
3132 -modified indentation logic so that a line with leading opening paren,
3133 brace, or square bracket will never have less indentation than the
3134 line with the corresponding opening token. Here's a simple example:
3138 -text => "New Document",
3139 -command => \&new_document
3145 Note how the closing ');' is lined up with the first line, even
3146 though it closes a paren in the 'pack' line. That seems wrong.
3150 -text => "New Document",
3151 -command => \&new_document
3157 This seems nicer: you can up-arrow with an editor and arrive at the
3158 opening 'pack' line.
3160 -corrected minor glitch in which cuddled else (-ce) did not get applied
3161 to an 'unless' block, which should look like this:
3169 Thanks to Jeremy Mates for reporting this.
3171 -The man page has been reorganized to parameters easier to find.
3173 -Added check for multiple definitions of same subroutine. It is easy
3174 to introduce this problem when cutting and pasting. Perl does not
3175 complain about it, but it can lead to disaster.
3177 -The command -pro=filename or -profile=filename may be used to specify a
3178 configuration file which will override the default name of .perltidyrc.
3179 There must not be a space on either side of the '=' sign. I needed
3180 this to be able to easily test perltidy with a variety of different
3181 configuration files.
3183 -Side comment alignment has been improved somewhat across frequent level
3184 changes, as in short if/else blocks. Thanks to Wolfgang Weisselberg
3185 for pointing out this problem. For example:
3188 if ( ref $self ) { # Called as a method
3191 else { # Regular procedure call
3197 if ( ref $self ) { # Called as a method
3200 else { # Regular procedure call
3205 -New command -ssc (--static-side-comment) and related command allows
3206 side comments to be spaced close to preceding character. This is
3207 useful for displaying commented code as side comments.
3209 -New command -csc (--closing-side-comment) and several related
3210 commands allow comments to be added to (and deleted from) any or all
3211 closing block braces. This can be useful if you have to maintain large
3212 programs, especially those that you didn't write. See updated man page.
3213 Thanks to Peter Masiar for this suggestion. For a simple example:
3218 if ( !defined( $_[0] ) ) {
3219 print("Hello, World\n");
3222 print( $_[0], "\n" );
3226 This added '## end sub foo' to the closing brace.
3227 To remove it, perltidy -ncsc.
3229 -New commands -ola, for outdenting labels, and -okw, for outdenting
3230 selected control keywords, were implemented. See the perltidy man
3231 page for details. Thanks to Peter Masiar for this suggestion.
3233 -Hanging side comment change: a comment will not be considered to be a
3234 hanging side comment if there is no leading whitespace on the line.
3235 This should improve the reliability of identifying hanging side comments.
3236 Thanks to Peter Masiar for this suggestion.
3238 -Two new commands for outdenting, -olq (outdent-long-quotes) and -olc
3239 (outdent-long-comments), have been added. The original -oll
3240 (outdent-long-lines) remains, and now is an abbreviation for -olq and -olc.
3241 The new default is just -olq. This was necessary to avoid inconsistency with
3242 the new static block comment option.
3244 -Static block comments: to provide a way to display commented code
3245 better, the convention is used that comments with a leading '##' should
3246 not be formatted as usual. Please see '-sbc' (or '--static-block-comment')
3247 for documentation. It can be deactivated with with -nsbc, but
3248 should not normally be necessary. Thanks to Peter Masiar for this
3251 -Two changes were made to help show structure of complex lists:
3252 (1) breakpoints are forced after every ',' in a list where any of
3253 the list items spans multiple lines, and
3254 (2) List items which span multiple lines now get continuation indentation.
3256 The following example illustrates both of these points. Many thanks to
3257 Wolfgang Weisselberg for this snippet and a discussion of it; this is a
3258 significant formatting improvement. Note how it is easier to see the call
3259 parameters in the NEW version:
3262 assert( __LINE__, ( not defined $check )
3265 or $check eq "old", "Error in parameters",
3266 defined $old_new ? ( ref $old_new ? ref $old_new : $old_new ) : "undef",
3267 defined $db_new ? ( ref $db_new ? ref $db_new : $db_new ) : "undef",
3268 defined $old_db ? ( ref $old_db ? ref $old_db : $old_db ) : "undef" );
3273 ( not defined $check )
3277 "Error in parameters",
3278 defined $old_new ? ( ref $old_new ? ref $old_new : $old_new ) : "undef",
3279 defined $db_new ? ( ref $db_new ? ref $db_new : $db_new ) : "undef",
3280 defined $old_db ? ( ref $old_db ? ref $old_db : $old_db ) : "undef"
3283 Another example shows how this helps displaying lists:
3286 %{ $self->{COMPONENTS} } = (
3288 { type => 'name', adj => 'yes', font => 'Helvetica', 'index' => 0 },
3290 { type => 'road', adj => 'yes', font => 'Helvetica', 'index' => 2 },
3293 The structure is clearer with the added indentation:
3296 %{ $self->{COMPONENTS} } = (
3298 { type => 'name', adj => 'yes', font => 'Helvetica', 'index' => 0 },
3300 { type => 'road', adj => 'yes', font => 'Helvetica', 'index' => 2 },
3303 -The structure of nested logical expressions is now displayed better.
3304 Thanks to Wolfgang Weisselberg for helpful discussions. For example,
3305 note how the status of the final 'or' is displayed in the following:
3309 and null( $op->sibling )
3310 and $op->ppaddr eq "pp_null"
3311 and class($op) eq "UNOP"
3312 and ( ( $op->first->ppaddr =~ /^pp_(and|or)$/
3313 and $op->first->first->sibling->ppaddr eq "pp_lineseq" )
3314 or ( $op->first->ppaddr eq "pp_lineseq"
3315 and not null $op->first->first->sibling
3316 and $op->first->first->sibling->ppaddr eq "pp_unstack" ) ) );
3321 and null( $op->sibling )
3322 and $op->ppaddr eq "pp_null"
3323 and class($op) eq "UNOP"
3326 $op->first->ppaddr =~ /^pp_(and|or)$/
3327 and $op->first->first->sibling->ppaddr eq "pp_lineseq"
3329 or ( $op->first->ppaddr eq "pp_lineseq"
3330 and not null $op->first->first->sibling
3331 and $op->first->first->sibling->ppaddr eq "pp_unstack" )
3335 -A break will always be put before a list item containing a comma-arrow.
3336 This will improve formatting of mixed lists of this form:
3340 'text', 225, 20, -text => 'A Simple Plot',
3348 -text => 'A Simple Plot',
3353 -For convenience, the command -dac (--delete-all-comments) now also
3354 deletes pod. Likewise, -tac (--tee-all-comments) now also sends pod
3355 to a '.TEE' file. Complete control over the treatment of pod and
3356 comments is still possible, as described in the updated help message
3359 -The logic which breaks open 'containers' has been rewritten to be completely
3360 symmetric in the following sense: if a line break is placed after an opening
3361 {, [, or (, then a break will be placed before the corresponding closing
3362 token. Thus, a container either remains closed or is completely cracked
3365 -Improved indentation of parenthesized lists. For example,
3370 atan2( $GPSTempCompLong - $GPSLongitude,
3371 $GPSLatitude - $GPSTempCompLat ) * 180 / 3.14159265 );
3374 $GPSCompCourse = int(
3376 $GPSTempCompLong - $GPSLongitude,
3377 $GPSLatitude - $GPSTempCompLat
3378 ) * 180 / 3.14159265
3381 Further improvements will be made in future releases.
3383 -Some improvements were made in formatting small lists.
3385 -Correspondence between Input and Output line numbers reported in a
3386 .LOG file should now be exact. They were sometimes off due to the size
3387 of intermediate buffers.
3389 -Corrected minor tokenization error in which a ';' in a foreach loop
3390 control was tokenized as a statement termination, which forced a
3403 foreach ( $i = 0 ; $i <= 10 ; $i += 2 ) {
3407 -Corrected a problem with reading config files, in which quote marks were not
3408 stripped. As a result, something like -wba="&& . || " would have the leading
3409 quote attached to the && and not work correctly. A workaround for older
3410 versions is to place a space around all tokens within the quotes, like this:
3413 -Removed any existing space between a label and its ':'
3416 This was necessary because the label and its colon are a single token.
3418 -Corrected tokenization error for the following (highly non-recommended)
3420 $user = @vars[1] / 100;
3422 -Resolved cause of a difference between perltidy under perl v5.6.1 and
3423 5.005_03; the problem was different behavior of \G regex position
3428 -Corrected a bug in which a break was not being made after a full-line
3429 comment within a short eval/sort/map/grep block. A flag was not being
3430 zeroed. The syntax error check catches this. Here is a snippet which
3431 illustrates the bug:
3434 #open Socket to Dispatcher
3435 $sock = &OpenSocket;
3438 The formatter mistakenly thought that it had found the following
3441 eval {#open Socket to Dispatcher$sock = &OpenSocket; };
3443 The patch fixes this. Many thanks to Henry Story for reporting this bug.
3445 -Changes were made to help diagnose and resolve problems in a
3447 (1) processing of command parameters has been into two separate
3448 batches so that any errors in a .perltidyrc file can be localized.
3449 (2) commands --help, --version, and as many of the --dump-xxx
3450 commands are handled immediately, without any command line processing
3452 (3) Perltidy will ignore any commands in the .perltidyrc file which
3453 cause immediate exit. These are: -h -v -ddf -dln -dop -dsn -dtt
3454 -dwls -dwrs -ss. Thanks to Wolfgang Weisselberg for helpful
3455 suggestions regarding these updates.
3457 -Syntax check has been reinstated as default for MSWin32 systems. This
3458 way Windows 2000 users will get syntax check by default, which seems
3459 like a better idea, since the number of Win 95/98 systems will be
3460 decreasing over time. Documentation revised to warn Windows 95/98
3461 users about the problem with empty '&1'. Too bad these systems
3462 all report themselves as MSWin32.
3466 -Fixed tokenization error in which a method call of the form
3470 got a space before the '::' like this:
3474 Thanks to David Holden for reporting this.
3476 -Added -html control over pod text, using a new abbreviation 'pd'. See
3477 updated perl2web man page. The default is to use the color of a comment,
3478 but italicized. Old .css style sheets will need a new line for
3479 .pd to use this. The old color was the color of a string, and there
3482 -.css lines are now printed in sorted order.
3484 -Fixed interpolation problem where html files had '$input_file' as title
3485 instead of actual input file name. Thanks to Simon Perreault for finding
3486 this and sending a patch, and also to Tobias Weber.
3488 -Breaks will now have the ':' placed at the start of a line,
3489 one per line by default because this shows logical structure
3490 more clearly. This coding has been completely redone. Some
3491 examples of new ?/: formatting:
3494 wantarray ? map( $dir::cwd->lookup($_)->path, @_ ) :
3495 $dir::cwd->lookup( $_[0] )->path;
3499 ? map( $dir::cwd->lookup($_)->path, @_ )
3500 : $dir::cwd->lookup( $_[0] )->path;
3506 } : { a => 6, b => 8 };
3514 : { a => 6, b => 8 };
3517 $self->note($self->{skip} ? "Hunk #$self->{hunk} ignored at 1.\n" :
3518 "Hunk #$self->{hunk} failed--$@");
3521 $self->note($self->{skip}
3522 ? "Hunk #$self->{hunk} ignored at 1.\n"
3523 : "Hunk #$self->{hunk} failed--$@");
3527 $opts{"t"} ? 'title' :
3528 $opts{"s"} ? 'subject' : $opts{"a"} ? 'author' : 'title';
3532 $opts{"t"} ? 'title'
3533 : $opts{"s"} ? 'subject'
3534 : $opts{"a"} ? 'author'
3537 You can use -wba=':' to recover the previous default which placed ':'
3538 at the end of a line. Thanks to Michael Cartmell for helpful
3539 discussions and examples.
3541 -Tokenizer updated to do syntax checking for matched ?/: pairs. Also,
3542 the tokenizer now outputs a unique serial number for every balanced
3543 pair of brace types and ?/: pairs. This greatly simplifies the
3546 -Long lines with repeated 'and', 'or', '&&', '||' will now have
3547 one such item per line. For example:
3550 if ( $opt_d || $opt_m || $opt_p || $opt_t || $opt_x
3551 || ( -e $archive && $opt_r ) )
3553 ( $pAr, $pNames ) = readAr($archive);
3562 || ( -e $archive && $opt_r ) )
3564 ( $pAr, $pNames ) = readAr($archive);
3568 if ( $vp->{X0} + 4 <= $x && $vp->{X0} + $vp->{W} - 4 >= $x
3569 && $vp->{Y0} + 4 <= $y && $vp->{Y0} + $vp->{H} - 4 >= $y )
3572 if ( $vp->{X0} + 4 <= $x
3573 && $vp->{X0} + $vp->{W} - 4 >= $x
3574 && $vp->{Y0} + 4 <= $y
3575 && $vp->{Y0} + $vp->{H} - 4 >= $y )
3577 -Long lines with multiple concatenated tokens will have concatenated
3578 terms (see below) placed one per line, except for short items. For
3583 "Device type:" . $ib->family . " ID:" . $ib->serial . " CRC:"
3584 . $ib->crc . ": " . $ib->model() . "\n";
3587 $report .= "Device type:"
3588 . $ib->family . " ID:"
3589 . $ib->serial . " CRC:"
3591 . $ib->crc . ": " . "\n";
3593 NOTE: at present 'short' means 8 characters or less. There is a
3594 tentative flag to change this (-scl), but it is undocumented and
3595 is likely to be changed or removed later, so only use it for testing.
3596 In the above example, the tokens " ID:", " CRC:", and "\n" are below
3599 -If a line which is short enough to fit on a single line was
3600 nevertheless broken in the input file at a 'good' location (see below),
3601 perltidy will try to retain a break. For example, the following line
3602 will be formatted as:
3605 or die "Cannot open $file ($!)";
3607 if it was broken in the input file, and like this if not:
3609 open SUM, "<$file" or die "Cannot open $file ($!)";
3611 GOOD: 'good' location means before 'and','or','if','unless','&&','||'
3613 The reason perltidy does not just always break at these points is that if
3614 there are multiple, similar statements, this would preclude alignment. So
3615 rather than check for this, perltidy just tries to follow the input style,
3616 in the hopes that the author made a good choice. Here is an example where
3617 we might not want to break before each 'if':
3619 ($Locale, @Locale) = ($English, @English) if (@English > @Locale);
3620 ($Locale, @Locale) = ($German, @German) if (@German > @Locale);
3621 ($Locale, @Locale) = ($French, @French) if (@French > @Locale);
3622 ($Locale, @Locale) = ($Spanish, @Spanish) if (@Spanish > @Locale);
3624 -Added wildcard file expansion for systems with shells which lack this.
3625 Now 'perltidy *.pl' should work under MSDOS/Windows. Thanks to Hugh Myers
3626 for suggesting this. This uses builtin glob() for now; I may change that.
3628 -Added new flag -sbl which, if specified, overrides the value of -bl
3629 for opening sub braces. This allows formatting of this type:
3635 if (!defined($_[0])) {
3636 print("Hello, World\n");
3642 Requested by Don Alexander.
3644 -Fixed minor parsing error which prevented a space after a $$ variable
3645 (pid) in some cases. Thanks to Michael Cartmell for noting this.
3650 -Improved line break choices 'and' and 'or' to display logic better.
3654 exists $self->{'build_dir'} and push @e,
3655 "Unwrapped into directory $self->{'build_dir'}";
3658 exists $self->{'build_dir'}
3659 and push @e, "Unwrapped into directory $self->{'build_dir'}";
3661 -Fixed error of multiple use of abbreviatioin '-dsc'. -dsc remains
3662 abbreviation for delete-side-comments; -dsm is new abbreviation for
3665 -Corrected and updated 'usage' help routine. Thanks to Slaven Rezic for
3668 -The default for Windows is, for now, not to do a 'perl -c' syntax
3669 check (but -syn will activate it). This is because of problems with
3670 command.com. James Freeman sent me a patch which tries to get around
3671 the problems, and it works in many cases, but testing revealed several
3672 issues that still need to be resolved. So for now, the default is no
3673 syntax check for Windows.
3675 -I added a -T flag when doing perl -c syntax check.
3676 This is because I test it on a large number of scripts from sources
3677 unknown, and who knows what might be hidden in initialization blocks?
3678 Also, deactivated the syntax check if perltidy is run as root. As a
3679 benign example, running the previous version of perltidy on the
3680 following file would cause it to disappear:
3683 print "Bye, bye baby!\n";
3687 The new version will not let that happen.
3689 -I am contemplating (but have not yet implemented) making '-lp' the
3690 default indentation, because it is stable now and may be closer to how
3691 perl is commonly formatted. This could be in the next release. The
3692 reason that '-lp' was not the original default is that the coding for
3693 it was complex and not ready for the initial release of perltidy. If
3694 anyone has any strong feelings about this, I'd like to hear. The
3695 current default could always be recovered with the '-nlp' flag.
3700 - sub definition names are now specially colored, red by default.
3701 The letter 'm' is used to identify them.
3702 - keyword 'sub' now has color of other keywords.
3703 - restored html keyword color to __END__ and __DATA__, which was
3704 accidentally removed in the previous version.
3706 -A new -se (--standard-error-output) flag has been implemented and
3707 documented which causes all errors to be written to standard output
3708 instead of a .ERR file.
3710 -A new -w (--warning-output) flag has been implemented and documented
3711 which causes perltidy to output certain non-critical messages to the
3712 error output file, .ERR. These include complaints about pod usage,
3713 for example. The default is to not include these.
3715 NOTE: This replaces an undocumented -w=0 or --warning-level flag
3716 which was tentatively introduced in the previous version to avoid some
3717 unwanted messages. The new default is the same as the old -w=0, so
3718 that is no longer needed.
3720 -Improved syntax checking and corrected tokenization of functions such
3721 as rand, srand, sqrt, ... These can accept either an operator or a term
3722 to their right. This has been corrected.
3724 -Corrected tokenization of semicolon: testing of the previous update showed
3725 that the semicolon in the following statement was being mis-tokenized. That
3726 did no harm, other than adding an extra blank space, but has been corrected.
3728 for (sort {strcoll($a,$b);} keys %investments) {
3732 -New syntax check: after wasting 5 minutes trying to resolve a syntax
3733 error in which I had an extra terminal ';' in a complex for (;;) statement,
3734 I spent a few more minutes adding a check for this in perltidy so it won't
3737 -The behavior of --break-before-subs (-bbs) and --break-before-blocks
3738 (-bbb) has been modified. Also, a new control parameter,
3739 --long-block-line-count=n (-lbl=n) has been introduced to give more
3740 control on -bbb. This was previously a hardwired value. The reason
3741 for the change is to reduce the number of unwanted blank lines that
3742 perltidy introduces, and make it less erratic. It's annoying to remove
3743 an unwanted blank line and have perltidy put it back. The goal is to
3744 be able to sprinkle a few blank lines in that dense script you
3745 inherited from Bubba. I did a lot of experimenting with different
3746 schemes for introducing blank lines before and after code blocks, and
3747 decided that there is no really good way to do it. But I think the new
3748 scheme is an improvement. You can always deactivate this with -nbbb.
3749 I've been meaning to work on this; thanks to Erik Thaysen for bringing
3752 -The .LOG file is seldom needed, and I get tired of deleting them, so
3753 they will now only be automatically saved if perltidy thinks that it
3754 made an error, which is almost never. You can still force the logfile
3755 to be saved with -log or -g.
3757 -Improved method for computing number of columns in a table. The old
3758 method always tried for an even number. The new method allows odd
3759 numbers when it is obvious that a list is not a hash initialization
3763 $name, $xsargs, $parobjs, $optypes,
3764 $hasp2child, $pmcode, $hdrcode, $inplacecode,
3765 $globalnew, $callcopy
3770 $name, $xsargs, $parobjs, $optypes, $hasp2child,
3771 $pmcode, $hdrcode, $inplacecode, $globalnew, $callcopy
3775 -I fiddled with the list threshold adjustment, and some small lists
3776 look better now. Here is the change for one of the lists in test file
3780 ("in", "in", "pt", "pt", "pc", "pi", "mm", "mm", "cm", "cm", "\\hsize", "%",
3781 "\\vsize", "%", "\\textwidth", "%", "\\textheight", "%");
3785 "in", "in", "pt", "pt", "pc", "pi",
3786 "mm", "mm", "cm", "cm", "\\hsize", "%",
3787 "\\vsize", "%", "\\textwidth", "%", "\\textheight", "%"
3790 -Improved -lp formatting at '=' sign. A break was always being added after
3791 the '=' sign in a statement such as this, (to be sure there was enough room
3792 for the parameters):
3797 $biblionumber, $constraint,
3801 The updated version doesn't do this unless the space is really needed:
3803 new: my $fee = CalcReserveFee(
3805 $biblionumber, $constraint,
3809 -I updated the tokenizer to allow $#+ and $#-, which seem to be new to
3810 Perl 5.6. Some experimenting with a recent version of Perl indicated
3811 that it allows these non-alphanumeric '$#' array maximum index
3812 variables: $#: $#- $#+ so I updated the parser accordingly. Only $#:
3813 seems to be valid in older versions of Perl.
3815 -Fixed a rare formatting problem with -lp (and -gnu) which caused
3816 excessive indentation.
3818 -Many additional syntax checks have been added.
3820 -Revised method for testing here-doc target strings; the following
3821 was causing trouble with a regex test because of the '*' characters:
3825 Perl seems to allow almost anything to be a here doc target, so an
3826 exact string comparison is now used.
3828 -Made update to allow underscores in binary numbers, like '0b1100_0000'.
3830 -Corrected problem with scanning certain module names; a blank space was
3831 being inserted after 'warnings' in the following:
3832 use warnings::register;
3833 The problem was that warnings (and a couple of other key modules) were
3834 being tokenized as keywords. They should have just been identifiers.
3836 -Corrected tokenization of indirect objects after sort, system, and exec,
3837 after testing produced an incorrect error message for the following
3839 print sort $sortsubref @list;
3841 -Corrected minor problem where a line after a format had unwanted
3842 extra continuation indentation.
3844 -Delete-block-comments (and -dac) now retain any leading hash-bang line
3846 -Update for -lp (and -gnu) to not align the leading '=' of a list
3847 with a previous '=', since this interferes with alignment of parameters.
3849 old: my $hireDay = new Date;
3856 new: my $hireDay = new Date;
3863 -Modifications made to display tables more compactly when possible,
3864 without adding lines. For example,
3866 '1', "I", '2', "II", '3', "III", '4', "IV",
3867 '5', "V", '6', "VI", '7', "VII", '8', "VIII",
3870 '1', "I", '2', "II", '3', "III",
3871 '4', "IV", '5', "V", '6', "VI",
3872 '7', "VII", '8', "VIII", '9', "IX"
3874 -Corrected minor bug in which -pt=2 did not keep the right paren tight
3875 around a '++' or '--' token, like this:
3877 for ($i = 0 ; $i < length $key ; $i++ )
3879 The formatting for this should be, and now is:
3881 for ($i = 0 ; $i < length $key ; $i++)
3883 Thanks to Erik Thaysen for noting this.
3885 -Discovered a new bug involving here-docs during testing! See BUGS.html.
3887 -Finally fixed parsing of subroutine attributes (A Perl 5.6 feature).
3888 However, the attributes and prototypes must still be on the same line
3893 -Corrected minor, uncommon bug found during routine testing, in which a
3894 blank got inserted between a function name and its opening paren after
3895 a file test operator, but only in the case that the function had not
3896 been previously seen. Perl uses the existence (or lack thereof) of
3897 the blank to guess if it is a function call. That is,
3898 if (-l pid_filename()) {
3900 if (-l pid_filename ()) {
3901 which is a syntax error if pid_filename has not been seen by perl.
3903 -If the AutoLoader module is used, perltidy will continue formatting
3904 code after seeing an __END__ line. Use -nlal to deactivate this feature.
3905 Likewise, if the SelfLoader module is used, perltidy will continue
3906 formatting code after seeing a __DATA__ line. Use -nlsl to
3907 deactivate this feature. Thanks to Slaven Rezic for this suggestion.
3909 -pod text after __END__ and __DATA__ is now identified by perltidy
3910 so that -dp works correctly. Thanks to Slaven Rezic for this suggestion.
3912 -The first $VERSION line which might be eval'd by MakeMaker
3913 is now passed through unchanged. Use -npvl to deactivate this feature.
3914 Thanks to Manfred Winter for this suggestion.
3916 -Improved indentation of nested parenthesized expressions. Tests have
3917 given favorable results. Thanks to Wolfgang Weisselberg for helpful
3922 -Fixed a very rare problem in which an unwanted semicolon was inserted
3923 due to misidentification of anonymous hash reference curly as a code
3924 block curly. (No instances of this have been reported; I discovered it
3925 during testing). A workaround for older versions of perltidy is to use
3928 -Added -icb (-indent-closing-brace) parameter to indent a brace which
3929 terminates a code block to the same level as the previous line.
3930 Suggested by Andrew Cutler. For example,
3939 -Rewrote error message triggered by an unknown bareword in a print or
3940 printf filehandle position, and added flag -w=0 to prevent issuing this
3941 error message. Suggested by Byron Jones.
3943 -Added modification to align a one-line 'if' block with similar
3944 following 'elsif' one-line blocks, like this:
3945 if ( $something eq "simple" ) { &handle_simple }
3946 elsif ( $something eq "hard" ) { &handle_hard }
3947 (Suggested by Wolfgang Weisselberg).
3951 -Eliminated all constants with leading underscores because perl 5.005_03
3952 does not support that. For example, _SPACES changed to XX_SPACES.
3953 Thanks to kromJx for this update.
3957 -the directory of test files has been moved to a separate distribution
3958 file because it is getting large but is of little interest to most users.
3959 For the current distribution:
3960 perltidy-20010701.tgz contains the source and docs for perltidy
3961 perltidy-20010701-test.tgz contains the test files
3963 -fixed bug where temporary file perltidy.TMPI was not being deleted
3964 when input was from stdin.
3966 -adjusted line break logic to not break after closing brace of an
3967 eval block (suggested by Boris Zentner).
3969 -added flag -gnu (--gnu-style) to give an approximation to the GNU
3970 style as sometimes applied to perl. The programming style in GNU
3971 'automake' was used as a guide in setting the parameters; these
3972 parameters will probably be adjusted over time.
3974 -an empty code block now has one space for emphasis:
3975 if ( $cmd eq "bg_untested" ) {} # old
3976 if ( $cmd eq "bg_untested" ) { } # new
3977 If this bothers anyone, we could create a parameter.
3979 -the -bt (--brace-tightness) parameter has been split into two
3980 parameters to give more control. -bt now applies only to non-BLOCK
3981 braces, while a new parameter -bbt (block-brace-tightness) applies to
3982 curly braces which contain code BLOCKS. The default value is -bbt=0.
3984 -added flag -icp (--indent-closing-paren) which leaves a statement
3985 termination of the form );, };, or ]; indented with the same
3986 indentation as the previous line. For example,
3988 @month_of_year = ( # default, or -nicp
3989 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
3993 @month_of_year = ( # -icp
3994 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
3998 -Vertical alignment updated to synchronize with tokens &&, ||,
3999 and, or, if, unless. Allowable space before forcing
4000 resynchronization has been increased. (Suggested by Wolfgang
4003 -html corrected to use -nohtml-bold-xxxxxxx or -nhbx to negate bold,
4004 and likewise -nohtml-italic-xxxxxxx or -nhbi to negate italic. There
4005 was no way to negate these previously. html documentation updated and
4006 corrected. (Suggested by Wolfgang Weisselberg).
4008 -Some modifications have been made which improve the -lp formatting in
4011 -Perltidy now retains or creates a blank line after an =cut to keep
4012 podchecker happy (Suggested by Manfred H. Winter). This appears to be
4013 a glitch in podchecker, but it was annoying.
4017 -Added -bli flag to give continuation indentation to braces, like this
4021 extra_indentation();
4024 -Corrected an error with the tab (-t) option which caused the last line
4025 of a multi-line quote to receive a leading tab. This error was in
4026 version 2001 06 08 but not 2001 04 06. If you formatted a script
4027 with -t with this version, please check it by running once with the
4028 -chk flag and perltidy will scan for this possible error.
4030 -Corrected an invalid pattern (\R should have been just R), changed
4031 $^W =1 to BEGIN {$^W=1} to use warnings in compile phase, and corrected
4032 several unnecessary 'my' declarations. Many thanks to Wolfgang Weisselberg,
4033 2001-06-12, for catching these errors.
4035 -A '-bar' flag has been added to require braces to always be on the
4036 right, even for multi-line if and foreach statements. For example,
4037 the default formatting of a long if statement would be:
4039 if ($bigwasteofspace1 && $bigwasteofspace2
4040 || $bigwasteofspace3 && $bigwasteofspace4)
4045 With -bar, the formatting is:
4047 if ($bigwasteofspace1 && $bigwasteofspace2
4048 || $bigwasteofspace3 && $bigwasteofspace4) {
4051 Suggested by Eli Fidler 2001-06-11.
4053 -Uploaded perltidy to sourceforge cvs 2001-06-10.
4055 -An '-lp' flag (--line-up-parentheses) has been added which causes lists
4056 to be indented with extra indentation in the manner sometimes
4057 associated with emacs or the GNU suggestions. Thanks to Ian Stuart for
4058 this suggestion and for extensive help in testing it.
4060 -Subroutine call parameter lists are now formatted as other lists.
4061 This should improve formatting of tables being passed via subroutine
4062 calls. This will also cause full indentation ('-i=n, default n= 4) of
4063 continued parameter list lines rather than just the number of spaces
4064 given with -ci=n, default n=2.
4066 -Added support for hanging side comments. Perltidy identifies a hanging
4067 side comment as a comment immediately following a line with a side
4068 comment or another hanging side comment. This should work in most
4069 cases. It can be deactivated with --no-hanging-side-comments (-nhsc).
4070 The manual has been updated to discuss this. Suggested by Brad
4071 Eisenberg some time ago, and finally implemented.
4075 -fixed problem with parsing command parameters containing quoted
4076 strings in .perltidyrc files. (Reported by Roger Espel Llima 2001-06-07).
4078 -added two command line flags, --want-break-after and
4079 --want-break-before, which allow changing whether perltidy
4080 breaks lines before or after any operators. Please see the revised
4081 man pages for details.
4083 -added system-wide configuration file capability.
4084 If perltidy does not find a .perltidyrc command line file in
4085 the current directory, nor in the home directory, it now looks
4086 for '/usr/local/etc/perltidyrc' and then for '/etc/perltidyrc'.
4087 (Suggested by Roger Espel Llima 2001-05-31).
4089 -fixed problem in which spaces were trimmed from lines of a multi-line
4090 quote. (Reported by Roger Espel Llima 2001-05-30). This is an
4091 uncommon situation, but serious, because it could conceivably change
4092 the proper function of a script.
4094 -fixed problem in which a semicolon was incorrectly added within
4095 an anonymous hash. (Reported by A.C. Yardley, 2001-5-23).
4096 (You would know if this happened, because perl would give a syntax
4097 error for the resulting script).
4099 -fixed problem in which an incorrect error message was produced
4100 after a version number on a 'use' line, like this ( Reported
4101 by Andres Kroonmaa, 2001-5-14):
4103 use CGI 2.42 qw(fatalsToBrowser);
4105 Other than the extraneous error message, this bug was harmless.
4109 -fixed serious bug in which the last line of some multi-line quotes or
4110 patterns was given continuation indentation spaces. This may make
4111 a pattern incorrect unless it uses the /x modifier. To find
4112 instances of this error in scripts which have been formatted with
4113 earlier versions of perltidy, run with the -chk flag, which has
4114 been added for this purpose (SLH, 2001-04-05).
4116 ** So, please check previously formatted scripts by running with -chk
4119 -continuation indentation has been reprogrammed to be hierarchical,
4120 which improves deeply nested structures.
4122 -fixed problem with undefined value in list formatting (reported by Michael
4125 -Switched to graphical display of nesting in .LOG files. If an
4126 old format string was "(1 [0 {2", the new string is "{{(". This
4127 is easier to read and also shows the order of nesting.
4129 -added outdenting of cuddled paren structures, like ")->pack(".
4131 -added line break and outdenting of ')->' so that instead of
4134 -text => "perltidy",
4135 -relief => 'ridge')->pack;
4137 the current default is:
4140 -text => "perltidy",
4144 (requested by Michael Langner 2001-03-31; in the future this could
4145 be controlled by a command-line parameter).
4147 -revised list indentation logic, so that lists following an assignment
4148 operator get one full indentation level, rather than just continuation
4149 indentation. Also corrected some minor glitches in the continuation
4152 -Fixed problem with unwanted continuation indentation after a blank line
4153 (reported by Erik Thaysen 2001-03-28):
4155 -minor update to avoid stranding a single '(' on one line
4159 -corrected serious error tokenizing filehandles, in which a sub call
4160 after a print or printf, like this:
4161 print usage() and exit;
4163 print usage () and exit;
4164 Unfortunately, this converts 'usage' to a filehandle. To fix this, rerun
4165 perltidy; it will look for this situation and issue a warning.
4167 -fixed another cuddled-else formatting bug (Reported by Craig Bourne)
4169 -added several diagnostic --dump routines
4171 -added token-level whitespace controls (suggested by Hans Ecke)
4175 -added support for special variables of the form ${^WANT_BITS}
4177 -space added between scalar and left paren in 'for' and 'foreach' loops,
4178 (suggestion by Michael Cartmell):
4180 for $i( 1 .. 20 ) # old
4181 for $i ( 1 .. 20 ) # new
4183 -html now outputs cascading style sheets (thanks to suggestion from
4186 -flags -o and -st now work with -html
4188 -added missing -html documentation for comments (noted by Alex Izvorski)
4190 -support for VMS added (thanks to Michael Cartmell for code patches and
4193 -v-strings implemented (noted by Hans Ecke and Michael Cartmell; extensive
4194 testing by Michael Cartmell)
4196 -fixed problem where operand may be empty at line 3970
4197 (\b should be just b in lines 3970, 3973) (Thanks to Erik Thaysen,
4198 Keith Marshall for bug reports)
4200 -fixed -ce bug (cuddled else), where lines like '} else {' were indented
4201 (Thanks to Shawn Stepper and Rick Measham for reporting this)
4205 -fixed undefined value in line 153 (only worked with -I set)
4206 (Thanks to Mike Stok, Phantom of the Opcodes, Ian Ehrenwald, and others)
4208 -fixed undefined value in line 1069 (filehandle problem with perl versions <
4209 5.6) (Thanks to Yuri Leikind, Mike Stok, Michael Holve, Jeff Kolber)
4213 -Initial announcement at freshmeat.net; started Change Log
4214 (Unfortunately this version was DOA, but it was fixed the next day)
projects / perltidy.git / blob