Run inspections

Last modified: 23 August 2023

GoLand analyses code in the files that are opened in the editor and highlights problematic code as you type. Additionally, you can run the necessary inspection or a set of inspections on the selected scope of files manually. In this case, you will get a comprehensive report of all problems detected in the files.

Instant analysis of the current file

The IDE continuously checks your code and searches for problems. The widget in the top-right corner of the editor displays the number of problems of each severity detected in the current file:

tip
The widget has a simplified view. To enable it, hover the mouse over the widget, click , and select Compact View.

Click the widget to open the list of problems on the File tab of the Problems tool window. You can also access the Problems tool window by selecting View | Tool Windows | Problems or by pressing Alt06.

For each problem, you can see the suggested quick-fix by pressing AltEnter or by clicking . You can also jump to the corresponding line in the editor by pressing F4 or by double-clicking the problem in the tool window.

Alternatively, click to be able to view and fix problems in the tool window.

Detected problems shown in the Problems tool window

The color stripe in the scrollbar also marks the detected code problems and helps you quickly access the corresponding lines without scrolling the file. Hover over a mark on the stripe to see the detected problem in a tooltip. Click a mark to jump to the corresponding line. Alternatively, you can use the widget for inspections.

Navigate to detected problems

You can jump from one highlighted problem to another within a file by clicking in the widget or by pressing F2 or ShiftF2 accordingly. By default, the IDE will navigate you to problems according to their severity: errors > warnings > weak warnings > server problems > typos.

You can configure GoLand to take you through the problems one by one regardless of their severity. Hover the mouse over the widget in top-right corner of the editor, click , select 'Next Error' Action (F2) Goes Through, and enable All Problems.

Configuring navigation between highlighted lines

Run inspections manually

Some inspections require global code analysis, and that is why they are disabled in the editor. These inspections are listed in Settings | Editor | Inspections. Click and select Show only batch-mode inspections.

If you want to get a full report of all detected problems, run inspections manually.

Run all inspections

From the main menu, select Code | Inspect Code.
Select the scope of files that you want to analyze.
Click the icon to configure a new scope.
Select the inspection profile that you want to apply.
To create a new profile or modify one of the existing profiles, click Configure.
Click Analyze to start the analysis.

Specify Inspection Scope dialog

Item	Description
Whole project	Inspect the whole project.
File <name>	Inspect the file that is currently selected in the Project tool window or opened in the editor.
Selected files	Inspect the files that are currently selected in the Project tool window.
Uncommitted files	This scope is only available for the projects under version control. Inspect only the files that have not been committed to the version control system.
Directory	Inspect the directory that is currently selected in the Project tool window.
Custom scope	Inspect a custom scope of files. Select a pre-defined scope from the list, or click and define the scope in the Scopes dialog that opens. tip Use a special language to define a scope.
Include test sources	Inspect the test sources included in the analysis scope.
Inspect injected code	Inspect pieces of code in other languages embedded in your code.
Inspection profile	Select a profile that you want to use to inspect your code. If the required profile is not in the list, click Configure and create a new profile.

Run a single inspection

Running a single inspection is useful in case you want to track a specific problem. If you find a warning in a file, you can inspect your entire project, or the necessary scope of files, to ensure that there are no more such warnings in your code base.

From the main menu, select Code | Analyze Code | Run Inspection by Name… or press CtrlAltShift0I.
Type the inspection name in the popup. Use CamelHumps to match camel case words and white spaces with initial letters of the words. The suggestion list will show you inspections that match your search request.
If you are not sure that you are selecting the correct inspection, you can view its description. To do so, select an inspection in the popup and press Ctrl0Q.
Double-click the necessary inspection to open its settings.
In the dialog that opens, select the scope of files that you want to analyze.
The File mask(s) option helps you narrow down the number of files that will be inspected.
Select the checkbox and specify a pattern of characters and wildcards that matches the names of files you want to analyze. Use a comma to separate multiple file masks.
Some inspections might have additional options that you will be prompted to configure.
These settings will only be applied to this run, and will not affect this inspection's configuration in your current profile.
The IDE will show you the inspection results in the dedicated tool window tool window. There you can examine and fix detected problems.

Run code inspection with Qodana

Install the Qodana plugin

This functionality relies on the Qodana plugin, which you need to install and enable.

Press CtrlAlt0S to open the IDE settings and then select Plugins.
Open the Marketplace tab, find the Qodana plugin, and click Install (restart the IDE if prompted).

You can inspect your code locally or remotely using Qodana. The main use case for Qodana is to perform resource-intensive code analysis remotely, on a CI/CD server. However, you can also run the same analysis in the IDE to make sure that you have the same results, and to be able to locate the detected issues in your source code.

From the main menu, select Tools | Qodana | Try Code Analysis with Qodana.
Select where you want to run inspections: locally or on your CI/CD server.
To run inspections on the server, you need to set up Qodana on your CI first.
The Qodana configuration file opens. In this file, you can specify Qodana inspection profile, enable or disable specific inspections, and specify a list of plugins that should be installed before the analysis.
Click Run.

Once the analysis is finished, the report will be displayed in the Problems tool window on the Server-Side Analysis tab. You can work with the results locally or send them to Qodana Cloud.

The reports of all local runs of Qodana analysis are saved and available from the main menu: Tools | Qodana | [report name]. The currently opened report has a checkmark next to it, you can click it to close the report.

To learn more about Qodana, refer to its documentation.

Run inspections offline

In addition to running code inspections from the IDE, you can launch inspections from the command line without actually running GoLand. The inspection results will be stored in an XML file.

Change the order of scopes

By default, all enabled code inspections analyze all files in your project. Depending on your needs, you can run the same inspection in more than one scope of files with different settings.

If one file is included in two or more scopes, and you enable an inspection in these scopes, GoLand will process them according to their order in the list of scopes — the uppermost scope will have the highest priority, and therefore, it will be analyzed first.

In the Settings dialog (CtrlAlt0S), select Editor | Inspections.
Select any inspection from the list.
From the In All Scopes list, select Edit Scopes Order.
Select the necessary scope, and use and to move it up and down the list.
If needed, create a new scope. To do so, click (Edit Scopes), specify scope settings, and select the files and folders that you want to include in it.

Widget for inspections

To navigate between detected problems, you can use the Inspections widget. The Inspections widget shows the number of warnings, errors, and typos in the current file. You can go through them using the arrow icons or by pressing F2.

By using the Inspections widget, you can configure the highlighting level (None, Errors Only, or All Problems), change the severity level of inspections, and toggle the Compact View.

Configure the widget

Click the widget in the upper-right corner of the editor.
Click the More button () and select one of the following settings:
- Configure inspections: open the Inspections dialog with settings for inspections.
- 'Next Error' Action (F2) Goes Through: select where you want to navigate when you press F2. You can navigate to the problems with the highest priority or all the detected problems.
- Show Auto-Import Tooltip: toggles the auto-import feature. The setting does not influence the auto-import when you select constraints from the code completion list.
- Compact View: minimizes the tooltip.
Gif

Configure the severity level of inspections

Click the widget in the upper-right corner of the editor.
From the Highlight list, select the severity level.

Run inspections﻿

Instant analysis of the current file﻿

tip

Navigate to detected problems﻿

Run inspections manually﻿

Run all inspections﻿

Specify Inspection Scope dialog﻿

Run a single inspection﻿

Run code inspection with Qodana﻿

Install the Qodana plugin﻿

Run inspections offline﻿

Change the order of scopes﻿

Widget for inspections﻿

Configure the widget﻿

Configure the severity level of inspections﻿