bug: 2269 - adding a perltidyrc file
authorAndrew Moore <andrew.moore@liblime.com>
Mon, 23 Jun 2008 17:55:31 +0000 (12:55 -0500)
committerJoshua Ferraro <jmf@liblime.com>
Wed, 25 Jun 2008 16:47:30 +0000 (11:47 -0500)
This patch adds xt/perltidyrc, a suggested perltidy configuration file.

It's in the xt directory because I'd like to eventually tie it in with Test::Perl::Critic
to run automated tests on tidyness and other Perl::Critic policies. That stuff belongs in
the xt directory since it's testing for developers use only.

I have only turned on a few directives based on the suggestions by MJ, historical discussion on
the mailing lists, and what I was told when I started contributing to koha. There are many other
directives in this file that are commented out. They are supposed to represent the defaults and
can be adjusted in the future if desired.

Use of this file is encouraged, but not required. It would be really nice if you could at least run
it on new files that you contribute. I would recommend not running it on files that are already
part of koha without writing some tests for those files and discussing your intentions to reformat
entire files in bulk.

Signed-off-by: Joshua Ferraro <jmf@liblime.com>

xt/perltidyrc [new file with mode: 0644]

diff --git a/xt/perltidyrc b/xt/perltidyrc
new file mode 100644 (file)
index 0000000..f7d9a3c
--- /dev/null
@@ -0,0 +1,75 @@
+# --add-newlines
+# --add-semicolons
+# --add-whitespace
+# --backup-file-extension=bak
+# --blanks-before-blocks
+# --blanks-before-comments
+# --blanks-before-subs
+# --block-brace-tightness=0
+# --block-brace-vertical-tightness=0
+# --brace-tightness=1
+# --brace-vertical-tightness-closing=0
+# --brace-vertical-tightness=0
+# --break-at-old-keyword-breakpoints
+# --break-at-old-logical-breakpoints
+# --break-at-old-ternary-breakpoints
+# --closing-brace-indentation=0
+# --closing-paren-indentation=0
+# --closing-side-comment-else-flag=0
+# --closing-side-comment-interval=6
+# --closing-side-comment-maximum-text=20
+# --closing-square-bracket-indentation=0
+# --comma-arrow-breakpoints=1
+# --continuation-indentation=2
+--cuddled-else
+# --delete-old-newlines
+# --delete-semicolons
+# --format-skipping
+# --format=tidy
+# --fuzzy-line-length
+# --hanging-side-comments
+# --html-entities
+# --html-table-of-contents
+# --indent-block-comments
+# --indent-columns=4
+# --long-block-line-count=8
+# --look-for-autoloader
+# --look-for-selfloader
+# --maximum-consecutive-blank-lines=1
+# --maximum-fields-per-table=0
+--maximum-line-length=178
+# --minimum-space-to-comment=4
+# --nobrace-left-and-indent
+# --nocheck-syntax
+# --nodelete-old-whitespace
+# --nohtml
+# --nologfile
+# --noquiet
+# --noshow-options
+# --nostatic-side-comments
+# --noswallow-optional-blank-lines
+# --notabs
+# --nowarning-output
+--opening-brace-always-on-right
+# --outdent-labels
+# --outdent-long-comments
+# --outdent-long-quotes
+--paren-tightness=1
+# --paren-vertical-tightness-closing=0
+# --paren-vertical-tightness=0
+# --pass-version-line
+# --perl-syntax-check-flags=-c -T
+# --pod2html
+# --recombine
+# --short-concatenation-item-length=8
+# --space-for-semicolon
+# --square-bracket-tightness=1
+# --square-bracket-vertical-tightness-closing=0
+# --square-bracket-vertical-tightness=0
+# --static-block-comments
+# --trim-qw
+# --valign
+--vertical-tightness=2
+
+
+