detekt uses a yaml style configuration file for various things:
- rule set and rule properties
- build failure
- console reports
- output reports
See the default-detekt-config.yml file for all defined configuration options and their default values.
Note: When using a custom config file, the default values are ignored unless you also set the
Rule sets and rules
detekt allows easily to just pick the rules you want and configure them the way you like. For example if you want to allow up to 20 functions inside a Kotlin file instead of the default threshold of 10, write:
complexity: TooManyFunctions: threshold: 20
To read about all supported rule sets and rules, use the side navigation
Path Filters / Excludes / Includes
Fine grained path filters can be defined for each rule or rule set through globing patterns. This gives the user more freedom in analyzing only specific files and rule authors the ability to write library only rules.
complexity: TooManyFunctions: ... excludes: ['**/internal/**'] includes: ['**/internal/util/NeedsToBeChecked.kt']
Detekt supports the option to fail your build if a threshold of code smell issues is met.
For this the following code must be inside the detekt config:
build: maxIssues: 10 # break the build if ten weighted issues are found weights: complexity: 2 # every rule of the complexity rule set should count as if two issues were found... LongParameterList: 1 # ...with the exception of the LongParameterList rule. comments: 0 # comment rules are just a nice to know?!
Every rule and rule set can be attached with an integer value which is the weight of the finding. For example: If you have 5 findings of the category complexity, then your failThreshold of 10 is reached as 5 x 2 = 10.
Weights are respected in the following priority order:
- The specified weight for a rule
- The specified weight for a rule set
- By default, the weight is 1.
Uncomment the reports you don’t care about.
console-reports: active: true exclude: # - 'ProjectStatisticsReport' # - 'ComplexityReport' # - 'NotificationReport' # - 'FindingsReport' # - 'FileBasedFindingsReport'
ProjectStatisticsReport contains metrics and statistics concerning the analyzed project sorted by priority.
ComplexityReport contains metrics concerning the analyzed code. For instance the source lines of code and the McCabe complexity are calculated.
NotificationReport contains notifications reported by the detekt analyzer similar to push notifications. It’s simply a way of alerting users to information that they have opted-in to.
FindingsReport contains all rule violations in a list format grouped by ruleset.
FileBasedFindingsReport is similar to the FindingsReport shown above. The rule violations are grouped by file location.
Uncomment the reports you don’t care about.
output-reports: active: true exclude: # - 'HtmlOutputReport' # - 'TxtOutputReport' # - 'XmlOutputReport' # - 'SarifOutputReport'
HtmlOutputReport contains rule violations and metrics formatted in a human friendly way, so that it can be inspected in a web browser.
TxtOutputReport contains rule violations in a plain text report similar to a log file.
XmlOutputReport contains rule violations in an XML format. The report follows the structure of a Checkstyle report.
SarifOutputReport contains rule violations in the SARIF format. Please check SARIF.
Rule violations show the name of the violated rule and in which file the issue happened. The mentioned metrics show detailed statistics concerning the analyzed code. For instance the source lines of code and the McCabe complexity are calculated.
Count processors are used to calculate project metrics. For example, when all count processors are enabled, a detekt html report might look like this:
'DetektProgressListener' processor shows a progress indicator in stdout while a detekt process is running.
Uncomment the processors you don’t care about.
processors: active: true exclude: - 'DetektProgressListener' # - 'KtFileCountProcessor' # - 'PackageCountProcessor' # - 'ClassCountProcessor' # - 'FunctionCountProcessor' # - 'PropertyCountProcessor' # - 'ProjectComplexityProcessor' # - 'ProjectCognitiveComplexityProcessor' # - 'ProjectLLOCProcessor' # - 'ProjectCLOCProcessor' # - 'ProjectLOCProcessor' # - 'ProjectSLOCProcessor' # - 'LicenseHeaderLoaderExtension'
Config JSON Schema
A JSON Schema for the config file is available on: json.schemastore.org/detekt.
You can configure your IDE (e.g. IntelliJ or Android Studio have built-in support) to use that schema to give you autocompletion capabilities on your config file. More details on the IntelliJ support are available on this page.
The JSON Schema is currently not automatically generated. It can be updated manually on this repository.