Inspections
The Inspections Build Runner is intended to run code analysis based on IntelliJ IDEA inspections for your project. IntelliJ IDEA's code analysis engine is capable of inspecting your Java, JavaScript, HTML, XML and other code and allows to:
Find probable bugs
Locate "dead" code
Detect performance issues
Improve code structure and maintainability
Ensure the code conforms to guidelines, standards and specifications
Refer to IntelliJ IDEA documentation for more details.
This page contains reference information about the Inspections Build Runner fields:
IntelliJ IDEA Project Settings
Option | Description |
---|---|
Project file type | To be able to run IntelliJ IDEA inspections on your code, TeamCity requires either IntelliJ IDEA project file/directory, or Maven2 pom.xml to be specified here. |
Path to the project | Depending on what type of project you have selected in the Project file type, specify here:
|
Detect global libraries and module-based JDK in the *.iml files | This option is available, if you use IntelliJ IDEA project to run the inspections. In IntelliJ IDEA module settings are stored in *.iml files, thus if this option is checked, all the module files will be automatically scanned for references to the global libraries and module JDKs when saved. This helps you ensure all references will be properly resolved. |
Check/Reparse Project | Click this button to reparse your Maven2/IntelliJ IDEA project and import build settings right from the project, for example the list of JDKs. |
Working directory | Enter a path to a build working directory, if it differs from the build checkout directory. Optional, specify if differs from the checkout directory. |
Unresolved Project Modules and Path Variables
This section is displayed, when an IntelliJ IDEA module file (.iml) referenced from IntelliJ IDEA project file:
cannot be found
allows you to enter the values of path variables used in the IPR-file.
To refresh values in this section click Check/Reparse Project.
Option | Description |
---|---|
<path_variable_name> | This field appears, if the project file contains path macros, defined in the Path Variables dialog of IntelliJ IDEA's Settings dialog. In the Set value to field, specify a path to project resources, to be used on different build agents. |
Project JDKs
This section provides the list of JDKs detected in the project.
Option | Description |
---|---|
JDK Home | Use this field to specify JDK home for the project. |
JDK Jar File Patterns | Click this link to open a text area, where you can define templates for the jar files of the project JDK. Use Ant rules to define the jar file patterns. The default value is used for Linux and Windows operating systems: For Mac OS X, use the following lines: |
IDEA Home | If your project uses the IDEA JDK, specify the location of IDEA home directory |
IDEA Jar Files Patterns | Click this link to open a text area, where you can define templates for the jar files of the IDEA JDK. |
Java Parameters
Option | Description |
---|---|
JDK home path | Use this field to specify the path to your custom JDK which should be used to run the build. If the field is left blank, the path to JDK Home is read either from the |
JVM command line parameters | Specify the desired Java Virtual Machine parameters, for example maximum heap size. These settings are passed to the JVM used to run your build. Example: |
Inspection Parameters
In IntelliJ IDEA-based IDEs, the code inspections reported are configured by an inspection profile. When running the inspections in TeamCity you can specify the inspection profile to use. You need to configure the inspection profile in IntelliJ IDEA-based IDE and then specify it in TeamCity.
Please follow these rules when preparing inspection profiles:
if your inspection profile uses scopes, make sure the scopes are shared;
lock the profile (this ensures that inspections that are present in TeamCity, but not enabled in your IDEA installation will not be run by TeamCity);
ensure the profile does not have inspections provided by plugins not included into default IntelliJ IDEA Ultimate distribution (otherwise they will just be ignored by TeamCity);
for best results edit the inspection profile in the IntelliJ IDEA of the same version as used by TeamCity (can be looked up in the inspection build log).
The logic of selecting an inspection profile is as follows:
if the path to the inspection profile is specified, then profile will be loaded from the file. If the loading fails, inspection runner will fail too.
if the name of the inspection profile is specified, the profile is searched for in the project's shared profiles. If there is no such profile, inspection runner will fail.
if neither name nor path is specified default profile of the project is used.
Option | Description |
---|---|
Inspections profile path | Use this text field to specify the path to inspections profiles file relative to the project root directory. Use this field only if you do not want to use shared project profile specified with "Inspections profile name". |
Inspections profile name | Enter the name of the desired shared project profile. If the field is left blank and no profile path is specified default project profile will be used. |