177 lines
8.4 KiB
HTML
177 lines
8.4 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
|
|
<html>
|
|
<head>
|
|
<title>checkstyle Command Line</title>
|
|
<style>
|
|
span.default {white-space: nowrap;font-family: monospace;font-size: x-small;}
|
|
</style>
|
|
</head>
|
|
|
|
<body>
|
|
<h2><a name="checkstyle">checkstyle Command Line</a></h2>
|
|
<h3>Description</h3>
|
|
|
|
<p>This document describes how to run checkstyle using the command line tool. The latest version of checkstyle can be found at
|
|
<a href="http://checkstyle.sourceforge.net">http://checkstyle.sourceforge.net</a>.
|
|
This command line tool is included in the checkstyle distribution.</p>
|
|
|
|
|
|
<h3>Installation</h3>
|
|
<p>The easiest way is to include <span class="default">checkstyle-all-1.4.jar</span> in the classpath. This contains all the classes required to run checkstyle. Alternatively, you must include the following in the classpath:</p>
|
|
<ol>
|
|
<li><span class="default">checkstyle-1.4.jar</span></li>
|
|
<li>ANTLR 2.7.1 classes. <span class="default">antlr.jar</span> is included in the distribution.</li>
|
|
<li>Jakarta Regexp 1.2 classes. <span class="default">jakarta-regexp-1.2.jar</span> is included in the distribution.</li>
|
|
</ol>
|
|
|
|
|
|
<h3>Usage</h3>
|
|
<p>The command line usage is:</p>
|
|
<pre>
|
|
java -D<property>=<value> \
|
|
com.puppycrawl.tools.checkstyle.Main \
|
|
[-f <format>] [-o <toFile>] file...
|
|
</pre>
|
|
|
|
<p>Checkstyle will process the specified files and by default report errors to standard out in plain format. The options are:</p>
|
|
|
|
<ul>
|
|
<li>-f format: specify the output format. Options are plain and xml. Defaults to "plain"</li>
|
|
<li>-o file: specify the file to output to.</li>
|
|
</ul>
|
|
|
|
<p>The default behaviour of checkstyle can be changed by setting system properties using the <code>-D<property>=<value></code> arguments to java. The following table describes what properties can be set:</p>
|
|
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td valign="top"><b>Property</b></td>
|
|
<td valign="top"><b>Description</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.allow.tabs</td>
|
|
<td valign="top">Indicates whether to allow tabs. Defaults to <span class="default">"no"</span>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.allow.protected</td>
|
|
<td valign="top">Indicates whether to allow protected data. Defaults to <span class="default">"no"</span>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.allow.noauthor</td>
|
|
<td valign="top">Indicates whether to allow no <span class="default">@author</span> tag to be defined for class and interface Javadoc comments. Defaults to <span class="default">"no"</span>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.maxlinelen</td>
|
|
<td valign="top">Specifies the maximum line length. Default value is defined <a href="engine.html#length">here</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.ignore.importlength</td>
|
|
<td valign="top">Specifies whether to ignore the maximum line length for <span class="code">import</span> statements. Defaults to <span class="default">"false"</span>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.maxmethodlen</td>
|
|
<td valign="top">Specifies the maximum method length. Default value is defined <a href="engine.html#methodLength">here</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.maxconstructorlen</td>
|
|
<td valign="top">Specifies the maximum constructor length. Default value is defined <a href="engine.html#constructorLength">here</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.maxfilelen</td>
|
|
<td valign="top">Specifies the maximum file length. Default value is defined <a href="engine.html#fileLength">here</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.pattern.member</td>
|
|
<td valign="top">Specifies the regular expression to match against member variables. Default value is defined <a href="engine.html#varformat">here</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.pattern.publicmember</td>
|
|
<td valign="top">Specifies the regular expression to match against public member variables. Default value is defined <a href="engine.html#fieldformat">here</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.pattern.parameter</td>
|
|
<td valign="top">Specifies the regular expression to match against parameters. Default value is defined <a href="engine.html#paramformat">here</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.pattern.const</td>
|
|
<td valign="top">Specifies the regular expression to match against static/final variables. Default value is defined <a href="engine.html#varformat">here</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.pattern.static</td>
|
|
<td valign="top">Specifies the regular expression to match against static variables. Default value is defined <a href="engine.html#varformat">here</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.pattern.type</td>
|
|
<td valign="top">Specifies the regular expression to match against type names. Default value is defined <a href="engine.html#typeformat">here</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.header.file</td>
|
|
<td valign="top">Specifies the file containing the header lines. Default is to not check.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.header.ignoreline</td>
|
|
<td valign="top">Specifies the line in the header to ignore when comparing. Default it to not ignore any line.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.javadoc.scope</td>
|
|
<td valign="top">Specifies the visibility scope where javadoc comments are checked. Valid values are <span class="default">"nothing"</span>, <span class="default">"public"</span>, <span class="default">"protected"</span>, <span class="default">"package"</span>, <span class="default">"private"</span> and <span class="default">"anoninner"</span>. Defaults to <span class="default">"private"</span>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.ignore.imports</td>
|
|
<td valign="top">Specifies whether to ignore checking import statements. Defaults to <span class="default">"no"</span>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.ignore.whitespace</td>
|
|
<td valign="top">Specifies whether to ignore checking whitespace. Defaults to <span class="default">"no"</span>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.ignore.whitespace.cast</td>
|
|
<td valign="top">Specifies whether to ignore checking for whitespace after a cast. Defaults to <span class="default">"no"</span>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.ignore.braces</td>
|
|
<td valign="top">Specifies whether to ignore checking braces. Defaults to <span class="default">"no"</span>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">checkstyle.cache.file</td>
|
|
<td valign="top">Specifies the name of a file that can be used to cache details of files that pass checkstyle. This can signicantly increase the speed of checkstyle on successive runs.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>
|
|
Older versions of the checkstyle task supported the boolean parameters checkstyle.javadoc.relax and checkstyle.javadoc.ignore. These parameters have been removed because they were conflicting with each other and the semantics of relaxJavadoc was not specified. The two parameters have been replaced by the checkstyle.javadoc.scope parameter. Instead of checkstyle.javadoc.ignore=true you can now use checkstyle.javadoc.scope=nothing. The behaviour of checkstyle.javadoc.relax=true is roughly the same as checkstyle.javadoc.scope=protected.
|
|
</p>
|
|
|
|
<h3>Examples</h3>
|
|
<p><b>Run checkstyle on a file</b></p>
|
|
<pre>
|
|
java com.puppycrawl.tools.checkstyle.Main Check.java
|
|
</pre>
|
|
|
|
<p><b>Run checkstyle on a file and allow tabs</b></p>
|
|
<pre>
|
|
java -Dcheckstyle.allow.tabs=yes \
|
|
com.puppycrawl.tools.checkstyle.Main Check.java
|
|
</pre>
|
|
|
|
<p><b>Run checkstyle on a file and output to a file in XML format</b></p>
|
|
<pre>
|
|
java -Dcheckstyle.allow.tabs=yes \
|
|
com.puppycrawl.tools.checkstyle.Main \
|
|
-f xml -o build/checkstyle_errors.xml Check.java
|
|
</pre>
|
|
|
|
<p><b>Run checkstyle on a file and disable pattern matching</b></p>
|
|
<pre>
|
|
java -Dcheckstyle.pattern.parameter=. \
|
|
-Dcheckstyle.pattern.static=. \
|
|
-Dcheckstyle.pattern.const=. \
|
|
-Dcheckstyle.pattern.member=. \
|
|
com.puppycrawl.tools.checkstyle.Main Check.java
|
|
</pre>
|
|
|
|
<hr>
|
|
<p align="center">Copyright © 2001 Oliver Burn. All rights Reserved.</p>
|
|
</body>
|
|
</html>
|