This document describes how to run checkstyle using the command line tool. The latest version of checkstyle can be found at http://checkstyle.sourceforge.net. This command line tool is included in the checkstyle distribution.
The easiest way is to include checkstyle-all-3.1.jar 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:
The command line usage is:
java -D<property>=<value> \ com.puppycrawl.tools.checkstyle.Main \ -c <configurationFile> [-n <packageNameFile>] \ [-f <format>] [-p <propertiesFile>] [-o <file>] \ [-r <dir>] [-e <extension>] file...
Checkstyle will process the specified files and by default report errors to standard out in plain format. Checkstyle requires a configuration XML file that configures the checks to apply. Command line options are:
Set the properties for expanded property values
by either by assigning system
properties using the -D<property>=<value>
arguments to
java or specifying a property file using the -p
option.
If a property file is specified, the system properties are ignored.
Run checkstyle with configuration file docs/checkstyle_checks.xml
on a file
java com.puppycrawl.tools.checkstyle.Main -c docs/checkstyle_checks.xml \ Check.java
Run checkstyle with configuration file docs/checkstyle_checks.xml
on all java files in a directory
java com.puppycrawl.tools.checkstyle.Main -c docs/checkstyle_checks.xml \ -r src/
Run checkstyle with configuration file docs/checkstyle_checks.xml
on a file and provide a system property
java -Dcheckstyle.header.file=docs/java.header \ com.puppycrawl.tools.checkstyle.Main -c docs/checkstyle_checks.xml \ Check.java
Run checkstyle with configuration file docs/checkstyle_checks.xml
on a file and use properties in a file
java com.puppycrawl.tools.checkstyle.Main -c docs/checkstyle_checks.xml \ -p myCheckstyle.properties Check.java
Run checkstyle with configuration file docs/checkstyle_checks.xml
on a file and output to a file in XML format
java com.puppycrawl.tools.checkstyle.Main -c docs/checkstyle_checks.xml \ -f xml -o build/checkstyle_errors.xml Check.java
Run checkstyle with configuration file docs/checkstyle_checks.xml
on a file and
provide a package names file
java com.puppycrawl.tools.checkstyle.Main -c docs/checkstyle_checks.xml \ -n myPackageNames.xml Check.java
It is possible to run Checkstyle directly from the JAR file using the -jar option. An example would be:
java -jar checkstyle-all-3.1.jar \ -c docs/checkstyle_checks.xml Check.java
Copyright © 2002-2003 Oliver Burn. All rights Reserved.