Exim 4.90 release
[exim-website.git] / .perltidyrc
1 --maximum-line-length=120
2 ##--trim-qw
3 #----------------  PBP options, as listed on page 35 of PBP  ----------------
4 ##-l=78   # Max line width is 78 cols
5 -i=4    # Indent level is 4 cols
6 -ci=4   # Continuation indent is 4 cols
7 -vt=2   # Maximal vertical tightness
8 -cti=0  # No extra indentation for closing brackets
9 -pt=1   # Medium parenthesis tightness
10 -sbt=1  # Medium square bracket tightness
11 -bt=1   # Medium brace tightness (for non-code blocks)
12 -bbt=1  # Medium block brace tightness (for code blocks)
13 -nsfs   # No space before semicolons
14 -nolq   # Don't outdent long quoted strings
15         # Break before all operators:
16 -wbb="% + - * / x != == >= <= =~ < > | & **= += *= &= <<= &&= -= /= |= >>= ||= .= %= ^= x="
17 # Note that the PBP book has a typo on page 35 when defining the above -wbb
18 # option, see http://oreilly.com/catalog/perlbp/errata/perlbp.confirmed
19 # The above string is correct.
20
21 #----------  Perltidy default options (i.e. in line with PBP)  --------------
22 -asc    # Add any missing optional semicolon at the end of a line
23 -aws    # Add certain whitespace to improve code readability
24 -tqw    # Default handling of multi-line 'qw' quotes
25 -ibc    # Indent block comments to same level as the code
26 -msc=4  # Minimum 4 spaces between code and same-line comments
27 -fpsc=0 # Don't try to line up all comments to a fixed column
28 -hsc    # Align hanging side comments
29 -sbc    # Enable static block comments
30 -nssc   # No special handling for static side comments
31 -dnl    # Delete old newlines
32 -bbc    # Ensure a blank line before every full-line comment
33 -bbs    # Ensure a blank line before every sub definition (except one-liners)
34 -bbb    # Ensure a blank line before code blocks (for, while, if, ....)
35 -lbl=8  # Minimum number of lines between each -bbb inserted blank line
36
37 #-------------  Additional options, based on PBP recommendations  ------------
38 -bar    # K&R style code braces
39 -nolc   # Long comments indented, even when this make the total line length "too long"
40 -noll   # Long lines indented, even when this make the total line length "too long"
41 -nola   # Don't treat labels as special cases when indenting
42
43 #----------  Options concerning Perltidy's input and ouput files  -----------
44 ##-nst    # Do NOT output to STDOUT (since we want to use -b)
45 ##-b      # Backup the input file to .bak and perform all tidying in the original file
46 ##-se     # Write errors to STDERR
47 ##-ple    # Preserve the EOL character(s). E.g. in case Perltidy runs
48 ##        # on Windows, but processes a Perl file for Unix (and vice versa)
49
50 #-----------  Some other Perltidy options, intentionally not used   ----------
51 # The following Perltidy options are NOT consistent with PBP and should NOT be used:
52 # -lp, -icb, -fws, -nwls, -nwrs, -sfp, -sak/-nsak, -csc/dcsc, -fnl,
53 # -ce, -bl, -sbl, -bli, -blil, -bbvt, -otr, -sct, -boc, -kis,
54 # -pbp (because the -wbb list typo in the PBP book carried over to Perltidy (!))
55 # The following Perltidy options are not used, for other reasons:
56 # -sot, -mft, -cab, -bol, -bok/-nbok, -bot/-nbot, -iob, -isbc