Sider Documentation

Sider Documentation

  • Enterprise
  • News
  • Sider Top

›Kotlin

Getting Started

  • Home
  • Intro Videos
  • Setting up Sider
  • Dashboard Overview
  • Repository Settings
  • Custom Analysis Configuration
  • Recommended Ruleset
  • Working with Issues
  • Permissions
  • Skip Analyzing

Analysis Tools

    Ruby

    • RuboCop
    • Reek
    • Querly
    • Rails Best Practices
    • Brakeman
    • HAML-Lint
    • Slim-Lint (beta)

    Java

    • Checkstyle
    • PMD
    • JavaSee

    Kotlin

    • ktlint (beta)
    • detekt (beta)

    JavaScript and Flavors

    • ESLint
    • JSHint
    • TyScan
    • CoffeeLint
    • TSLint (deprecated)

    CSS

    • stylelint
    • SCSS-Lint (deprecated)

    PHP

    • PHP_CodeSniffer
    • PHPMD
    • Phinder

    Python

    • Flake8
    • Pylint (beta)

    Swift

    • SwiftLint

    Go

    • GolangCI-Lint

    C/C++

    • Cppcheck
    • cpplint
    • Clang-Tidy (beta)

    C#

    • FxCop (beta)

    Shell script

    • ShellCheck

    Dockerfile

    • hadolint

    Markdown

    • remark-lint

    Others

    • Goodcheck
    • Misspell
    • LanguageTool (beta)
    • PMD CPD (beta)

Custom Rules

  • Intro to Custom Rules
  • Goodcheck
  • Tips & Tricks

Advanced Settings

  • Inline Comments
  • Private Dependencies
  • Restricting access to Close button
  • Transferring a repository

Billing and Plans

  • Billing and Plans

Troubleshooting

  • Troubleshooting

Enterprise

  • Outline
  • System Overview
  • Installation
  • Configuration
  • Operation
  • Update
  • Load Balancer
  • MySQL
  • Redis
  • MinIO
  • Amazon S3
  • GitHub Enterprise Server
  • Clustering
  • Example Deployments

    • Single Node with Docker Compose

    Releases

    • Overview
    • February 2021
    • January 2021
    • December 2020
    • October 2020
    • September 2020
    • August 2020
    • July 2020
    • June 2020
    • May 2020
    • April 2020
    • February 2020
    • January 2020
    • November 2019
    • Older releases

News

  • 2021
  • 2020
  • 2019
Edit

detekt

This is BETA. The behavior of this tool might change.

Supported VersionLanguageWebsite
1.15.0Kotlinhttps://detekt.github.io/detekt

detekt is a linter which code smell analysis for your Kotlin projects.

Getting Started

To start using detekt, enable it in your repository settings, and put a configuration in sider.yml.

Using detekt

You can use detekt without any configuration, but we recommend to make a configuration.

Put the detekt key in sider.yml to customize the execution of detekt.

linter:
  detekt:
    baseline: "baseline.xml"
    config:
      - "path/to/detekt-config.yml"
      - "path/to/another/detekt-config.yml"
    config-resource: []
    disable-default-rulesets: false
    excludes:
      - "**/excludes_dir/**"
      - "**/another/excludes_dir/**"
    includes: []
    input:
      - "src/"

Configuration

You can customize your detekt analysis using sider.yml.

NameTypeDefault
root_dirstring-
jvm_depsstring[][][]
baselinestring-
configstring, string[][]
config-resourcestring, string[][]
disable-default-rulesetsbooleanfalse
excludesstring, string[][]
includesstring, string[][]
inputstring, string[].

For more details about the options, see the official documentation.

baseline

This option allows you to specify a baseline XML file path. If the file is passed, only new code smells not in the baseline are reported.

config

This option allows you to specify your configuration file(s) path for detekt.

config-resource

This option allows you to specify the configuration resource path(s) on detekt's classpath.

disable-default-rulesets

This option allows you to specify whether disables the default rule sets or not.

excludes

This option allows you to specify glob pattern(s) of paths to exclude from the analysis.

includes

This option allows you to specify glob pattern(s) of paths to include in the analysis.

input

This option allows you to specify input path(s) to analyze.

← ktlint (beta)ESLint →
  • Getting Started
    • Using detekt
  • Configuration
    • baseline
    • config
    • config-resource
    • disable-default-rulesets
    • excludes
    • includes
    • input
Sider Documentation
Docs
Getting StartedAnalysis ToolsEnterprise
Sider
Sider TopTerms of ServicePrivacy
Social
BlogGitHubStar
Copyright © 2021 Sider, Inc.