diktat-analysis.yml

- name: DIKTAT_COMMON
  enabled: true
  configuration:
    domainName: org.jetbrains.reflekt
    kotlinVersion: 1.6
    srcDirectories: "main"
    testDirs: "test,nativeTest,commonTest"
- name: PARAMETER_NAME_IN_OUTER_LAMBDA
  enabled: false
- name: ENUM_VALUE
  enabled: true
  configuration:
    enumStyle: snakeCase
- name: KDOC_CONTAINS_DATE_OR_AUTHOR
  enabled: true
  configuration:
    versionRegex: \d+\.\d+\.\d+[-.\w\d]*
- name: HEADER_MISSING_OR_WRONG_COPYRIGHT
  enabled: true
  configuration:
    isCopyrightMandatory: false
    copyrightText: ''
- name: FILE_IS_TOO_LONG
  enabled: true
  configuration:
    maxSize: 2000
    ignoreFolders: ''
- name: FILE_UNORDERED_IMPORTS
  enabled: true
  configuration:
    useRecommendedImportsOrder: true
- name: FILE_WILDCARD_IMPORTS
  enabled: false
  configuration:
    allowedWildcards: "org.jetbrains.kotlin.psi.*"
- name: BRACES_BLOCK_STRUCTURE_ERROR
  enabled: true
  configuration:
    openBraceNewline: true
    closeBraceNewline: true
- name: WRONG_INDENTATION
  enabled: true
  configuration:
    # Is newline at the end of a file needed
    newlineAtEnd: true
    # If true: in parameter list when parameters are split by newline they are indented with two indentations instead of one
    extendedIndentOfParameters: false
    # If true: if first parameter in parameter list is on the same line as opening parenthesis, then other parameters can be aligned with it
    alignedParameters: true
    # If true: if expression is split by newline after operator like +/-/`*`, then the next line is indented with two indentations instead of one
    extendedIndentAfterOperators: false
    # If true: when dot qualified expression starts on a new line, this line will be indented with two indentations instead of one
    extendedIndentBeforeDot: false
    # The indentation size for each file
    indentationSize: 4
- name: EMPTY_BLOCK_STRUCTURE_ERROR
  enabled: true
  configuration:
    styleEmptyBlockWithNewline: true
    allowEmptyBlocks: false
- name: LONG_LINE
  enabled: true
  configuration:
    lineLength: 180
- name: WRONG_NEWLINES
  enabled: true
  configuration:
    maxParametersInOneLine: 3
- name: TOO_MANY_CONSECUTIVE_SPACES
  enabled: true
  configuration:
    maxSpaces: 1
    saveInitialFormattingForEnums: false
- name: LONG_NUMERICAL_VALUES_SEPARATED
  enabled: true
  configuration:
    maxNumberLength: 5
    maxBlockLength: 3
- name: WRONG_DECLARATIONS_ORDER
  enabled: true
  configuration:
    sortProperty: true
- name: COMMENT_WHITE_SPACE
  enabled: true
  configuration:
    maxSpacesBeforeComment: 2
    maxSpacesInComment: 1
- name: TYPE_ALIAS
  enabled: true
  configuration:
    typeReferenceLength: 34
- name: TOO_LONG_FUNCTION
  enabled: true
  configuration:
    maxFunctionLength: 60 # max length of function
    isIncludeHeader: false # count function's header
- name: TOO_MANY_PARAMETERS
  enabled: true
  configuration:
    maxParameterListSize: 5
- name: NESTED_BLOCK
  enabled: true
  configuration:
    maxNestedBlockQuantity: 4
- name: TRAILING_COMMA
  enabled: true
  configuration:
    valueArgument: true
    valueParameter: true
# disabled due to a huge number of documentation that should be added
- name: MISSING_KDOC_ON_FUNCTION
  enabled: false
# disabled due to a huge number of documentation that should be added
- name: MISSING_KDOC_CLASS_ELEMENTS
  enabled: false
# disabled due to a huge number of documentation that should be added
- name: MISSING_KDOC_TOP_LEVEL
  enabled: false
# disabled due to: https://github.com/JetBrains-Research/reflekt/pull/81#discussion_r748084473
- name: WHEN_WITHOUT_ELSE
  enabled: false
# disabled due to a huge number of documentation that should be added
- name: HEADER_MISSING_IN_NON_SINGLE_CLASS_FILE
  enabled: false
# in this project a lot of identifiers has legacy C-style prefixes as kType, kName, etc.
# In Java world such single-symbol prefixes are not a good practice
- name: VARIABLE_HAS_PREFIX
  enabled: false
# In this project everything is built using dummy utility objects. Their refactoring should be done in a separate PR
# These Utility classes are completely useless and make code heavier, as Kotlin supports top-level extension methods in files
- name: AVOID_USING_UTILITY_CLASS
  enabled: false
# Custom getters and setters should be revised later
- name: CUSTOM_GETTERS_SETTERS
  enabled: false
# https://github.com/diktat-static-analysis/diKTat/issues/1106
- name: TRAILING_COMMA
  enabled: false
# https://github.com/diktat-static-analysis/diKTat/issues/1109
- name: VARIABLE_NAME_INCORRECT_FORMAT
  enabled: false
# disabled due to: https://github.com/diktat-static-analysis/diKTat/issues/1090
- name: GENERIC_VARIABLE_WRONG_DECLARATION
  enabled: false
# disabled due to: https://github.com/diktat-static-analysis/diKTat/issues/1091
- name: COMMENTED_OUT_CODE
  enabled: false
# disabled because IDEA already tracks imports well
- name: FILE_UNORDERED_IMPORTS
  enabled: false
- name: KDOC_WITHOUT_RETURN_TAG
  enabled: false
- name: EXTENSION_FUNCTION_WITH_CLASS
  enabled: false
- name: IDENTIFIER_LENGTH
  enabled: false
- name: KDOC_DUPLICATE_PROPERTY
  enabled: false