-
Notifications
You must be signed in to change notification settings - Fork 0
Getting Started: GUI
Input the path (absolute or relative) to the directory containing the Java .class files you want to lint (for example, ./target/classes) into the text box at the top of the main window. Alternatively, just click the "Browse…" button to open a folder browser. Click "Run Checks" to run the linter.
Remember that this application only operates on Java bytecode (.class files). It takes as input a directory of .class files that have already been built by your IDE. If you try to pass a directory of source .java files, nothing will happen!
If a generated message is too long to fit on the screen, you can either resize the window, or hover over the message to see its full text in a tooltip.
Click "Settings…" to edit your configuration.
The "Settings applied to multiple checks" category contains settings used by more than one check.
The option to enable or disable a check is at the top of the respective check's section.
For string and integer properties, the checkbox to the left of the field represents whether the value will be set at all. Uncheck the checkbox to unset the property (it will be removed from your configuration, and the default behavior for that setting will be assumed).
The configuration file is stored as .lpguiconfig.json in your current working directory. This allows you to have different configurations for different projects. Be sure to launch the application from your project's root directory to ensure your configuration persists.
A few advanced settings may not be editable using the GUI, and will require you to edit .lpguiconfig.json directly. Please see the CLI user guide for information on editing the configuration JSON file. Do not edit .lpguiconfig.json while the application is open (if you do your changes will be overwritten!).