Cs-contrib.unkrig.de

From unkrig.de
Jump to navigation Jump to search

Introduction

This project adds custom checks, filters and quickfixes for CheckStyle and Eclipse-CS.

This project uses the CS doclet (internally) to generate its CheckStyle and eclipse-cs metadata files.

Download

Install the ECLIPSE plug-in from this update site:

    http://cs-contrib.unkrig.de/update

If you're only interested in the checks (and not the ECLIPSE plug-in), you can download the most recent 'de.unkrig.cs-contrib.core_*.jar' file from

    http://cs-contrib.unkrig.de/update/plugins/

and put it on CheckStyle's classpath.

A change log is also available.

Checks and Quickfixes

Alignment
Verifies that Java elements are vertically aligned.
C++-style comment alignment
Verifies that C++-style comments ('// ...') are correctly aligned.
Inner assignment
Verifies that assignments in expressions are parenthesized.
Name spelling
Verifies that the names of Java elements match, respectively no not match given patterns.
Parenthesis padding
Enhanced version of "ParenPad". Superseded by 'de.unkrig.Whitespace'.
Whitespace
Verifies that tokens are, respectively are not preceded with (and/or followed by) whitespace.
Whitespace around
Verifies that a token is surrounded by whitespace. Superseded by 'de.unkrig.Whitespace'.
Wrap annotation
Verifies that annotations and annotation type declarations are uniformly wrapped and indented.
Wrap anonymous class
Verifies that anonymous class declarations are uniformly wrapped and indented.
Wrap array initializer
Verifies that array initializers are uniformly wrapped and indented.
Wrap binary operator
Verifies that binary operations are uniformly wrapped before and/or after the operator.
Wrap class
Verifies that class declarations are uniformly wrapped and indented.
Wrap constructor
Verifies that constructore declarations, parameters and arguments are uniformly wrapped and indented.
Wrap DO statement
Verifies that DO statements are uniformly wrapped and indented.
Wrap enum
Verifies that enum declarations and constants are uniformly wrapped and indented.
Wrap field
Verifies that field declarations are uniformly wrapped and indented.
Wrap interface
Verifies that interface declarations are uniformly wrapped and indented.
Wrap local variable
Verifies that local variable declarations are uniformly wrapped and indented.
Wrap method
Verifies that method declarations, parameters and call arguments are uniformly wrapped and indented.
Wrap package
Verifies that package declarations are uniformly wrapped and indented.
Wrap switch block statement group
Verifies that switch block statement groups are uniformly wrapped and indented.
Wrap TRY statement
Verifies that TRY statements are uniformly wrapped and indented.
Zero-parameter superconstructor invocation
Verifies that no constructor calls the zero-parameter superconstructor.

Filters

Suppression line
Events (i.e. CheckStyle warnings) are switched off by a 'magic line' ('offCommentFormat') or back on by another 'magic line' ('onCommentFormat').

License

CS-CONTRIB.UNKRIG.DE is published under the "New BSD License".

Source Code

The source code is available through SVN:

   https://svn.code.sf.net/p/loggifier/code