| Next revision | Previous revision |
| student:eclipse:checkstyle [2018/08/21 12:51] – created bernstdh | student:eclipse:checkstyle [2023/01/18 13:49] (current) – bernstdh |
|---|
| |
| |
| ===== The Checkstyle Plugin for Eclipse ===== | ===== The Checkstyle Plugin for Eclipse ===== |
| ==== Installation ==== | ==== Installation ==== |
| |
| | There are three different ways to install the Eclipse Checkstyle Plugin. They are described at the [[ http://eclipse-cs.sourceforge.net/#!/install | Checkstyle Plugin site ]]. At the moment, the "update site" seems to be the most reliable approach. |
| |
| The easiest way to install the Eclipse Checkstyle Plugin is as follows. | If none of the normal methods work, you may want to consider installing the plugin manually. |
| | ((The normal Checkstyle installation process was not working reliably at the start of the Fall 2018 semester. However, it was possible to install version 8.11 "manually". So, if you have problems with the normal installation process, you may want to try this. |
| | |
| | In a WWW browser, go to: |
| | |
| | [[ https://bintray.com/eclipse-cs/eclipse-cs/update-site-archive/8.11.0 | v8.11 Download Site ]] |
| | |
| | then right-click on the link named ''%%net.sf.eclipsecs-updatesite_8.11.0.201807281521.zip%%'' (underneath the word "Downloads") and save the ''%%.zip%%'' file to a convenient location. |
| | |
| | Now start Eclipse and click on <key>Help</key>+<key>Install New Software</key>. When the dialog box opens, click on <key>Add...</key>. When the new dialog box opens, click on <key>Archive...</key>, navigate to the ''.zip'' file that you saved earlier, and click on <key>OK</key>. Then click on <key>Add</key> on the previous dialog. |
| | |
| | To actually start the installation process, on the previous dialog select Checkstyle and click on <key>Next</key> or <key>Finish</key>.)) |
| |
| |
| - Start a WWW browser and navigate to [[ http://eclipse-cs.sourceforge.net/ | http://eclipse-cs.sourceforge.net/ ]]. | |
| - Start Eclipse. | |
| - Drag the "Install" icon from the WWW browser into a running Eclipse workspace. | |
| - When the dialog box appears, check "Checkstyle Plug-in" and click on <key>Confirm</key>. | |
| - Check "I accept..." and click on <key>Finish</key>. | |
| - If you get a message about "unsigned content", click <key>OK</key>. | |
| - Restart Eclipse. | |
| Several alternative methods are discussed at the [[ http://eclipse-cs.sourceforge.net/#!/install | Checkstyle Plugin site ]]. | |
| |
| |
| - Click on <key>Checkstyle</key> and <key>Activate Checkstyle</key>. (Or, if there is no <key>Checkstyle</key> entry, click on <key>Properties</key> and then select "Checkstyle", check "Checkstyle active..." and click on <key>OK</key>.) | - Click on <key>Checkstyle</key> and <key>Activate Checkstyle</key>. (Or, if there is no <key>Checkstyle</key> entry, click on <key>Properties</key> and then select "Checkstyle", check "Checkstyle active..." and click on <key>OK</key>.) |
| |
| ==== Loading a Checks File ==== | ==== Loading a Checks File (Configuration File) ==== |
| |
| | You can set the checks file for all of the projects in a workspace or for each project individually. |
| | If you have a different workspace for each course then you should probably use the first approach, |
| | which is described in the [[ student:eclipse:install#install_and_use_a_custom_checks_configuration_file | page on installing Eclipse ]]. If you use one workspace for all of your courses then you should probably use the second approach as follows: |
| |
| If your course uses a custom checks file: | - Download the file to an appropriate location on your local file system. |
| | - In Eclipse, right-click on the project, and pull down to <key>Properties</key>. |
| | - Select "Checkstyle" and click on the "Local Check Configurations" tab. |
| - Download the file to an appropriate location on your local file system. | |
| - In Eclipse, right-click on the project, and pull down to <key>Properties</key>. | |
| - Select "Checkstyle" and click on the "Local Check Configurations" tab. | |
| - Click on <key>New</key>. | - Click on <key>New</key>. |
| - Select "External Configuration File", enter a "Name:" and the "Location:" of the file, and click <key>OK</key>. | - Select "External Configuration File", enter a "Name:" and the "Location:" of the file, and click <key>OK</key>. |
| - Select the "Main" tab. | - Select the "Main" tab. |
| - Select the appropriate configuration file from the drop-down list. | - Select the appropriate configuration file from the drop-down list. |
| - Click on <key>OK</key>. | - Click on <key>OK</key>. |
| - When the "Rebuild suggested" dialog appears, click on <key>Yes</key>. | - When the "Rebuild suggested" dialog appears, click on <key>Yes</key>. |
| | |
| | |
