Eclipse Checkstyle Plug-in

Importing & Exporting Check Configurations
The Checkstyle plug-in allows Check Configurations to be imported and exported so that they can be reused or shared with other users. The plug-in supports two types of file exports, a plug-in specific file format and the standard Checkstyle configuration file format. The plug-in specific format can be used when exchanging configurations with other plug-in users and contains information only used by the plug-in. The standard Checkstyle configuration file format can be used to exchange configurations with the Ant task and command line version of Checkstyle. Some plug-in specific information is lost when using the standards Checkstyle configuration file format.

To export a Check Configuration select the configuration you want to export and click one of the two export buttons on the preferences page. To import a configuration click the appropriate import button on the preferences page and navigate to the file you want to import. The standard Checkstyle configuration file format allows for properties to be defined using a variable value. If any variable references are found while importing a standard Checkstyle configuration file a dialog window will be display where values can be specified for each variable. Once imported the Check Configuration can also be editing using the normal Check Configuration editor.

Why Two Configuration File Formats?
The plug-in uses two different file formats because the standard Checkstyle configuration file format currently does not support all of the data elements the plug-in needs. Work is being done to allow extensions in the standard Checkstyle configuration file format. When that work is complete the plug-in will be able to use only the standard Checkstyle configuration file format and the plug-in specific file format will be depricated.

Copyright © 2002-2004 David Schneider. All Rights Reserved.