162 lines
5.7 KiB
HTML
162 lines
5.7 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>Checkstyle Command Line - Version @CHECKSTYLE_VERSION@</title>
|
|
<link rel="stylesheet" type="text/css" href="mystyle.css"/>
|
|
</head>
|
|
|
|
<body>
|
|
<h1><a name="checkstyle">Checkstyle Command Line - Version @CHECKSTYLE_VERSION@</a></h1>
|
|
<h2>Description</h2>
|
|
|
|
<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>
|
|
|
|
|
|
<h2>Installation</h2>
|
|
<p>
|
|
The easiest way is to include <span class="default">checkstyle-all-@CHECKSTYLE_VERSION@.jar</span> in the classpath. If you are running JDK 1.4 this contains all the classes required to run checkstyle (JDK 1.3 users must add a JAXP compliant XML parser implementation). Alternatively, you must include the following in the classpath:
|
|
</p>
|
|
<ol>
|
|
<li><span class="default">checkstyle-@CHECKSTYLE_VERSION@.jar</span></li>
|
|
<li>ANTLR 2.7.2 classes. <span class="default">antlr.jar</span> is included in the distribution.</li>
|
|
<li>Jakarta Regexp 1.3 classes. <span class="default">jakarta-regexp-1.3.jar</span> is included in the distribution.</li>
|
|
<li>Jakarta Commons Beanutils classes. <span class="default">commons-beanutils.jar</span> is included in the distribution.</li>
|
|
<li>Jakarta Commons Collections classes. <span class="default">commons-collections.jar</span> is included in the distribution.</li>
|
|
<li>Jakarta Commons Logging classes. <span class="default">commons-logging.jar</span> is included in the distribution.</li>
|
|
<li>Jakarta Commons CLI (command line interface) classes. <span class="default">commons-cli.jar</span> is included in the distribution.</li>
|
|
<li>JDK 1.3 only: A JAXP compliant XML parser implementation.</li>
|
|
</ol>
|
|
|
|
|
|
<h2>Usage</h2>
|
|
<p>
|
|
The command line usage is:
|
|
</p>
|
|
<pre>
|
|
java -D<property>=<value> \
|
|
com.puppycrawl.tools.checkstyle.Main \
|
|
-c <configurationFile> [-n <packageNameFile>] \
|
|
[-f <format>] [-p <propertiesFile>] [-o <file>] \
|
|
[-r <dir>] file...
|
|
</pre>
|
|
|
|
<p>
|
|
Checkstyle will process the specified files and by default report errors to
|
|
standard out in plain format. Checkstyle requires a <a href="config.html">configuration XML file</a> that configures the
|
|
checks to apply. Command line options are:
|
|
</p>
|
|
|
|
<ul>
|
|
|
|
<li>
|
|
<span class="default">-n packageNamesFile</span> - specify a
|
|
<a href="config.html#packagenames">package names file</a> to use.
|
|
</li>
|
|
<li>
|
|
<span class="default">-f format</span> - specify the output format. Options are <span class="default">
|
|
"plain"</span> for the <a href="api/com/puppycrawl/tools/checkstyle/DefaultLogger.html">DefaultLogger</a>
|
|
and <span class="default">"xml"</span> for the <a href="api/com/puppycrawl/tools/checkstyle/XMLLogger.html">XMLLogger</a>.
|
|
Defaults to <span class="default">"plain"</span>.
|
|
</li>
|
|
<li>
|
|
<span class="default">-p propertiesFile</span> - specify a properties file to
|
|
use.
|
|
</li>
|
|
<li>
|
|
<span class="default">-o file</span> - specify the file to output to.
|
|
</li>
|
|
<li>
|
|
<span class="default">-r dir</span> - specify the directory to traverse for Java
|
|
source files.
|
|
</li>
|
|
</ul>
|
|
|
|
<p>
|
|
Set the properties for <a href="config.html#properties">expanded property values</a>
|
|
by either by assigning system
|
|
properties using the <code>-D<property>=<value></code> arguments to
|
|
java or specifying a property file using the <code>-p</code> option.
|
|
If a property file is specified, the system properties are ignored.
|
|
</p>
|
|
<h2>Examples</h2>
|
|
<p>
|
|
<b>Run checkstyle with configuration file <code>docs/sun_checks.xml</code> on a file</b>
|
|
</p>
|
|
<pre>
|
|
java com.puppycrawl.tools.checkstyle.Main -c docs/sun_checks.xml \
|
|
Check.java
|
|
</pre>
|
|
|
|
<p>
|
|
<b>Run checkstyle with configuration file <code>docs/sun_checks.xml</code>
|
|
on all java files in a directory</b>
|
|
</p>
|
|
<pre>
|
|
java com.puppycrawl.tools.checkstyle.Main -c docs/sun_checks.xml \
|
|
-r src/
|
|
</pre>
|
|
|
|
<p>
|
|
<b>Run checkstyle with configuration file <code>docs/sun_checks.xml</code>
|
|
on a file and provide a system property</b>
|
|
</p>
|
|
<pre>
|
|
java -Dcheckstyle.cache.file=target/cachefile \
|
|
com.puppycrawl.tools.checkstyle.Main -c docs/sun_checks.xml \
|
|
Check.java
|
|
</pre>
|
|
|
|
<p>
|
|
<b>Run checkstyle with configuration file <code>docs/sun_checks.xml</code>
|
|
on a file and use properties in a file</b>
|
|
</p>
|
|
<pre>
|
|
java com.puppycrawl.tools.checkstyle.Main -c docs/sun_checks.xml \
|
|
-p myCheckstyle.properties Check.java
|
|
</pre>
|
|
|
|
<p>
|
|
<b>Run checkstyle with configuration file <code>docs/sun_checks.xml</code>
|
|
on a file and output to a file in XML format </b>
|
|
</p>
|
|
<pre>
|
|
java com.puppycrawl.tools.checkstyle.Main -c docs/sun_checks.xml \
|
|
-f xml -o build/checkstyle_errors.xml Check.java
|
|
</pre>
|
|
|
|
<p>
|
|
<b>Run checkstyle with configuration file <code>docs/sun_checks.xml</code> on a file and
|
|
provide a package names file</b>
|
|
</p>
|
|
<pre>
|
|
java com.puppycrawl.tools.checkstyle.Main -c docs/sun_checks.xml \
|
|
-n myPackageNames.xml Check.java
|
|
</pre>
|
|
|
|
|
|
<div class="tip">
|
|
<h4 class="tip">Tip</h4>
|
|
<p>
|
|
It is possible to run Checkstyle directly from the JAR file using the
|
|
<span class="code">-jar</span> option. An example would be:
|
|
</p>
|
|
|
|
<pre>
|
|
java -jar checkstyle-all-@CHECKSTYLE_VERSION@.jar \
|
|
-c docs/sun_checks.xml Check.java
|
|
</pre>
|
|
</div>
|
|
|
|
<hr />
|
|
<div><a href="index.html">Back to the Checkstyle Home Page</a></div>
|
|
<p class="copyright">Copyright © 2002-2004 Oliver Burn. All rights Reserved.</p>
|
|
</body>
|
|
</html>
|