|
|
(6 intermediate revisions by the same user not shown) |
Line 1: |
Line 1: |
| | <meta name="keywords" content="checkstyle, checks, filters, quickfixes"></meta> |
| | <meta name="description" content="Custom checks, filters and quickfixes for checkstyle and eclipse-cs"></meta> |
| = Introduction = | | = Introduction = |
| This project adds custom checks, filters and quickfixes for [http://checkstyle.sourceforge.net/ CheckStyle] and [http://eclipse-cs.sourceforge.net/ Eclipse-CS]. | | This project adds custom checks, filters and quickfixes for [http://checkstyle.sourceforge.net/ CheckStyle] and [http://eclipse-cs.sourceforge.net/ Eclipse-CS]. |
|
| |
|
| This project uses the [[Cs-doclet|CS doclet]] (internally) to generate its CheckStyle and eclipse-cs metadata files. | | This project uses the [[Cs-doclet|CS doclet]] (internally) to generate its CheckStyle and eclipse-cs metadata files. |
| | |
| | Cs-contrib 1.2.21+ requires the CheckStyle core version 8.21+, because there was an (accidential) breaking change in that version. |
|
| |
|
| = Download = | | = Download = |
Line 15: |
Line 19: |
| A [http://cs-contrib.unkrig.de/CHANGELOG.txt change log] is also available. | | A [http://cs-contrib.unkrig.de/CHANGELOG.txt change log] is also available. |
|
| |
|
| = Checks and Quickfixes = | | = Documentation = |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Alignment|<code>Alignment</code>]]
| |
| :Verifies that Java elements are vertically aligned.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / C++-style comment alignment|<code>C++-style comment alignment</code>]]
| |
| :Verifies that C++-style comments ('// ...') are correctly aligned.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Inner assignment|<code>Inner assignment</code>]]
| |
| :Verifies that assignments in expressions are parenthesized.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Name spelling|<code>Name spelling</code>]]
| |
| :Verifies that the names of Java elements match, respectively no not match given patterns.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Parenthesis padding|<code>Parenthesis padding</code>]]
| |
| :Enhanced version of "ParenPad". <span style="color: red">Superseded by '[[Cs-contrib.unkrig.de / Checks / de.unkrig.Whitespace|de.unkrig.Whitespace]]'.</span>
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Whitespace|<code>Whitespace</code>]]
| |
| :Verifies that tokens are, respectively are not preceded with (and/or followed by) whitespace.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Whitespace around|<code>Whitespace around</code>]]
| |
| :Verifies that a token is surrounded by whitespace. <span style="color: red">Superseded by '[[Cs-contrib.unkrig.de / Checks / de.unkrig.Whitespace|de.unkrig.Whitespace]]'.</span>
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Wrap annotation|<code>Wrap annotation</code>]]
| |
| :Verifies that annotations and annotation type declarations are uniformly wrapped and indented.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Wrap anonymous class|<code>Wrap anonymous class</code>]]
| |
| :Verifies that anonymous class declarations are uniformly wrapped and indented.
| |
|
| |
|
| ;[[Cs-contrib.unkrig.de / Checks / Wrap array initializer|<code>Wrap array initializer</code>]]
| | The [http://cs-contrib.unkrig.de/csdoc/ documentation for the cs-contrib checks, filters and quickfixes] was generated by the [http://doclet.unkrig.de CS doclet] |
| :Verifies that array initializers are uniformly wrapped and indented.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Wrap binary operator|<code>Wrap binary operator</code>]]
| |
| :Verifies that binary operations are uniformly wrapped before and/or after the operator.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Wrap class|<code>Wrap class</code>]]
| |
| :Verifies that class declarations are uniformly wrapped and indented.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Wrap constructor|<code>Wrap constructor</code>]]
| |
| :Verifies that constructore declarations, parameters and arguments are uniformly wrapped and indented.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Wrap DO statement|<code>Wrap DO statement</code>]]
| |
| :Verifies that DO statements are uniformly wrapped and indented.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Wrap enum|<code>Wrap enum</code>]]
| |
| :Verifies that enum declarations and constants are uniformly wrapped and indented.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Wrap field|<code>Wrap field</code>]]
| |
| :Verifies that field declarations are uniformly wrapped and indented.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Wrap interface|<code>Wrap interface</code>]]
| |
| :Verifies that interface declarations are uniformly wrapped and indented.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Wrap local variable|<code>Wrap local variable</code>]]
| |
| :Verifies that local variable declarations are uniformly wrapped and indented. | |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Wrap method|<code>Wrap method</code>]]
| |
| :Verifies that method declarations, parameters and call arguments are uniformly wrapped and indented.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Wrap package|<code>Wrap package</code>]]
| |
| :Verifies that package declarations are uniformly wrapped and indented.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Wrap switch block statement group|<code>Wrap switch block statement group</code>]]
| |
| :Verifies that switch block statement groups are uniformly wrapped and indented.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Wrap TRY statement|<code>Wrap TRY statement</code>]]
| |
| :Verifies that TRY statements are uniformly wrapped and indented.
| |
| | |
| ;[[Cs-contrib.unkrig.de / Checks / Zero-parameter superconstructor invocation|<code>Zero-parameter superconstructor invocation</code>]]
| |
| :Verifies that no constructor calls the zero-parameter superconstructor.
| |
| | |
| = Filters =
| |
| | |
| ;[[Cs-contrib.unkrig.de / Filters / de.unkrig.SuppressionLine|<code>Suppression line</code>]]
| |
| :Events (i.e. CheckStyle warnings) are switched off by a 'magic line' ('offCommentFormat') or back on by another 'magic line' ('onCommentFormat').
| |
|
| |
|
| = License = | | = License = |
Line 97: |
Line 29: |
| = Source Code = | | = Source Code = |
|
| |
|
| The source code is available through SVN: | | The source code of <code>cs-contrib</code> (the CheckStyle extension) is on GITHUB: |
| | |
| | https://github.com/aunkrig/cs-contrib/ |
| | |
| | The source code of the Eclipse plugin (<code>.core</code>, <code>.branding</code>, <code>.feature</code>, <code>.updatesite</code>) is also on GITHUB: |
|
| |
|
| https://svn.code.sf.net/p/loggifier/code | | https://github.com/aunkrig/cs-contrib.branding |
| | https://github.com/aunkrig/cs-contrib.core |
| | https://github.com/aunkrig/cs-contrib.core_test |
| | https://github.com/aunkrig/cs-contrib.feature |
| | https://github.com/aunkrig/cs-contrib.updatesite |
| | https://github.com/aunkrig/cs-contrib_dist |
<meta name="keywords" content="checkstyle, checks, filters, quickfixes"></meta>
<meta name="description" content="Custom checks, filters and quickfixes for checkstyle and eclipse-cs"></meta>
Introduction[edit]
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.
Cs-contrib 1.2.21+ requires the CheckStyle core version 8.21+, because there was an (accidential) breaking change in that version.
Download[edit]
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.
Documentation[edit]
The documentation for the cs-contrib checks, filters and quickfixes was generated by the CS doclet
License[edit]
CS-CONTRIB.UNKRIG.DE is published under the "New BSD License".
Source Code[edit]
The source code of cs-contrib
(the CheckStyle extension) is on GITHUB:
https://github.com/aunkrig/cs-contrib/
The source code of the Eclipse plugin (.core
, .branding
, .feature
, .updatesite
) is also on GITHUB:
https://github.com/aunkrig/cs-contrib.branding
https://github.com/aunkrig/cs-contrib.core
https://github.com/aunkrig/cs-contrib.core_test
https://github.com/aunkrig/cs-contrib.feature
https://github.com/aunkrig/cs-contrib.updatesite
https://github.com/aunkrig/cs-contrib_dist