saveourtool / diktat

Strict coding standard for Kotlin and a custom set of rules for detecting code smells, code style issues and bugs

DiKTat is a strict coding standard for Kotlin, consisting of a collection of Kotlin code style rules implemented as Abstract Syntax Tree (AST) visitors built on top of KTlint. It serves the purpose of detecting and automatically fixing code smells in the Continuous Integration/Continuous Deployment (CI/CD) process. You can find the comprehensive list of supported rules and inspections here.

DiKTat has gained recognition and has been added to the lists of static analysis tools, kotlin-awesome, and kompar. We extend our gratitude to the community for this support!

See first

Codestyle	Inspections	Examples	Demo	White Paper	Groups of Inspections

Why Choose DiKTat for CI/CD?

While there are other tools like detekt and ktlint performing static analysis, you might wonder why DiKTat is necessary. Here are the key reasons:

1. More Inspections: DiKTat boasts over 100 inspections tightly coupled with its Codestyle.

2. Unique Inspections: DiKTat introduces unique inspections not found in other linters.

3. Highly Configurable: Every inspection is highly configurable, allowing customization and suppression. Check configuration options and suppression.

4. Strict Codestyle: DiKTat enforces a detailed Codestyle that can be adopted and applied in your project.

Run as CLI-application

Download binary

1. Download diKTat manually: here

   OR use curl:

   curl -sSLO https://github.com/saveourtool/diktat/releases/download/v2.0.0/diktat && chmod a+x diktat

For Windows only. Download diKTat.cmd manually: here

Run diKTat

Finally, run KTlint (with diKTat injected) to check your '*.kt' files in 'dir/your/dir':

$ ./diktat "dir/your/dir/**/*.kt"

On Windows

diktat.bat "dir/your/dir/**/*.kt"

To autofix all code style violations, use --mode fix option.

Run with Maven using diktat-maven-plugin

You can see how it is configured in our examples:

• Single project
• Multi-module project

Add this plugin to your pom.xml:

            <plugin>
                <groupId>com.saveourtool.diktat</groupId>
                <artifactId>diktat-maven-plugin</artifactId>
                <version>${diktat.version}</version>
                <executions>
                    <execution>
                        <id>diktat</id>
                        <phase>none</phase>
                        <goals>
                            <goal>check</goal>
                            <goal>fix</goal>
                        </goals>
                        <configuration>
                            <inputs>
                                <input>${project.basedir}/src/main/kotlin</input>
                                <input>${project.basedir}/src/test/kotlin</input>
                            </inputs>
                            <diktatConfigFile>diktat-analysis.yml</diktatConfigFile>
                           <excludes>
                              <exclude>${project.basedir}/src/test/kotlin/excluded</exclude>
                           </excludes>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

To run diktat in only-check mode use command $ mvn diktat:check@diktat. To run diktat in autocorrect mode use command $ mvn diktat:fix@diktat.

Requesting a specific Maven executionId on the command line (the trailing diktat in the above example) may be essential in these cases:

• In your pom.xml, you have multiple executions with different configurations (e. g.: multiple rule sets):

  <executions>
  
      <execution>
          <id>diktat-basic</id>
          <configuration>
              <diktatConfigFile>diktat-analysis.yml</diktatConfigFile>
          </configuration>
      </execution>
  
      <execution>
          <id>diktat-advanced</id>
          <configuration>
              <diktatConfigFile>diktat-analysis-advanced.yml</diktatConfigFile>
          </configuration>
      </execution>
  
  </executions>

• Your YAML file with DiKTat rules has a non-default name and/or resides in a non-default location:

  <executions>
      <execution>
          <id>diktat</id>
          <configuration>
              <diktatConfigFile>/non/default/rule-set-file.yml</diktatConfigFile>
          </configuration>
      </execution>
  </executions>

  • You can omit the diktatConfigFile or if it points to non-existed file then DiKTat runs with default configuration.

If you omit the executionId:

$ mvn diktat:check

— the plug-in will use the default configuration and search for diktat-analysis.yml file in the project directory (you can still customize the rule sets by editing the YAML file).

Run with Gradle using diktat-gradle-plugin

Requires a gradle version no lower than 7.0

You can see how the plugin is configured in our examples:

• Kotlin DSL
• Kotlin DSL for multi-module project
• Groovy DSL

Add this plugin to your `build.gradle.kts`:

plugins {
    id("com.saveourtool.diktat") version "2.0.0"
}

Note If you want to apply the plugin to multi-module projects"

import com.saveourtool.diktat.plugin.gradle.DiktatGradlePlugin

plugins {
    id("com.saveourtool.diktat") version "2.0.0" apply false
}

allprojects {
    apply<DiktatGradlePlugin>()
}

You can then configure diktat using diktat extension:

diktat {
    inputs {
        include("src/**/*.kt")  // path matching this pattern (per PatternFilterable) that will be checked by diktat
        exclude("src/test/kotlin/excluded/**")  // path matching this pattern will not be checked by diktat
    }
    debug = true  // turn on debug logging
}

Also in diktat extension you can configure different reporters and their output. You can specify json, html, sarif, plain (default). If output is set, it should be a file path. If not set, results will be printed to stdout. You can specify multiple reporters. If no reporter is specified, plain will be used with stdout as output.

diktat {
    reporters {
        plain()
        json()
        html {
            output = file("someFile.html")
        }
        // checkstyle()
        // sarif()
        // gitHubActions()
    }
}

You can run diktat checks using task ./gradlew diktatCheck and automatically fix errors with task ./gradlew diktatFix.

Run with Spotless

Spotless is a linter aggregator.

Gradle

Diktat can be run via spotless-gradle-plugin since version 5.10.0

Add this plugin to your build.gradle.kts

plugins {
   id("com.diffplug.spotless") version "5.10.0"
}

spotless {
   kotlin {
      diktat()
   }
   kotlinGradle {
      diktat()
   }
}

You can provide a version and configuration path manually as configFile.

spotless {
   kotlin {
      diktat("2.0.0").configFile("full/path/to/diktat-analysis.yml")
   }
}

Maven

Diktat can be run via spotless-maven-plugin since version 2.8.0

Add this plugin to your pom.xml

<plugin>
   <groupId>com.diffplug.spotless</groupId>
   <artifactId>spotless-maven-plugin</artifactId>
   <version>${spotless.version}</version>
   <configuration>
      <kotlin>
         <diktat />
      </kotlin>
   </configuration>
</plugin>

You can provide a version and configuration path manually as configFile

<diktat>
  <version>2.0.0</version> <!-- optional -->
  <configFile>full/path/to/diktat-analysis.yml</configFile> <!-- optional, configuration file path -->
</diktat>

GitHub Integration

We suggest everyone to use common "sarif" format as a reporter in CI/CD. GitHub has an integration with SARIF format and provides you a native reporting of diktat issues in Pull Requests.

Github Integration

1) Add the following configuration to your project's setup for GitHub Actions:

Gradle Plugin:

    githubActions = true

Maven Plugin (pom.xml):

    <githubActions>true</githubActions>

Maven Plugin (cli options):

mvn -B diktat:check@diktat -Ddiktat.githubActions=true

2. Add the following code to your GitHub Action to upload diktat SARIF report (after it was generated):

      - name: Upload SARIF to Github using the upload-sarif action
        uses: github/codeql-action/upload-sarif@v1
        if: ${{ always() }}
        with:
          sarif_file: ${{ github.workspace }}

Note: codeql-action/upload-sarif limits the number of uploaded files at 15. If your project has more than 15 subprojects, the limit will be exceeded and the step will fail. To solve this issue one can merge SARIF reports.

diktat-gradle-plugin provides this capability with mergeDiktatReports task. This task aggregates reports of all diktat tasks of all Gradle project, which produce SARIF reports, and outputs the merged report into root project's build directory. Then this single file can be used as an input for GitHub action:

with:
    sarif_file: build/reports/diktat/diktat-merged.sarif

Customizations via diktat-analysis.yml

In Diktat we have supported diktat-analysis.yml that can be easily changed and help in customization of your own rule set. It has simple fields: name — name of the rule, enabled (true/false) — to enable or disable that rule (all rules are enabled by the default), configuration — a simple map of some extra unique configurations for this particular rule. For example:

- name: HEADER_MISSING_OR_WRONG_COPYRIGHT
  # all rules are enabled by the default. To disable add 'enabled: false' to the config.
  enabled: true
  configuration:
    isCopyrightMandatory: true
    copyrightText: Copyright (c) Jeff Lebowski, 2012-2020. All rights reserved.

Note, that you can specify and put diktat-analysis.yml that contains configuration of diktat in the parent directory of your project on the same level where build.gradle/pom.xml is stored.
See default configuration in diktat-analysis.yml
Also see the list of all rules supported by diKTat.

Suppress warnings/inspections

Suppress warnings on individual code blocks

In addition to enabling/disabling warning globally via config file (`enable = false`), you can suppress warnings by adding `@Suppress` annotation on individual code blocks or `@file:Suppress()` annotation on a file-level.

For example:

@Suppress("FUNCTION_NAME_INCORRECT_CASE")
class SomeClass {
    fun methODTREE(): String {

    }
}

Disable all inspections on selected code blocks

Also you can suppress **all** warnings by adding `@Suppress("diktat")` annotation on individual code blocks.

For example:

@Suppress("diktat")
class SomeClass {
    fun methODTREE(): String {

    }
}

ignoreAnnotated: disable inspections on blocks with predefined annotation

In the `diktat-analysis.yml` file for each inspection it is possible to define a list of annotations that will cause disabling of the inspection on that particular code block:

- name: HEADER_NOT_BEFORE_PACKAGE
  enabled: true
  ignoreAnnotated: [MyAnnotation, Compose, Controller]

Suppress groups of inspections by chapters

It is easy to suppress even groups of inspections in diKTat.

These groups are linked to chapters of Codestyle.

To disable chapters, you will need to add the following configuration to common configuration (- name: DIKTAT_COMMON):

    disabledChapters: "1, 2, 3"

Mapping of inspections to chapters can be found in Groups of Inspections.

Running against the baseline

When setting up code style analysis on a large existing project, one often doesn't have an ability to fix all findings at once. To allow gradual adoption, diktat and ktlint support baseline mode. When running ktlint for the first time with active baseline, the baseline file will be generated. It is a xml file with a complete list of findings by the tool. On later invocations, only the findings that are not in the baseline file will be reported. Baseline can be activated with CLI flag:

./diktat --baseline=diktat-baseline.xml **/*.kt

or with corresponding configuration options in maven or gradle plugins. Baseline report is intended to be added into the VCS, but it can be removed and re-generated later, if needed.

Contribution

See our Contributing Policy and Code of Conduct

Kotlin Coding Style Guide (Diktat Code Style), v.1.0.0

I Preface

• I.I Purpose of this document
• I.II General principles
• I.III Terminology
• I.IV Exceptions

1. Naming

• 1.1 Identifiers
• 1.2 Packages
• 1.3 Classes, enumerations, interfaces
• 1.4 Functions
• 1.5 Constants
• 1.6 Non-constant fields (variables)
  • 1.6.1 Non-constant field name
  • 1.6.2 Boolean variable names with negative meaning

2. Comments

• 2.1 General form of Kdoc
  • 2.1.1 Using KDoc for the public, protected, or internal code elements
  • 2.1.2 Describing methods that have arguments, a return value, or can throw an exception in the KDoc block
  • 2.1.3 Only one space between the Kdoc tag and content. Tags are arranged in the order.
• 2.2 Adding comments on the file header
• 2.3 Comments on the function header
• 2.4 Code comments
  • 2.4.1 Add a blank line between the body of the comment and Kdoc tag-blocks
  • 2.4.2 Do not comment on unused code blocks
  • 2.4.3 Code delivered to the client should not contain TODO/FIXME comments

3. General formatting (typesetting)

• 3.1 File-related rules
  • 3.1.1 Avoid files that are too long
  • 3.1.2 Code blocks in the source file should be separated by one blank line
  • 3.1.3 Import statements order
  • 3.1.4 Order of declaration parts of class-like code structures
  • 3.1.5 Order of declaration of top-level code structures
• 3.2 Braces
  • 3.2.1 Using braces in conditional statements and loop blocks
  • 3.2.2 Opening braces are placed at the end of the line in non-empty blocks and block structures
• 3.3 Indentation
• 3.4 Empty blocks
• 3.5 Line length
• 3.6 Line breaks (newlines)
  • 3.6.1 Each line can have a maximum of one statement
  • 3.6.2 Rules for line-breaking
• 3.7 Using blank lines
• 3.8 Horizontal space
  • 3.8.1 Usage of whitespace for code separation
  • 3.8.2 No spaces for horizontal alignment
• 3.9 Enumerations
• 3.10 Variable declaration
  • 3.10.1 Declare one variable per line
  • 3.10.2 Variables should be declared near the line where they are first used
• 3.11 'When' expression
• 3.12 Annotations
• 3.13 Block comments
• 3.14 Modifiers and constant values
  • 3.14.1 Declaration with multiple modifiers
  • 3.14.2 Separate long numerical values with an underscore
• 3.15 Strings
  • 3.15.1 Concatenation of Strings
  • 3.15.2 String template format
• 3.16 Conditional statements
  • 3.16.1 Collapsing redundant nested if-statements
  • 3.16.2 Too complex conditions

4. Variables and types

• 4.1 Variables
  • 4.1.1 Do not use Float and Double types when accurate calculations are needed
  • 4.1.2 Comparing numeric float type values
  • 4.1.3 Try to use 'val' instead of 'var' for variable declaration [SAY_NO_TO_VAR]
• 4.2 Types
  • 4.2.1 Use Contracts and smart cast as much as possible
  • 4.2.2 Try to use type alias to represent types making code more readable
• 4.3 Null safety and variable declarations
  • 4.3.1 Avoid declaring variables with nullable types, especially from Kotlin stdlib
  • 4.3.2 Variables of generic types should have an explicit type declaration
  • 4.3.3 Null-safety

5. Functions

• 5.1 Function design
  • 5.1.1 Avoid functions that are too long
  • 5.1.2 Avoid deep nesting of function code blocks, limiting to four levels
  • 5.1.3 Avoid using nested functions
  • 5.1.4 Negated function calls
• 5.2 Function arguments
  • 5.2.1 The lambda parameter of the function should be placed at the end of the argument list
  • 5.2.2 Number of function parameters should be limited to five
  • 5.2.3 Use default values for function arguments instead of overloading them
  • 5.2.4 Synchronizing code inside asynchronous code
  • 5.2.5 Long lambdas should have explicit parameters
  • 5.2.6 Avoid using unnecessary, custom label

6. Classes, interfaces, and extension functions

• 6.1 Classes
  • 6.1.1 Denoting a class with a single constructor
  • 6.1.2 Prefer data classes instead of classes without any functional logic
  • 6.1.3 Do not use the primary constructor if it is empty or useless
  • 6.1.4 Do not use redundant init blocks in your class
  • 6.1.5 Explicit supertype qualification
  • 6.1.6 Abstract class should have at least one abstract method
  • 6.1.7 When using the "implicit backing property" scheme, the name of real and back property should be the same
  • 6.1.8 Avoid using custom getters and setters
  • 6.1.9 Never use the name of a variable in the custom getter or setter (possible_bug)
  • 6.1.10 No trivial getters and setters are allowed in the code
  • 6.1.11 Use 'apply' for grouping object initialization
  • 6.1.12 Prefer Inline classes when a class has a single property
• 6.2 Extension functions
  • 6.2.1 Use extension functions for making logic of classes less coupled
  • 6.2.2 No extension functions with the same name and signature if they extend base and inheritor classes (possible_bug)
  • 6.2.3 Don't use extension functions for the class in the same file
• 6.3 Interfaces
• 6.4 Objects
  • 6.4.1 Instead of using utility classes/objects, use extensions
  • 6.4.2 Objects should be used for Stateless Interfaces
• 6.5 Kts Files
  • 6.5.1 kts files should wrap logic into top-level scope

Preface

Purpose of this document

The purpose of this document is to provide a specification that software developers could reference to enhance their ability to write consistent, easy-to-read, and high-quality code. Such a specification will ultimately improve software development efficiency and product competitiveness. For the code to be considered high-quality, it must entail the following characteristics:

1. Simplicity
2. Maintainability
3. Reliability
4. Testability
5. Efficiency
6. Portability
7. Reusability

General principles

Like other modern programming languages, Kotlin is an advanced programming language that complies with the following general principles:

1. Clarity — a necessary feature of programs that are easy to maintain and refactor.
2. Simplicity — a code is easy to understand and implement.
3. Consistency — enables a code to be easily modified, reviewed, and understood by the team members. Unification is particularly important when the same team works on the same project, utilizing similar styles enabling a code to be easily modified, reviewed, and understood by the team members.

Also, we need to consider the following factors when programming on Kotlin:

1. Writing clean and simple Kotlin code

   Kotlin combines two of the main programming paradigms: functional and object-oriented. Both of these paradigms are trusted and well-known software engineering practices. As a young programming language, Kotlin is built on top of well-established languages such as Java, C++, C#, and Scala. This enables Kotlin to introduce many features that help a developer write cleaner, more readable code while also reducing the number of complex code structures. For example, type and null safety, extension functions, infix syntax, immutability, val/var differentiation, expression-oriented features, "when" statements, much easier work with collections, type auto conversion, and other syntactic sugar.

2. Following Kotlin idioms

   The author of Kotlin, Andrey Breslav, mentioned that Kotlin is both pragmatic and practical, but not academic. Its pragmatic features enable ideas to be transformed into real working software easily. Kotlin is closer to natural languages than its predecessors, and it implements the following design principles: readability, reusability, interoperability, security, and tool-friendliness (https://blog.jetbrains.com/kotlin/2018/10/kotlinconf-2018-announcements/).

3. Using Kotlin efficiently

   Some Kotlin features can help you to write higher-performance code: including rich coroutine library, sequences, inline functions/classes, arrays of basic types, tailRec, and CallsInPlace of contract.

Terminology

Rules — conventions that should be followed when programming.

Recommendations — conventions that should be considered when programming.

Explanation — necessary explanations of rules and recommendations.

Valid Example — recommended examples of rules and recommendations.

Invalid Example — not recommended examples of rules and recommendations.

Unless otherwise stated, this specification applies to versions 1.3 and later of Kotlin.

Exceptions

Even though exceptions may exist, it is essential to understand why rules and recommendations are needed. Depending on a project situation or personal habits, you can break some of the rules. However, remember that one exception may lead to many and eventually can destroy code consistency. As such, there should be very few exceptions. When modifying open-source code or third-party code, you can choose to use the code style from this open-source project (instead of using the existing specifications) to maintain consistency. Software that is directly based on the Android native operating system interface, such as the Android Framework, remains consistent with the Android style.

1. Naming

In programming, it is not always easy to meaningfully and appropriately name variables, functions, classes, etc. Using meaningful names helps to clearly express your code's main ideas and functionality and avoid misinterpretation, unnecessary coding and decoding, "magic" numbers, and inappropriate abbreviations.

Note: The source file encoding format (including comments) must be UTF-8 only. The ASCII horizontal space character (0x20, that is, space) is the only permitted whitespace character. Tabs should not be used for indentation.

1.1 Identifiers

This section describes the general rules for naming identifiers.

1.1.1 Identifiers naming conventions

For identifiers, use the following naming conventions:

1. All identifiers should use only ASCII letters or digits, and the names should match regular expressions \w{2,64}. Explanation: Each valid identifier name should match the regular expression \w{2,64}. {2,64} means that the name length is 2 to 64 characters, and the length of the variable name should be proportional to its life range, functionality, and responsibility. Name lengths of less than 31 characters are generally recommended. However, this depends on the project. Otherwise, a class declaration with generics or inheritance from a superclass can cause line breaking. No special prefix or suffix should be used in names. The following examples are inappropriate names: name_, mName, s_name, and kName.

2. Choose file names that would describe the content. Use camel case (PascalCase) and .kt extension.

3. Typical examples of naming:

Meaning	Correct	Incorrect
"XML Http Request"	XmlHttpRequest	XMLHTTPRequest
"new customer ID"	newCustomerId	newCustomerID
"inner stopwatch"	innerStopwatch	innerStopWatch
"supports IPv6 on iOS"	supportsIpv6OnIos	supportsIPv6OnIOS
"YouTube importer"	YouTubeImporter	YoutubeImporter

4. The usage of (``) and free naming for functions and identifiers are prohibited. For example, the following code is not recommended:

val `my dummy name-with-minus` = "value"

The only exception is function names in Unit tests.

5. Backticks (``) should not be used for identifiers, except the names of test methods (marked with @Test annotation):

 @Test fun `my test`() { /*...*/ }

6. The following table contains some characters that may cause confusion. Be careful when using them as identifiers. To avoid issues, use other names instead.

Expected	Confusing name	Suggested name
0 (zero)	O, D	obj, dgt
1 (one)	I, l	it, ln, line
2 (two)	Z	n1, n2
5 (five)	S	xs, str
6 (six)	e	ex, elm
8 (eight)	B	bt, nxt
n,h	h,n	nr, head, height
rn, m	m,rn	mbr, item

Exceptions:

• The i,j,k variables used in loops are part of the industry standard. One symbol can be used for such variables.
• The e variable can be used to catch exceptions in catch block: catch (e: Exception) {}
• The Java community generally does not recommend the use of prefixes. However, when developing Android code, you can use the s and m prefixes for static and non-public non-static fields, respectively. Note that prefixing can also negatively affect the style and the auto-generation of getters and setters.

Type	Naming style
Interfaces, classes, annotations, enumerated types, and object type names	Camel case, starting with a capital letter. Test classes have a Test suffix. The filename is 'TopClassName'.kt.
Class fields, local variables, methods, and method parameters	Camel case starting with a low case letter. Test methods can be underlined with '_'; the only exception is backing properties.
Static constants and enumerated values	Only uppercase underlined with '_'
Generic type variable	Single capital letter, which can be followed by a number, for example: E, T, U, X, T2
Exceptions	Same as class names, but with a suffix Exception, for example: AccessException and NullPointerException

1.2 Packages

Rule 1.2.1 Package names dots

Package names are in lower case and separated by dots. Code developed within your company should start with your.company.domain. Numbers are permitted in package names. Each file should have a package directive. Package names are all written in lowercase, and consecutive words are concatenated together (no underscores). Package names should contain both the product or module names and the department (or team) name to prevent conflicts with other teams. Numbers are not permitted. For example: org.apache.commons.lang3, xxx.yyy.v2.

Exceptions:

• In certain cases, such as open-source projects or commercial cooperation, package names should not start with your.company.domain.
• If the package name starts with a number or other character that cannot be used at the beginning of the Java/Kotlin package name, then underscores are allowed. For example: com.example._123name.
• Underscores are sometimes permitted if the package name contains reserved Java/Kotlin keywords, such as org.example.hyphenated_name, int_.example.

Valid example:

package your.company.domain.mobilecontrol.views

1.3 Classes, enumerations, typealias, interfaces

This section describes the general rules for naming classes, enumerations, and interfaces.

1.3.1 Classes, enumerations, typealias, interface names use Camel case

Classes, enumerations, and interface names use UpperCamelCase nomenclature. Follow the naming rules described below:

1. A class name is usually a noun (or a noun phrase) denoted using the camel case nomenclature, such as UpperCamelCase. For example: Character or ImmutableList. An interface name can also be a noun or noun phrase (such as List) or an adjective or adjective phrase (such as Readable). Note that verbs are not used to name classes. However, nouns (such as Customer, WikiPage, and Account) can be used. Try to avoid using vague words such as Manager and Process.

2. Test classes start with the name of the class they are testing and end with 'Test'. For example, HashTest or HashIntegrationTest.

Invalid example:

class marcoPolo {}
class XMLService {}
interface TAPromotion {}
class info {}

Valid example:

class MarcoPolo {}
class XmlService {}
interface TaPromotion {}
class Order {}

1.4 Functions

This section describes the general rules for naming functions.

1.4.1 Function names should be in camel case

Function names should use lowerCamelCase nomenclature. Follow the naming rules described below:

1. Function names are usually verbs or verb phrases denoted with the camel case nomenclature (lowerCamelCase). For example: sendMessage, stopProcess, or calculateValue. To name functions, use the following formatting rules:

a) To get, modify, or calculate a certain value: get + non-boolean field(). Note that the Kotlin compiler automatically generates getters for some classes, applying the special syntax preferred for the 'get' fields: kotlin private val field: String get() { }. kotlin private val field: String get() { }.

private val field: String
get() {
}

Note: The calling property access syntax is preferred to call getter directly. In this case, the Kotlin compiler automatically calls the corresponding getter.

b) is + boolean variable name()

c) set + field/attribute name(). However, note that the syntax and code generation for Kotlin are completely the same as those described for the getters in point a.

d) has + Noun / adjective ()

e) verb() Note: Note: Verb are primarily used for the action objects, such as document.print ()

f) verb + noun()

g) The Callback function allows the names that use the preposition + verb format, such as: onCreate(), onDestroy(), toString().

Invalid example:

fun type(): String
fun Finished(): Boolean
fun visible(boolean)
fun DRAW()
fun KeyListener(Listener)

Valid example:

fun getType(): String
fun isFinished(): Boolean
fun setVisible(boolean)
fun draw()
fun addKeyListener(Listener)

2. An underscore (_) can be included in the JUnit test function name and should be used as a separator. Each logical part is denoted in lowerCamelCase, for example, a typical pattern of using underscore: pop_emptyStack.

1.5 Constants

This section describes the general rules for naming constraints.

1.5.1 Using UPPER case and underscore characters in a constraint name

Constant names should be in UPPER case, words separated by underscore. The general constant naming conventions are listed below:

1. Constants are attributes created with the const keyword or top-level/val local variables of an object that holds immutable data. In most cases, constants can be identified as a const val property from the object/companion object/file top level. These variables contain fixed constant values that typically should never be changed by programmers. This includes basic types, strings, immutable types, and immutable collections of immutable types. The value is not constant for the object, which state can be changed.
2. Constant names should contain only uppercase letters separated by an underscores. They should have a val or const val modifier to make them final explicitly. In most cases, if you need to specify a constant value, then you need to create it with the "const val" modifier. Note that not all val variables are constants.
3. Objects with immutable content, such as Logger and Lock, can be in uppercase as constants or have camel case as regular variables.
4. Use meaningful constants instead of magic numbers. SQL or logging strings should not be treated as magic numbers, nor should they be defined as string constants. Magic constants, such as NUM_FIVE = 5 or NUM_5 = 5 should not be treated as constants. This is because mistakes will easily be made if they are changed to NUM_5 = 50 or 55. These constants typically represent business logic values, such as measures, capacity, scope, location, tax rate, promotional discounts, and power base multiples in algorithms. You can avoid using magic numbers with the following method:

• Using library functions and APIs. For example, instead of checking that size == 0, use isEmpty() function. To work with time, use built-ins from java.time API.
• Enumerations can be used to name patterns. Refer to Recommended usage scenario for enumeration in 3.9.

Invalid example:

var int MAXUSERNUM = 200;
val String sL = "Launcher";

Valid example:

const val int MAX_USER_NUM = 200;
const val String APPLICATION_NAME = "Launcher";

1.6 Non-constant fields (variables)

This section describes the general rules for naming variables.

1.6.1 Non-constant field name

Non-constant field names should use camel case and start with a lowercase letter. A local variable cannot be treated as constant even if it is final and immutable. Therefore, it should not use the preceding rules. Names of collection type variables (sets, lists, etc.) should contain plural nouns. For example: var namesList: List<String>

Names of non-constant variables should use lowerCamelCase. The name of the final immutable field used to store the singleton object can use the same camel case notation.

Invalid example:

customername: String
user: List<String> = listof()

Valid example:

var customerName: String
val users: List<String> = listOf();
val mutableCollection: MutableSet<String> = HashSet()

1.6.2 Boolean variable names with negative meaning

Avoid using Boolean variable names with a negative meaning. When using a logical operator and name with a negative meaning, the code may be difficult to understand, which is referred to as the "double negative". For instance, it is not easy to understand the meaning of !isNotError. The JavaBeans specification automatically generates isXxx() getters for attributes of Boolean classes. However, not all methods returning Boolean type have this notation. For Boolean local variables or methods, it is highly recommended that you add non-meaningful prefixes, including is (commonly used by JavaBeans), has, can, should, and must. Modern integrated development environments (IDEs) such as Intellij are already capable of doing this for you when you generate getters in Java. For Kotlin, this process is even more straightforward as everything is on the byte-code level under the hood.

Invalid example:

val isNoError: Boolean
val isNotFound: Boolean
fun empty()
fun next();

Valid example:

val isError: Boolean
val isFound: Boolean
val hasLicense: Boolean
val canEvaluate: Boolean
val shouldAbort: Boolean
fun isEmpty()
fun hasNext()

2. Comments

The best practice is to begin your code with a summary, which can be one sentence. Try to balance between writing no comments at all and obvious commentary statements for each line of code. Comments should be accurately and clearly expressed, without repeating the name of the class, interface, or method. Comments are not a solution to the wrong code. Instead, you should fix the code as soon as you notice an issue or plan to fix it (by entering a TODO comment, including a Jira number). Comments should accurately reflect the code's design ideas and logic and further describe its business logic. As a result, other programmers will be able to save time when trying to understand the code. Imagine that you are writing the comments to help yourself to understand the original ideas behind the code in the future.

2.1 General form of Kdoc

KDoc is a combination of JavaDoc's block tags syntax (extended to support specific constructions of Kotlin) and Markdown's inline markup. The basic format of KDoc is shown in the following example:

 /**
 * There are multiple lines of KDoc text,
 * Other ...
 */
fun method(arg: String) {
    // ...
}

It is also shown in the following single-line form:

 /** Short form of KDoc. */

Use a single-line form when you store the entire KDoc block in one line (and there is no KDoc mark @XXX). For detailed instructions on how to use KDoc, refer to Official Document.

2.1.1 Using KDoc for the public, protected, or internal code elements

At a minimum, KDoc should be used for every public, protected, or internal decorated class, interface, enumeration, method, and member field (property). Other code blocks can also have KDocs if needed. Instead of using comments or KDocs before properties in the primary constructor of a class - use @property tag in a KDoc of a class. All properties of the primary constructor should also be documented in a KDoc with a @property tag.

Incorrect example:

/**
 * Class description
 */
class Example(
 /**
  * property description
  */
  val foo: Foo,
  // another property description
  val bar: Bar
)

Correct example:

/**
 * Class description
 * @property foo property description
 * @property bar another property description
 */
class Example(
  val foo: Foo,
  val bar: Bar
)

• Don't use Kdoc comments inside code blocks as block comments

Incorrect Example:

class Example {
  fun doGood() {
    /**
     * wrong place for kdoc
     */
    1 + 2
  }
}

Correct Example:

class Example {
  fun doGood() {
    /*
     * right place for block comment
    */
    1 + 2
  }
}

Exceptions:

• For setters/getters of properties, obvious comments (like this getter returns field) are optional. Note that Kotlin generates simple get/set methods under the hood.

• It is optional to add comments for simple one-line methods, such as shown in the example below:

val isEmpty: Boolean
    get() = this.size == 0

or

fun isEmptyList(list: List<String>) = list.size == 0

Note: You can skip KDocs for a method's override if it is almost the same as the superclass method.

2.1.2 Describing methods that have arguments, a return value, or can throw an exception in the KDoc block

When the method has such details as arguments, return value, or can throw exceptions, it must be described in the KDoc block (with @param, @return, @throws, etc.).

Valid examples:

/**
* This is the short overview comment for the example interface.
*     / * Add a blank line between the comment text and each KDoc tag underneath * /
* @since 1.6
*/
protected abstract class Sample {
   /**
    * This is a long comment with whitespace that should be split in
    * comments on multiple lines if the line comment formatting is enabled.
    *     / * Add a blank line between the comment text and each KDoc tag underneath * /
    * @param fox A quick brown fox jumps over the lazy dog
    * @return battle between fox and dog
    */
   protected abstract fun foo(Fox fox)
    /**
     * These possibilities include: Formatting of header comments
     *     / * Add a blank line between the comment text and each KDoc tag underneath * /
     * @return battle between fox and dog
     * @throws ProblemException if lazy dog wins
     */
   protected fun bar() throws ProblemException {
       // Some comments / * No need to add a blank line here * /
       var aVar = ...

       // Some comments  / * Add a blank line before the comment * /
       fun doSome()
   }
}

2.1.3 Only one space between the Kdoc tag and content. Tags are arranged in the order.

There should be only one space between the Kdoc tag and content. Tags are arranged in the following order: @param, @return, and @throws.

Therefore, Kdoc should contain the following:

• Functional and technical description, explaining the principles, intentions, contracts, API, etc.
• The function description and @tags (implSpec, apiNote, and implNote) require an empty line after them.
• @implSpec: A specification related to API implementation, and it should let the implementer decide whether to override it.
• @apiNote: Explain the API precautions, including whether to allow null and whether the method is thread-safe, as well as the algorithm complexity, input, and output range, exceptions, etc.
• @implNote: A note related to API implementation, which implementers should keep in mind.
• One empty line, followed by regular @param, @return, @throws, and other comments.
• The conventional standard "block labels" are arranged in the following order: @param, @return, @throws. Kdoc should not contain:
• Empty descriptions in tag blocks. It is better not to write Kdoc than waste code line space.
• There should be no empty lines between the method/class declaration and the end of Kdoc (*/ symbols).
• @author tag. It doesn't matter who originally created a class when you can use git blame or VCS of your choice to look through the changes history. Important notes:
• KDoc does not support the @deprecated tag. Instead, use the @Deprecated annotation.
• The @since tag should be used for versions only. Do not use dates in @since tag, it's confusing and less accurate.

If a tag block cannot be described in one line, indent the content of the new line by four spaces from the @ position to achieve alignment (@ counts as one + three spaces).

Exception:

When the descriptive text in a tag block is too long to wrap, you can indent the alignment with the descriptive text in the last line. The descriptive text of multiple tags does not need to be aligned. See 3.8 Horizontal space.

In Kotlin, compared to Java, you can put several classes inside one file, so each class should have a Kdoc formatted comment (as stated in rule 2.1). This comment should contain @since tag. The right style is to write the application version when its functionality is released. It should be entered after the @since tag.

Examples:

/**
 * Description of functionality
 *
 * @since 1.6
 */

Other KDoc tags (such as @param type parameters and @see.) can be added as follows:

/**
 * Description of functionality
 *
 * @apiNote: Important information about API
 *
 * @since 1.6
 */

2.2 Adding comments on the file header

This section describes the general rules of adding comments on the file header.

2.2.1 Formatting of comments in the file header

Comments on the file header should be placed before the package name and imports. If you need to add more content to the comment, subsequently add it in the same format.

Comments on the file header must include copyright information, without the creation date and author's name (use VCS for history management). Also, describe the content inside files that contain multiple or no classes.

The following examples for Huawei describe the format of the copyright license:
Chinese version: 版权所有 (c) 华为技术有限公司 2012-2020
English version: Copyright (c) Huawei Technologies Co., Ltd. 2012-2020. All rights reserved. 2012 and 2020 are the years the file was first created and the current year, respectively.

Do not place release notes in header, use VCS to keep track of changes in file. Notable changes can be marked in individual KDocs using @since tag with version.

Invalid example:

/**
 * Release notes:
 * 2019-10-11: added class Foo
 */

class Foo

Valid example:

/**
 * @since 2.4.0
 */
class Foo

• The copyright statement can use your company's subsidiaries, as shown in the below examples:
  Chinese version: 版权所有 (c) 海思半导体 2012-2020
  English version: Copyright (c) Hisilicon Technologies Co., Ltd. 2012-2020. All rights reserved.

• The copyright information should not be written in KDoc style or use single-line comments. It must start from the beginning of the file. The following example is a copyright statement for Huawei, without other functional comments:

/*
 * Copyright (c) Huawei Technologies Co., Ltd. 2012-2020. All rights reserved.
 */

The following factors should be considered when writing the file header or comments for top-level classes:

• File header comments must start from the top of the file. If it is a top-level file comment, there should be a blank line after the last Kdoc */ symbol. If it is a comment for a top-level class, the class declaration should start immediately without using a newline.
• Maintain a unified format. The specific format can be formulated by the project (for example, if you use an existing opensource project), and you need to follow it.
• A top-level file-Kdoc must include a copyright and functional description, especially if there is more than one top-level class.
• Do not include empty comment blocks. If there is no content after the option @apiNote, the entire tag block should be deleted.
• The industry practice is not to include historical information in the comments. The corresponding history can be found in VCS (git, svn, etc.). Therefore, it is not recommended to include historical data in the comments of the Kotlin source code.

2.3 Comments on the function header

Comments on the function header are placed above function declarations or definitions. A newline should not exist between a function declaration and its Kdoc. Use the preceding <<c2.1,KDoc>> style rules.

As stated in Chapter 1, the function name should reflect its functionality as much as possible. Therefore, in the Kdoc, try to describe the functionality that is not mentioned in the function name. Avoid unnecessary comments on dummy coding.

The function header comment's content is optional, but not limited to function description, return value, performance constraints, usage, memory conventions, algorithm implementation, reentrant requirements, etc.

2.4 Code comments

This section describes the general rules of adding code comments.

2.4.1 Add a blank line between the body of the comment and Kdoc tag-blocks.

It is a good practice to add a blank line between the body of the comment and Kdoc tag-blocks. Also, consider the following rules:

• There must be one space between the comment character and the content of the comment.
• There must be a newline between a Kdoc and the presiding code.
• An empty line should not exist between a Kdoc and the code it is describing. You do not need to add a blank line before the first comment in a particular namespace (code block) (for example, between the function declaration and first comment in a function body).

Valid Examples:

/**
 * This is the short overview comment for the example interface.
 *
 * @since 1.6
 */
 public interface Example {
    // Some comments  /* Since it is the first member definition in this code block, there is no need to add a blank line here */
    val aField: String = ...
                     /* Add a blank line above the comment */
    // Some comments
    val bField: String = ...
                      /* Add a blank line above the comment */
    /**
     * This is a long comment with whitespace that should be split in
     * multiple line comments in case the line comment formatting is enabled.
     *                /* blank line between description and Kdoc tag */
     * @param fox A quick brown fox jumps over the lazy dog
     * @return the rounds of battle of fox and dog
     */
    fun foo(Fox fox)
                      /* Add a blank line above the comment */
     /**
      * These possibilities include: Formatting of header comments
      *
      * @return the rounds of battle of fox and dog
      * @throws ProblemException if lazy dog wins
      */
    fun bar() throws ProblemException {
        // Some comments  /* Since it is the first member definition in this range, there is no need to add a blank line here */
        var aVar = ...

        // Some comments  /* Add a blank line above the comment */
        fun doSome()
    }
 }

• Leave one single space between the comment on the right side of the code and the code. If you use conditional comments in the if-else-if scenario, put the comments inside the else-if branch or in the conditional block, but not before the else-if. This makes the code more understandable. When the if-block is used with curly braces, the comment should be placed on the next line after opening the curly braces. Compared to Java, the if statement in Kotlin statements returns a value. For this reason, a comment block can describe a whole if-statement.

Valid examples:

val foo = 100  // right-side comment
val bar = 200  /* right-side comment */

// general comment for the value and whole if-else condition
val someVal = if (nr % 15 == 0) {
    // when nr is a multiple of both 3 and 5
    println("fizzbuzz")
} else if (nr % 3 == 0) {
    // when nr is a multiple of 3, but not 5
    // We print "fizz", only.
    println("fizz")
} else if (nr % 5 == 0) {
    // when nr is a multiple of 5, but not 3
    // we print "buzz" only.
    println("buzz")
} else {
    // otherwise, we print the number.
    println(x)
}

• Start all comments (including KDoc) with a space after the first symbol (//, /*, /** and *)

Valid example:

val x = 0  // this is a comment

2.4.2 Do not comment on unused code blocks

Do not comment on unused code blocks, including imports. Delete these code blocks immediately. A code is not used to store history. Git, svn, or other VCS tools should be used for this purpose. Unused imports increase the coupling of the code and are not conducive to maintenance. The commented out code cannot be appropriately maintained. In an attempt to reuse the code, there is a high probability that you will introduce defects that are easily missed. The correct approach is to delete the unnecessary code directly and immediately when it is not used anymore. If you need the code again, consider porting or rewriting it as changes could have occurred since you first commented on the code.

2.4.3 Code delivered to the client should not contain TODO/FIXME comments

The code officially delivered to the client typically should not contain TODO/FIXME comments. TODO comments are typically used to describe modification points that need to be improved and added. For example, refactoring FIXME comments are typically used to describe known defects and bugs that will be subsequently fixed and are not critical for an application. They should all have a unified style to facilitate unified text search processing.

Example:

// TODO(<author-name>): Jira-XXX - support new json format
// FIXME: Jira-XXX - fix NPE in this code block

At a version development stage, these annotations can be used to highlight the issues in the code, but all of them should be fixed before a new product version is released.

3. General formatting (typesetting)

3.1 File-related rules

This section describes the rules related to using files in your code.

3.1.1 Avoid files that are too long

If the file is too long and complicated, it should be split into smaller files, functions, or modules. Files should not exceed 2000 lines (non-empty and non-commented lines). It is recommended to horizontally or vertically split the file according to responsibilities or hierarchy of its parts. The only exception to this rule is code generation - the auto-generated files that are not manually modified can be longer.

3.1.2 Code blocks in the source file should be separated by one blank line

A source file contains code blocks in the following order: copyright, package name, imports, and top-level classes. They should be separated by one blank line.

a) Code blocks should be in the following order:

1. Kdoc for licensed or copyrighted files
2. @file annotation
3. Package name
4. Import statements
5. Top-class header and top-function header comments
6. Top-level classes or functions

b) Each of the preceding code blocks should be separated by a blank line.

c) Import statements are alphabetically arranged, without using line breaks and wildcards ( wildcard imports - *).

d) Recommendation: One .kt source file should contain only one class declaration, and its name should match the filename

e) Avoid empty files that do not contain the code or contain only imports/comments/package name

f) Unused imports should be removed

3.1.3 Import statements order

From top to bottom, the order is the following:

1. Android
2. Imports of packages used internally in your organization
3. Imports from other non-core dependencies
4. Java core packages
5. kotlin stdlib

Each category should be alphabetically arranged. Each group should be separated by a blank line. This style is compatible with Android import order.

Valid example:

import android.* // android
import androidx.* // android
import com.android.* // android

import com.your.company.* // your company's libs
import your.company.* // your company's libs

import com.fasterxml.jackson.databind.ObjectMapper // other third-party dependencies
import org.junit.jupiter.api.Assertions

import java.io.IOException // java core packages
import java.net.URL

import kotlin.system.exitProcess  // kotlin standard library
import kotlinx.coroutines.*  // official kotlin extension library

3.1.4 Order of declaration parts of class-like code structures

The declaration parts of class-like code structures (class, interface, etc.) should be in the following order: compile-time constants (for objects), class properties, late-init class properties, init-blocks, constructors, public methods, internal methods, protected methods, private methods, and companion object. Blank lines should separate their declaration. Notes:

1. There should be no blank lines between properties with the following exceptions: when there is a comment before a property on a separate line or annotations on a separate line.
2. Properties with comments/Kdoc should be separated by a newline before the comment/Kdoc.
3. Enum entries and constant properties (const val) in companion objects should be alphabetically arranged.

The declaration part of a class or interface should be in the following order:

• Compile-time constants (for objects)
• Properties
• Late-init class properties
• Init-blocks
• Constructors
• Methods or nested classes. Put nested classes next to the code they are used by. If the classes are meant to be used externally, and are not referenced inside the class, put them after the companion object.
• Companion object

Exception: All variants of a private val logger should be placed at the beginning of the class (private val log, LOG, logger, etc.).

3.1.5 Order of declaration of top-level code structures

Kotlin allows several top-level declaration types: classes, objects, interfaces, properties and functions. When declaring more than one class or zero classes (e.g. only functions), as per rule 2.2.1, you should document the whole file in the header KDoc. When declaring top-level structures, keep the following order:

1. Top-level constants and properties (following same order as properties inside a class: const val,val, lateinit var, var)
2. typealiases (grouped by their visibility modifiers)
3. Interfaces, classes and objects (grouped by their visibility modifiers)
4. Extension functions
5. Other functions

Note: Extension functions shouldn't have receivers declared in the same file according to rule 6.2.3

Valid example:

package com.saveourtool.diktat.example

const val CONSTANT = 42

val topLevelProperty = "String constant"

internal typealias ExamplesHandler = (IExample) -> Unit

interface IExample

class Example : IExample

private class Internal

fun Other.asExample(): Example { /* ... */ }

private fun Other.asInternal(): Internal { /* ... */ }

fun doStuff() { /* ... */ }

Note: kotlin scripts (.kts) allow arbitrary code to be placed on the top level. When writing kotlin scripts, you should first declare all properties, classes and functions. Only then you should execute functions on top level. It is still recommended wrapping logic inside functions and avoid using top-level statements for function calls or wrapping blocks of code in top-level scope functions like run.

Example:

/* class declarations */
/* function declarations */
run {
    // call functions here
}

3.2 Braces

This section describes the general rules of using braces in your code.

3.2.1 Using braces in conditional statements and loop blocks

Braces should always be used in if, else, for, do, and while statements, even if the program body is empty or contains only one statement. In special Kotlin when statements, you do not need to use braces for single-line statements.

Valid example:

when (node.elementType) {
    FILE -> {
        checkTopLevelDoc(node)
        checkSomething()
     }
    CLASS -> checkClassElements(node)
}

Exception: The only exception is ternary operator in Kotlin (a single line if () <> else <> )

Invalid example:

val value = if (string.isEmpty())  // WRONG!
                0
            else
                1

Valid example:

val value = if (string.isEmpty()) 0 else 1  // Okay

if (condition) {
    println("test")
} else {
    println(0)
}

3.2.2 Opening braces are placed at the end of the line in non-empty blocks and block structures

For non-empty blocks and block structures, the opening brace is placed at the end of the line. Follow the K&R style (1TBS or OTBS) for non-empty code blocks with braces:

• The opening brace and first line of the code block are on the same line.
• The closing brace is on its own new line.
• The closing brace can be followed by a newline character. The only exceptions are else, finally, and while (from do-while statement), or catch keywords. These keywords should not be split from the closing brace by a newline character.

Exception cases:

1. For lambdas, there is no need to put a newline character after the first (function-related) opening brace. A newline character should appear only after an arrow (->) (see point 5 of Rule 3.6.2).

arg.map { value ->
    foo(value)
}

2. for else/catch/finally/while (from do-while statement) keywords closing brace should stay on the same line:

do {
   if (true) {
       x++
   } else {
       x--
   }
} while (x > 0)

Valid example:

       return arg.map { value ->
           while (condition()) {
               method()
           }
           value
       }

       return MyClass() {
           @Override
             fun method() {
               if (condition()) {
                   try {
                       something()
                   } catch (e: ProblemException) {
                       recover()
                   }
               } else if (otherCondition()) {
                   somethingElse()
               } else {
                   lastThing()
               }
           }
       }

3.3 Indentation

Only spaces are permitted for indentation, and each indentation should equal four spaces (tabs are not permitted). If you prefer using tabs, simply configure them to change to spaces in your IDE automatically. These code blocks should be indented if they are placed on the new line, and the following conditions are met:

• The code block is placed immediately after an opening brace.
• The code block is placed after each operator, including the assignment operator (+/-/&&/=/etc.)
• The code block is a call chain of methods:

someObject
    .map()
    .filter()

• The code block is placed immediately after the opening parenthesis.
• The code block is placed immediately after an arrow in lambda:

arg.map { value ->
   foo(value)
}

Exceptions:

1. Argument lists:
   a) Eight spaces are used to indent argument lists (both in declarations and at call sites).
   b) Arguments in argument lists can be aligned if they are on different lines.

2. Eight spaces are used if there is a newline after any binary operator.

3. Eight spaces are used for functional-like styles when the newline is placed before the dot.

4. Supertype lists:
   a) Four spaces are used if the colon before the supertype list is on a new line.
   b) Four spaces are used before each supertype, and eight spaces are used if the colon is on a new line.

Note: there should be an indentation after all statements such as if, for, etc. However, according to this code style, such statements require braces.

if (condition)
    foo()

Exceptions:

• When breaking the parameter list of a method/class constructor, it can be aligned with 8 spaces. A parameter that was moved to a new line can be on the same level as the previous argument:

fun visit(
        node: ASTNode,
        autoCorrect: Boolean,
        params: KtLint.ExperimentalParams,
        emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit
) {
}

• Such operators as +/-/* can be indented with 8 spaces:

val abcdef = "my splitted" +
                " string"

• Opening and closing quotes in multiline string should have same indentation

lintMethod(
            """
                    |val q = 1
                    |
            """.trimMargin()
    )

• A list of supertypes should be indented with 4 spaces if they are on different lines or with 8 spaces if the leading colon is also on a separate line

class A :
    B()

class A
    :
        B()

3.4 Empty blocks

Avoid empty blocks, and ensure braces start on a new line. An empty code block can be closed immediately on the same line and the next line. However, a newline is recommended between opening and closing braces {} (see the examples below.)

Generally, empty code blocks are prohibited; using them is considered a bad practice (especially for catch block). They are appropriate for overridden functions, when the base class's functionality is not needed in the class-inheritor, for lambdas used as a function and for empty function in implementation of functional interface.

override fun foo() {
}

Valid examples (note once again that generally empty blocks are prohibited):

fun doNothing() {}

fun doNothingElse() {
}

fun foo(bar: () -> Unit = {})

Invalid examples:

try {
  doSomething()
} catch (e: Some) {}

Use the following valid code instead:

try {
   doSomething()
} catch (e: Some) {
}

3.5 Line length

Line length should be less than 120 symbols. Otherwise, it should be split.

If complex property initializing is too long, It should be split into priorities: \

1. Logic Binary Expression (&& ||) \
2. Comparison Binary Expression (> < == >= <= !=) \
3. Other types (Arithmetical and Bit operation) (+ - * / % >> << *= += -= /= %= ++ -- ! in !in etc)

Invalid example:

val complexProperty = 1 + 2 + 3 + 4

Valid example:

val complexProperty = 1 + 2 +
    3 + 4

Invalid example:

val complexProperty = (1 + 2 + 3 > 0) && ( 23 * 4 > 10 * 6)

Valid example:

val complexProperty = (1 + 2 + 3 > 0) &&
    (23 * 4 > 10 * 6)

If long line should be split in Elvis Operator (?:), it`s done like this

Invalid example:

val value = first ?: second

Valid example:

val value = first
    ?: second

If long line in Dot Qualified Expression or Safe Access Expression, it`s done like this:

Invalid example:

val value = This.Is.Very.Long.Dot.Qualified.Expression

Valid example:

val value = This.Is.Very.Long
    .Dot.Qualified.Expression

Invalid example:

val value = This.Is?.Very?.Long?.Safe?.Access?.Expression

Valid example:

val value = This.Is?.Very?.Long
    ?.Safe?.Access?.Expression

if value arguments list is too long, it also should be split:

Invalid example:

val result1 = ManyParamInFunction(firstArgument, secondArgument, thirdArgument, fourthArgument, fifthArguments)

Valid example:

val result1 = ManyParamInFunction(firstArgument,
 secondArgument, thirdArgument, fourthArgument,
 fifthArguments)

If annotation is too long, it also should be split:

Invalid example:

@Query(value = "select * from table where age = 10", nativeQuery = true)
fun foo() {}

Valid example:

@Query(
    value = "select * from table where age = 10",
    nativeQuery = true)
fun foo() {}

Long one line function should be split:

Invalid example:

fun foo() = goo().write("TooLong")

Valid example:

fun foo() =
    goo().write("TooLong")

Long binary expression should be split into priorities: \

1. Logic Binary Expression (&& ||) \
2. Comparison Binary Expression (> < == >= <= !=) \
3. Other types (Arithmetical and Bit operation) (+ - * / % >> << /*= += -= /= %= ++ -- ! in !in etc)

Invalid example:

if (( x >  100) || y < 100 && !isFoo()) {}

Valid example:

if (( x >  100) ||
    y < 100 && !isFoo()) {}

String template also can be split in white space in string text

Invalid example:

val nameString = "This is very long string template"

Valid example:

val nameString = "This is very long" +
        " string template"

Long Lambda argument should be split:

Invalid example:

val variable = a?.filter { it.elementType == true } ?: null

Valid example:

val variable = a?.filter {
    it.elementType == true
} ?: null

Long one line When Entry should be split:

Invalid example:

when(elem) {
    true -> long.argument.whenEntry
}

Valid example:

when(elem) {
    true -> {
        long.argument.whenEntry
    }
}

If the examples above do not fit, but the line needs to be split and this in property, this is fixed like thisЖ

Invalid example:

val element = veryLongNameFunction(firstParam)

Valid example:

val element =
    varyLongNameFunction(firstParam)

Eol comment also can be split, but it depends on comment location. If this comment is on the same line with code it should be on line before:

Invalid example:

fun foo() {
    val name = "Nick" // this comment is too long
}

Valid example:

fun foo() {
    // this comment is too long
    val name = "Nick"
}

But if this comment is on new line - it should be split to several lines:

Invalid example:

// This comment is too long. It should be on two lines.
fun foo() {}

Valid example:

// This comment is too long.
// It should be on two lines.
fun foo() {}

The international code style prohibits non-Latin (non-ASCII) symbols. (See Identifiers) However, if you still intend on using them, follow the following convention:

• One wide character occupies the width of two narrow characters. The "wide" and "narrow" parts of a character are defined by its east Asian width Unicode attribute. Typically, narrow characters are also called "half-width" characters. All characters in the ASCII character set include letters (such as a, A), numbers (such as 0, 3), and punctuation spaces (such as , , {), all of which are narrow characters. Wide characters are also called "full-width" characters. Chinese characters (such as 中, 文), Chinese punctuation (， , ； ), full-width letters and numbers (such as Ａ、３) are "full-width" characters. Each one of these characters represents two narrow characters.

• Any line that exceeds this limit (120 narrow symbols) should be wrapped, as described in the Newline section.

Exceptions:

1. The long URL or long JSON method reference in KDoc.
2. The package and import statements.
3. The command line in the comment, enabling it to be cut and pasted into the shell for use.

3.6 Line breaks (newlines)

This section contains the rules and recommendations on using line breaks.

3.6.1 Each line can have a maximum of one statement

Each line can have a maximum of one code statement. This recommendation prohibits the use of code with ; because it decreases code visibility.

Invalid example:

val a = ""; val b = ""

Valid example:

val a = ""
val b = ""

3.6.2 Rules for line-breaking

1. Unlike Java, Kotlin allows you not to put a semicolon (;) after each statement separated by a newline character. There should be no redundant semicolon at the end of the lines.

When a newline character is needed to split the line, it should be placed after such operators as &&/||/+/etc. and all infix functions (for example, xor). However, the newline character should be placed before operators such as ., ?., ?:, and ::.

Note that all comparison operators, such as ==, >, <, should not be split.

Invalid example:

     if (node !=
             null && test != null) {}

Valid example:

         if (node != null &&
                 test != null) {
         }

Note: You need to follow the functional style, meaning each function call in a chain with . should start at a new line if the chain of functions contains more than one call:

  val value = otherValue!!
          .map { x -> x }
          .filter {
              val a = true
              true
          }
          .size

Note: The parser prohibits the separation of the !! operator from the value it is checking.

Exception: If a functional chain is used inside the branches of a ternary operator, it does not need to be split with newlines.

Valid example:

if (condition) list.map { foo(it) }.filter { bar(it) } else list.drop(1)

Note: If dot qualified expression is inside condition or passed as an argument - it should be replaced with new variable.

Invalid example:

 if (node.treeParent.treeParent?.treeParent.findChildByType(IDENTIFIER) != null) {}

Valid example:

        val grandIdentifier = node
            .treeParent
            .treeParent
            ?.treeParent
            .findChildByType(IDENTIFIER)
        if (grandIdentifier != null) {}

Second valid example:

        val grandIdentifier = node.treeParent
            .treeParent
            ?.treeParent
            .findChildByType(IDENTIFIER)
        if (grandIdentifier != null) {}

2. Newlines should be placed after the assignment operator (=).
3. In function or class declarations, the name of a function or constructor should not be split by a newline from the opening brace (. A brace should be placed immediately after the name without any spaces in declarations or at call sites.
4. Newlines should be placed right after the comma (,).
5. If a lambda statement contains more than one line in its body, a newline should be placed after an arrow if the lambda statement has explicit parameters. If it uses an implicit parameter (it), the newline character should be placed after the opening brace ({). The following examples illustrate this rule:

Invalid example:

    value.map { name -> foo()
        bar()
    }

Valid example:

value.map { name ->
    foo()
    bar()
}

val someValue = { node:String -> node }

6. When the function contains only a single expression, it can be written as expression function. The below example shows the style that should not be used.

Instead of:

override fun toString(): String { return "hi" }

use:

override fun toString() = "hi"

7. If an argument list in a function declaration (including constructors) or function call contains more than two arguments, these arguments should be split by newlines in the following style.

Valid example:

class Foo(val a: String,
         b: String,
         val c: String) {
}

fun foo(
       a: String,
       b: String,
       c: String
) {

}

If and only if the first parameter is on the same line as an opening parenthesis, all parameters can be horizontally aligned by the first parameter. Otherwise, there should be a line break after an opening parenthesis.

Kotlin 1.4 introduced a trailing comma as an optional feature, so it is generally recommended to place all parameters on a separate line and append trailing comma. It makes the resolving of merge conflicts easier.

Valid example:

fun foo(
       a: String,
       b: String,
) {

}

same should be done for function calls/constructor arguments/e.t.c

Kotlin supports trailing commas in the following cases:

Enumerations Value arguments Class properties and parameters Function value parameters Parameters with optional type (including setters) Indexing suffix Lambda parameters when entry Collection literals (in annotations) Type arguments Type parameters Destructuring declarations

8. If the supertype list has more than two elements, they should be separated by newlines.

Valid example:

class MyFavouriteVeryLongClassHolder :
    MyLongHolder<MyFavouriteVeryLongClass>(),
    SomeOtherInterface,
    AndAnotherOne { }

3.7 Using blank lines

Reduce unnecessary blank lines and maintain a compact code size. By reducing unnecessary blank lines, you can display more code on one screen, which improves code readability.

• Blank lines should separate content based on relevance and should be placed between groups of fields, constructors, methods, nested classes, init blocks, and objects (see 3.1.2).
• Do not use more than one line inside methods, type definitions, and initialization expressions.
• Generally, do not use more than two consecutive blank lines in a row.
• Do not put newlines in the beginning or end of code blocks with curly braces.

Valid example:

fun baz() {

    doSomething()  // No need to add blank lines at the beginning and end of the code block
    // ...

}

3.8 Horizontal space

This section describes general rules and recommendations for using spaces in the code.

3.8.1: Usage of whitespace for code separation

Follow the recommendations below for using space to separate keywords:

Note: These recommendations are for cases where symbols are located on the same line. However, in some cases, a line break could be used instead of a space.

1. Separate keywords (such as if, when, for) from the opening parenthesis with single whitespace. The only exception is the constructor keyword, which should not be separated from the opening parenthesis.

2. Separate keywords like else or try from the opening brace ({) with single whitespace. If else is used in a ternary-style statement without braces, there should be a single space between else and the statement after: if (condition) foo() else bar()

3. Use a single whitespace before all opening braces ({). The only exception is the passing of a lambda as a parameter inside parentheses:

    private fun foo(a: (Int) -> Int, b: Int) {}
    foo({x: Int -> x}, 5) // no space before '{'

4. Single whitespace should be placed on both sides of binary operators. This also applies to operator-like symbols. For example:

• A colon in generic structures with the where keyword: where T : Type
• Arrow in lambdas: (str: String) -> str.length()

Exceptions:

• Two colons (::) are written without spaces:
  Object::toString
• The dot separator (.) that stays on the same line with an object name:
  object.toString()
• Safe access modifiers ?. and !! that stay on the same line with an object name:
  object?.toString()
• Operator .. for creating ranges:
  1..100

5. Use spaces after (,), (:), and (;), except when the symbol is at the end of the line. However, note that this code style prohibits the use of (;) in the middle of a line (see 3.3.2). There should be no whitespaces at the end of a line. The only scenario where there should be no space after a colon is when the colon is used in the annotation to specify a use-site target (for example, @param:JsonProperty). There should be no spaces before , , : and ;.

   Exceptions for spaces and colons:

   • When : is used to separate a type and a supertype, including an anonymous object (after object keyword)
   • When delegating to a superclass constructor or different constructor of the same class

Valid example:

  abstract class Foo<out T : Any> : IFoo { }

  class FooImpl : Foo() {
      constructor(x: String) : this(x) { /*...*/ }

      val x = object : IFoo { /*...*/ }
  }

6. There should be only one space between the identifier and its type: list: List<String> If the type is nullable, there should be no space before ?.

7. When using [] operator (get/set) there should be no spaces between identifier and [ : someList[0].

8. There should be no space between a method or constructor name (both at declaration and at call site) and a parenthesis: foo() {}. Note that this sub-rule is related only to spaces; the rules for whitespaces are described in see 3.6.2. This rule does not prohibit, for example, the following code:

fun foo
(
    a: String
)

9. Never put a space after (, [, < (when used as a bracket in templates) or before ), ], > (when used as a bracket in templates).

10. There should be no spaces between a prefix/postfix operator (like !! or ++) and its operand.

3.8.2: No spaces for horizontal alignment

Horizontal alignment refers to aligning code blocks by adding space to the code. Horizontal alignment should not be used because:

• When modifying code, it takes much time for new developers to format, support, and fix alignment issues.
• Long identifier names will break the alignment and lead to less presentable code.
• There are more disadvantages than advantages in alignment. To reduce maintenance costs, misalignment (???) is the best choice.

Recommendation: Alignment only looks suitable for enum class, where it can be used in table format to improve code readability:

enum class Warnings(private val id: Int, private val canBeAutoCorrected: Boolean, private val warn: String) : Rule {
    PACKAGE_NAME_MISSING         (1, true,  "no package name declared in a file"),
    PACKAGE_NAME_INCORRECT_CASE  (2, true,  "package name should be completely in a lower case"),
    PACKAGE_NAME_INCORRECT_PREFIX(3, false, "package name should start from the company's domain")
    ;
}

Valid example:

private val nr: Int // no alignment, but looks fine
private var color: Color // no alignment

Invalid example:

private val    nr: Int    // aligned comment with extra spaces
private val color: Color  // alignment for a comment and alignment for identifier name

3.9 Enumerations

Enum values are separated by a comma and line break, with ';' placed on the new line.

1. The comma and line break characters separate enum values. Put ; on the new line:

enum class Warnings {
    A,
    B,
    C,
    ;
}

This will help to resolve conflicts and reduce the number of conflicts during merging pull requests. Also, use trailing comma.

2. If the enum is simple (no properties, methods, and comments inside), you can declare it in a single line:

enum class Suit { CLUBS, HEARTS, SPADES, DIAMONDS }

3. Enum classes take preference (if it is possible to use it). For example, instead of two boolean properties:

val isCelsius = true
val isFahrenheit = false

use enum class:

enum class TemperatureScale { CELSIUS, FAHRENHEIT }

• The variable value only changes within a fixed range and is defined with the enum type.
• Avoid comparison with magic numbers of -1, 0, and 1; use enums instead.

enum class ComparisonResult {
    ORDERED_ASCENDING,
    ORDERED_SAME,
    ORDERED_DESCENDING,
    ;
}

3.10 Variable declaration

This section describes rules for the declaration of variables.

3.10.1 Declare one variable per line

Each property or variable must be declared on a separate line.

Invalid example:

val n1: Int; val n2: Int

3.10.2 Variables should be declared near the line where they are first used

Declare local variables close to the point where they are first used to minimize their scope. This will also increase the readability of the code. Local variables are usually initialized during their declaration or immediately after. The member fields of the class should be declared collectively (see Rule 3.1.2 for details on the class structure).

3.11 'When' expression

The when statement must have an 'else' branch unless the condition variable is enumerated or a sealed type. Each when statement should contain an else statement group, even if it does not contain any code.

Exception: If 'when' statement of the enum or sealed type contains all enum values, there is no need to have an "else" branch. The compiler can issue a warning when it is missing.

3.12 Annotations

Each annotation applied to a class, method or constructor should be placed on its own line. Consider the following examples:

1. Annotations applied to the class, method or constructor are placed on separate lines (one annotation per line).

Valid example:

@MustBeDocumented
@CustomAnnotation
fun getNameIfPresent() { /* ... */ }

2. A single annotation should be on the same line as the code it is annotating.

Valid example:

@CustomAnnotation class Foo {}

3. Multiple annotations applied to a field or property can appear on the same line as the corresponding field.

Valid example:

@MustBeDocumented @CustomAnnotation val loader: DataLoader

3.13 Block comments

Block comments should be placed at the same indentation level as the surrounding code. See examples below.

Valid example:

class SomeClass {
    /*
     * This is
     * okay
     */
     fun foo() {}
}

Note: Use /*...*/ block comments to enable automatic formatting by IDEs.

3.14 Modifiers and constant values

This section contains recommendations regarding modifiers and constant values.

3.14.1 Declaration with multiple modifiers

If a declaration has multiple modifiers, always follow the proper sequence. Valid sequence:

public / internal / protected / private
expect / actual
final / open / abstract / sealed / const
external
override
lateinit
tailrec
crossinline
vararg
suspend
inner
out
enum / annotation
companion
inline / noinline
reified
infix
operator
data

3.14.2: Separate long numerical values with an underscore

An underscore character should separate long numerical values. Note: Using underscores simplifies reading and helps to find errors in numeric constants.

val oneMillion = 1_000_000
val creditCardNumber = 1234_5678_9012_3456L
val socialSecurityNumber = 999_99_9999L
val hexBytes = 0xFF_EC_DE_5E
val bytes = 0b11010010_01101001_10010100_10010010

3.14.3: Magic number

Prefer defining constants with clear names describing what the magic number means. Valid example:

class Person() {
    fun isAdult(age: Int): Boolean = age >= majority

    companion object {
        private const val majority = 18
    }
}

Invalid example:

class Person() {
    fun isAdult(age: Int): Boolean = age >= 18
}

3.15 Strings

This section describes the general rules of using strings.

3.15.1 Concatenation of Strings

String concatenation is prohibited if the string can fit on one line. Use raw strings and string templates instead. Kotlin has significantly improved the use of Strings: String templates, Raw strings. Therefore, compared to using explicit concatenation, code looks much better when proper Kotlin strings are used for short lines, and you do not need to split them with newline characters.

Invalid example:

val myStr = "Super string"
val value = myStr + " concatenated"

Valid example:

val myStr = "Super string"
val value = "$myStr concatenated"

3.15.2 String template format

Redundant curly braces in string templates

If there is only one variable in a string template, there is no need to use such a template. Use this variable directly. Invalid example:

val someString = "${myArgument} ${myArgument.foo()}"

Valid example:

val someString = "$myArgument ${myArgument.foo()}"

Redundant string template

In case a string template contains only one variable - there is no need to use the string template. Use this variable directly.

Invalid example:

val someString = "$myArgument"

Valid example:

val someString = myArgument

3.16 Conditional Statements

This section describes the general rules related to the сonditional statements.

3.16.1 Collapsing redundant nested if-statements

The nested if-statements, when possible, should be collapsed into a single one by concatenating their conditions with the infix operator &&.

This improves the readability by reducing the number of the nested language constructs.

Simple collapse

Invalid example:

if (cond1) {
    if (cond2) {
        doSomething()
    }
}

Valid example:

if (cond1 && cond2) {
    doSomething()
}

Compound conditions

Invalid example:

if (cond1) {
    if (cond2 || cond3) {
        doSomething()
    }
}

Valid example:

if (cond1 && (cond2 || cond3)) {
    doSomething()
}

3.16.2 Too complex conditions

Too complex conditions should be simplified according to boolean algebra rules, if it is possible. The following rules are considered when simplifying an expression:

• boolean literals are removed (e.g. foo() || false -> foo())
• double negation is removed (e.g. !(!a) -> a)
• expression with the same variable are simplified (e.g. a && b && a -> a && b)
• remove expression from disjunction, if they are subset of other expression (e.g. a || (a && b) -> a)
• remove expression from conjunction, if they are more broad than other expression (e.g. a && (a || b) -> a)
• de Morgan's rule (negation is moved inside parentheses, i.e. !(a || b) -> !a && !b)

Valid example

if (condition1 && condition2) {
    foo()
}

Invalid example

if (condition1 && condition2 && condition1) {
    foo()
}

4. Variables and types

This section is dedicated to the rules and recommendations for using variables and types in your code.

4.1 Variables

The rules of using variables are explained in the below topics.

4.1.1 Do not use Float and Double types when accurate calculations are needed

Floating-point numbers provide a good approximation over a wide range of values, but they cannot produce accurate results in some cases. Binary floating-point numbers are unsuitable for precise calculations because it is impossible to represent 0.1 or any other negative power of 10 in a binary representation with a finite length.

The following code example seems to be obvious:

    val myValue = 2.0 - 1.1
    println(myValue)

However, it will print the following value: 0.8999999999999999

Therefore, for precise calculations (for example, in finance or exact sciences), using such types as Int, Long, BigDecimalare recommended. The BigDecimal type should serve as a good choice.

Invalid example: Float values containing more than six or seven decimal numbers will be rounded.

val eFloat = 2.7182818284f // Float, will be rounded to 2.7182817

Valid example: (when precise calculations are needed):

   val income = BigDecimal("2.0")
   val expense = BigDecimal("1.1")
   println(income.subtract(expense)) // you will obtain 0.9 here

4.1.2: Comparing numeric float type values

Numeric float type values should not be directly compared with the equality operator (==) or other methods, such as compareTo() and equals(). Since floating-point numbers involve precision problems in computer representation, it is better to use BigDecimal as recommended in Rule 4.1.1 to make accurate computations and comparisons. The following code describes these problems.

Invalid example:

val f1 = 1.0f - 0.9f
val f2 = 0.9f - 0.8f
if (f1 == f2) {
   println("Expected to enter here")
} else {
   println("But this block will be reached")
}

val flt1 = f1;
val flt2 = f2;
if (flt1.equals(flt2)) {
   println("Expected to enter here")
} else {
   println("But this block will be reached")
}

Valid example:

val foo = 1.03f
val bar = 0.42f
if (abs(foo - bar) > 1e-6f) {
    println("Ok")
} else {
    println("Not")
}

4.1.3 Try to use 'val' instead of 'var' for variable declaration [SAY_NO_TO_VAR]

Variables with the val modifier are immutable (read-only). Using val variables instead of var variables increases code robustness and readability. This is because var variables can be reassigned several times in the business logic. However, in some scenarios with loops or accumulators, only vars are permitted.

4.2 Types

This section provides recommendations for using types.

4.2.1: Use Contracts and smart cast as much as possible

The Kotlin compiler has introduced Smart Casts that help reduce the size of code.

Invalid example:

    if (x is String) {
        print((x as String).length) // x was already automatically cast to String - no need to use 'as' keyword here
    }

Valid example:

    if (x is String) {
        print(x.length) // x was already automatically cast to String - no need to use 'as' keyword here
    }

Also, Kotlin 1.3 introduced Contracts that provide enhanced logic for smart-cast. Contracts are used and are very stable in stdlib, for example:

fun bar(x: String?) {
    if (!x.isNullOrEmpty()) {
        println("length of '$x' is ${x.length}") // smartcasted to not-null
    }
}

Smart cast and contracts are a better choice because they reduce boilerplate code and features forced type conversion.

Invalid example:

fun String?.isNotNull(): Boolean = this != null

fun foo(s: String?) {
    if (s.isNotNull()) s!!.length // No smartcast here and !! operator is used
}

Valid example:

fun foo(s: String?) {
    if (s.isNotNull()) s.length // We have used a method with contract from stdlib that helped compiler to execute smart cast
}

4.2.2: Try to use type alias to represent types making code more readable

Type aliases provide alternative names for existing types. If the type name is too long, you can replace it with a shorter name, which helps to shorten long generic types. For example, code looks much more readable if you introduce a typealias instead of a long chain of nested generic types. We recommend using a typealias if the type contains more than two nested generic types and is longer than 25 chars.

Invalid example:

val b: MutableMap<String, MutableList<String>>

Valid example:

typealias FileTable = MutableMap<String, MutableList<String>>
val b: FileTable

You can also provide additional aliases for function (lambda-like) types:

typealias MyHandler = (Int, String, Any) -> Unit

typealias Predicate<T> = (T) -> Boolean

4.3 Null safety and variable declarations

Kotlin is declared as a null-safe programming language. However, to achieve compatibility with Java, it still supports nullable types.

4.3.1: Avoid declaring variables with nullable types, especially from Kotlin stdlib

To avoid NullPointerException and help the compiler prevent Null Pointer Exceptions, avoid using nullable types (with ? symbol).

Invalid example:

val a: Int? = 0

Valid example:

val a: Int = 0

Nevertheless, when using Java libraries extensively, you have to use nullable types and enrich the code with !! and ? symbols. Avoid using nullable types for Kotlin stdlib (declared in official documentation). Try to use initializers for empty collections. For example, if you want to initialize a list instead of null, use emptyList().

Invalid example:

val a: List<Int>? = null

Valid example:

val a: List<Int> = emptyList()

4.3.2: Variables of generic types should have an explicit type declaration

Like in Java, classes in Kotlin may have type parameters. To create an instance of such a class, we typically need to provide type arguments:

val myVariable: Map<Int, String> = emptyMap<Int, String>()

However, the compiler can inherit type parameters from the r-value (value assigned to a variable). Therefore, it will not force users to declare the type explicitly. These declarations are not recommended because programmers would need to find the return value and understand the variable type by looking at the method.

Invalid example:

val myVariable = emptyMap<Int, String>()

Valid example:

val myVariable: Map<Int, String> = emptyMap()

4.3.3 Null-safety

Try to avoid explicit null checks (explicit comparison with null) Kotlin is declared as Null-safe language. However, Kotlin architects wanted Kotlin to be fully compatible with Java; that's why the null keyword was also introduced in Kotlin.

There are several code-structures that can be used in Kotlin to avoid null-checks. For example: ?:, .let {}, .also {}, e.t.c

Invalid example:

// example 1
var myVar: Int? = null
if (myVar == null) {
    println("null")
    return
}

// example 2
if (myVar != null) {
    println("not null")
    return
}

// example 3
val anotherVal = if (myVar != null) {
                     println("not null")
                     1
                 } else {
                     2
                 }
// example 4
if (myVar == null) {
    println("null")
} else {
    println("not null")
}

Valid example:

// example 1
var myVar: Int? = null
myVar?: run {
    println("null")
    return
}

// example 2
myVar?.let {
    println("not null")
    return
}

// example 3
val anotherVal = myVar?.also {
                     println("not null")
                     1
                 } ?: 2

// example 4
myVar?.let {
    println("not null")
} ?: run { println("null") }

Exceptions:

In the case of complex expressions, such as multiple else-if structures or long conditional statements, there is common sense to use explicit comparison with null.

Valid examples:

if (myVar != null) {
    println("not null")
} else if (anotherCondition) {
    println("Other condition")
}

if (myVar == null || otherValue == 5 && isValid) {}

Please also note, that instead of using require(a != null) with a not null check - you should use a special Kotlin function called requireNotNull(a).

5. Functions

This section describes the rules of using functions in your code.

5.1 Function design

Developers can write clean code by gaining knowledge of how to build design patterns and avoid code smells. You should utilize this approach, along with functional style, when writing Kotlin code. The concepts behind functional style are as follows: Functions are the smallest unit of combinable and reusable code. They should have clean logic, high cohesion, and low coupling to organize the code effectively. The code in functions should be simple and not conceal the author's original intentions.

Additionally, it should have a clean abstraction, and control statements should be used straightforwardly. The side effects (code that does not affect a function's return value but affects global/object instance variables) should not be used for state changes of an object. The only exceptions to this are state machines.

Kotlin is designed to support and encourage functional programming, featuring the corresponding built-in mechanisms. Also, it supports standard collections and sequences feature methods that enable functional programming (for example, apply, with, let, and run), Kotlin Higher-Order functions, function types, lambdas, and default function arguments. As previously discussed, Kotlin supports and encourages the use of immutable types, which in turn motivates programmers to write pure functions that avoid side effects and have a corresponding output for specific input. The pipeline data flow for the pure function comprises a functional paradigm. It is easy to implement concurrent programming when you have chains of function calls, where each step features the following characteristics:

1. Simplicity
2. Verifiability
3. Testability
4. Replaceability
5. Pluggability
6. Extensibility
7. Immutable results

There can be only one side effect in this data stream, which can be placed only at the end of the execution queue.

5.1.1 Avoid functions that are too long

The function should be displayable on one screen and only implement one certain logic. If a function is too long, it often means complex and could be split or simplified. Functions should consist of 30 lines (non-empty and non-comment) in total.

Exception: Some functions that implement complex algorithms may exceed 30 lines due to aggregation and comprehensiveness. Linter warnings for such functions can be suppressed.

Even if a long function works well, new problems or bugs may appear due to the function's complex logic once it is modified by someone else. Therefore, it is recommended to split such functions into several separate and shorter functions that are easier to manage. This approach will enable other programmers to read and modify the code properly.

5.1.2 Avoid deep nesting of function code blocks, limiting to four levels

The nesting depth of a function's code block is the depth of mutual inclusion between the code control blocks in the function (for example: if, for, while, and when). Each nesting level will increase the amount of effort needed to read the code because you need to remember the current "stack" (for example, entering conditional statements and loops). Exception: The nesting levels of the lambda expressions, local classes, and anonymous classes in functions are calculated based on the innermost function. The nesting levels of enclosing methods are not accumulated. Functional decomposition should be implemented to avoid confusion for the developer who reads the code. This will help the reader switch between contexts.

5.1.3 Avoid using nested functions

Nested functions create a more complex function context, thereby confusing readers. With nested functions, the visibility context may not be evident to the code reader.

Invalid example:

fun foo() {
    fun nested():String {
        return "String from nested function"
    }
    println("Nested Output: ${nested()}")
}

5.1.4 Negated function calls

Don't use negated function calls if it can be replaced with negated version of this function

Invalid example:

fun foo() {
    val list = listOf(1, 2, 3)

    if (!list.isEmpty()) {
        // Some cool logic
    }
}

Valid example:

fun foo() {
    val list = listOf(1, 2, 3)

    if (list.isNotEmpty()) {
        // Some cool logic
    }
}

5.2 Function arguments

The rules for using function arguments are described in the below topics.

5.2.1 The lambda parameter of the function should be placed at the end of the argument list

With such notation, it is easier to use curly brackets, leading to better code readability.

Valid example:

// declaration
fun myFoo(someArg: Int, myLambda: () -> Unit) {
// ...
}

// usage
myFoo(1) {
println("hey")
}

5.2.2 Number of function parameters should be limited to five

A long argument list is a code smell that leads to less reliable code. It is recommended to reduce the number of parameters. Having more than five parameters leads to difficulties in maintenance and conflicts merging. If parameter groups appear in different functions multiple times, these parameters are closely related and can be encapsulated into a single Data Class. It is recommended that you use Data Classes and Maps to unify these function arguments.

5.2.3 Use default values for function arguments instead of overloading them

In Java, default values for function arguments are prohibited. That is why the function should be overloaded when you need to create a function with fewer arguments. In Kotlin, you can use default arguments instead.

Invalid example:

private fun foo(arg: Int) {
    // ...
}

private fun foo() {
    // ...
}

Valid example:

 private fun foo(arg: Int = 0) {
     // ...
 }

5.2.4 Synchronizing code inside asynchronous code

Try to avoid using runBlocking in asynchronous code

Invalid example:

GlobalScope.async {
    runBlocking {
        count++
    }
}

5.2.5 Long lambdas should have explicit parameters

The lambda without parameters shouldn't be too long. If a lambda is too long, it can confuse the user. Lambda without parameters should consist of 10 lines (non-empty and non-comment) in total.

5.2.6 Avoid using unnecessary, custom label

Expressions with unnecessary, custom labels generally increase complexity and worsen the maintainability of the code.

Invalid example:

run lab@ {
    list.forEach {
        return@lab
    }
}

Valid example:

list.forEachIndexed { index, i ->
    return@forEachIndexed
}

lab@ for(i: Int in q) {
    for (j: Int in q) {
        println(i)
        break@lab
    }
}

6. Classes, interfaces, and extension functions

6.1 Classes

This section describes the rules of denoting classes in your code.

6.1.1 Denoting a class with a single constructor

When a class has a single constructor, it should be defined as a primary constructor in the declaration of the class. If the class contains only one explicit constructor, it should be converted to a primary constructor.

Invalid example:

class Test {
    var a: Int
    constructor(a: Int) {
        this.a = a
    }
}

Valid example:

class Test(var a: Int) {
    // ...
}

// in case of any annotations or modifiers used on a constructor:
class Test private constructor(var a: Int) {
    // ...
}

6.1.2 Prefer data classes instead of classes without any functional logic

Some people say that the data class is a code smell. However, if you need to use it (which makes your code more simple), you can utilize the Kotlin data class. The main purpose of this class is to hold data, but also data class will automatically generate several useful methods:

• equals()/hashCode() pair;
• toString()
• componentN() functions corresponding to the properties in their order of declaration;
• copy() function

Therefore, instead of using normal classes:

class Test {
    var a: Int = 0
        get() = field
        set(value: Int) { field = value}
}

class Test {
    var a: Int = 0
    var b: Int = 0

    constructor(a:Int, b: Int) {
        this.a = a
        this.b = b
    }
}

// or
class Test(var a: Int = 0, var b: Int = 0)

// or
class Test() {
    var a: Int = 0
    var b: Int = 0
}

prefer data classes:

data class Test1(var a: Int = 0, var b: Int = 0)

Exception 1: Note that data classes cannot be abstract, open, sealed, or inner; that is why these types of classes cannot be changed to a data class.

Exception 2: No need to convert a class to a data class if this class extends some other class or implements an interface.

6.1.3 Do not use the primary constructor if it is empty or useless

The primary constructor is a part of the class header; it is placed after the class name and type parameters (optional) but can be omitted if it is not used.

Invalid example:

// simple case that does not need a primary constructor
class Test() {
    var a: Int = 0
    var b: Int = 0
}

// empty primary constructor is not needed here
// it can be replaced with a primary contructor with one argument or removed
class Test() {
    var a  = "Property"

    init {
        println("some init")
    }

    constructor(a: String): this() {
        this.a = a
    }
}

Valid example:

// the good example here is a data class; this example also shows that you should get rid of braces for the primary constructor
class Test {
    var a: Int = 0
    var b: Int = 0
}

6.1.4 Do not use redundant init blocks in your class

Several init blocks are redundant and generally should not be used in your class. The primary constructor cannot contain any code. That is why Kotlin has introduced init blocks. These blocks store the code to be run during the class initialization. Kotlin allows writing multiple initialization blocks executed in the same order as they appear in the class body. Even when you follow (rule 3.2)[#r3.2], this makes your code less readable as the programmer needs to keep in mind all init blocks and trace the execution of the code. Therefore, you should try to use a single init block to reduce the code's complexity. If you need to do some logging or make some calculations before the class property assignment, you can use powerful functional programming. This will reduce the possibility of the error if your init blocks' order is accidentally changed and make the code logic more coupled. It is always enough to use one init block to implement your idea in Kotlin.

Invalid example:

class YourClass(var name: String) {
    init {
        println("First initializer block that prints ${name}")
    }

    val property = "Property: ${name.length}".also(::println)

    init {
        println("Second initializer block that prints ${name.length}")
    }
}

Valid example:

class YourClass(var name: String) {
    init {
        println("First initializer block that prints ${name}")
    }

    val property = "Property: ${name.length}".also { prop ->
        println(prop)
        println("Second initializer block that prints ${name.length}")
    }
}

The init block was not added to Kotlin to help you initialize your properties; it is needed for more complex tasks. Therefore if the init block contains only assignments of variables - move it directly to properties to be correctly initialized near the declaration. In some cases, this rule can be in clash with 6.1.1, but that should not stop you.

Invalid example:

class A(baseUrl: String) {
    private val customUrl: String
    init {
        customUrl = "$baseUrl/myUrl"
    }
}

Valid example:

class A(baseUrl: String) {
    private val customUrl = "$baseUrl/myUrl"
}

6.1.5 Explicit supertype qualification

The explicit supertype qualification should not be used if there is no clash between called methods. This rule is applicable to both interfaces and classes.

Invalid example:

open class Rectangle {
    open fun draw() { /* ... */ }
}

class Square() : Rectangle() {
    override fun draw() {
        super<Rectangle>.draw() // no need in super<Rectangle> here
    }
}

6.1.6 Abstract class should have at least one abstract method

Abstract classes are used to force a developer to implement some of its parts in their inheritors. When the abstract class has no abstract methods, it was set abstract incorrectly and can be converted to a regular class.

Invalid example:

abstract class NotAbstract {
    fun foo() {}

    fun test() {}
}

Valid example:

abstract class NotAbstract {
    abstract fun foo()

    fun test() {}
}

// OR
class NotAbstract {
    fun foo() {}

    fun test() {}
}

6.1.7 When using the "implicit backing property" scheme, the name of real and back property should be the same

Kotlin has a mechanism of backing properties. In some cases, implicit backing is not enough and it should be done explicitly:

private var _table: Map<String, Int>? = null
val table: Map<String, Int>
    get() {
        if (_table == null) {
            _table = HashMap() // Type parameters are inferred
        }
        return _table ?: throw AssertionError("Set to null by another thread")
    }

In this case, the name of the backing property (_table) should be the same as the name of the real property (table) but should have an underscore (_) prefix. It is one of the exceptions from the identifier names rule

6.1.8 Avoid using custom getters and setters

Kotlin has a perfect mechanism of properties. Kotlin compiler automatically generates get and set methods for properties and can override them.

Invalid example:

class A {
    var size: Int = 0
        set(value) {
            println("Side effect")
            field = value
        }
        // user of this class does not expect calling A.size receive size * 2
        get() = field * 2
}

From the callee code, these methods look like access to this property: A().isEmpty = true for setter and A().isEmpty for getter.

However, when get and set are overridden, it isn't very clear for a developer who uses this particular class. The developer expects to get the property value but receives some unknown value and some extra side-effect hidden by the custom getter/setter. Use extra functions instead to avoid confusion.

Valid example:

class A {
    var size: Int = 0
    fun initSize(value: Int) {
        // some custom logic
    }

    // this will not confuse developer and he will get exactly what he expects
    fun goodNameThatDescribesThisGetter() = this.size * 2
}

Exception: Private setters are only exceptions that are not prohibited by this rule.

6.1.9 Never use the name of a variable in the custom getter or setter (possible_bug)

If you ignored recommendation 6.1.8, be careful with using the name of the property in your custom getter/setter as it can accidentally cause a recursive call and a StackOverflow Error. Use the field keyword instead.

Invalid example (very bad):

var isEmpty: Boolean
    set(value) {
        println("Side effect")
        isEmpty = value
    }
    get() = isEmpty

6.1.10 No trivial getters and setters are allowed in the code

In Java, trivial getters - are the getters that are just returning the field value. Trivial setters - are merely setting the field with a value without any transformation. However, in Kotlin, trivial getters/setters are generated by default. There is no need to use it explicitly for all types of data structures in Kotlin.

Invalid example:

class A {
    var a: Int = 0
    get() = field
    set(value: Int) { field = value }

    //
}

Valid example:

class A {
    var a: Int = 0
    get() = field
    set(value: Int) { field = value }

    //
}

6.1.11 Use 'apply' for grouping object initialization

In Java, before functional programming became popular, many classes from common libraries used the configuration paradigm. To use these classes, you had to create an object with the constructor with 0-2 arguments and set the fields needed to run the object. In Kotlin, to reduce the number of dummy code line and to group objects apply extension was added:

Invalid example:

class HttpClient(var name: String) {
    var url: String = ""
    var port: String = ""
    var timeout = 0

    fun doRequest() {}
}

fun main() {
    val httpClient = HttpClient("myConnection")
    httpClient.url = "http://example.com"
    httpClient.port = "8080"
    httpClient.timeout = 100

    httpCLient.doRequest()
}

Valid example:

class HttpClient(var name: String) {
    var url: String = ""
    var port: String = ""
    var timeout = 0

    fun doRequest() {}
}

fun main() {
    val httpClient = HttpClient("myConnection")
            .apply {
                url = "http://example.com"
                port = "8080"
                timeout = 100
            }
    httpClient.doRequest()
}

6.1.12 Prefer Inline classes when a class has a single property

If a class has only one immutable property, then it can be converted to the inline class.

Sometimes it is necessary for business logic to create a wrapper around some type. However, it introduces runtime overhead due to additional heap allocations. Moreover, if the wrapped type is primitive, the performance hit is terrible, because primitive types are usually heavily optimized by the runtime, while their wrappers don't get any special treatment.

Invalid example:

class Password {
    val value: String
}

Valid example:

inline class Password(val value: String)

6.2 Extension functions

This section describes the rules of using extension functions in your code.

Extension functions is a killer-feature in Kotlin. It gives you a chance to extend classes that were already implemented in external libraries and helps you to make classes less heavy. Extension functions are resolved statically.

6.2.1 Use extension functions for making logic of classes less coupled

It is recommended that for classes, the non-tightly coupled functions, which are rarely used in the class, should be implemented as extension functions where possible. They should be implemented in the same class/file where they are used. This is a non-deterministic rule, so the code cannot be checked or fixed automatically by a static analyzer.

6.2.2 No extension functions with the same name and signature if they extend base and inheritor classes (possible_bug)

You should avoid declaring extension functions with the same name and signature if their receivers are base and inheritor classes (possible_bug), as extension functions are resolved statically. There could be a situation when a developer implements two extension functions: one is for the base class and another for the inheritor. This can lead to an issue when an incorrect method is used.

Invalid example:

open class A
class B: A()

// two extension functions with the same signature
fun A.foo() = "A"
fun B.foo() = "B"

fun printClassName(s: A) { println(s.foo()) }

// this call will run foo() method from the base class A, but
// programmer can expect to run foo() from the class inheritor B
fun main() { printClassName(B()) }

6.2.3 Don't use extension functions for the class in the same file

You should not use extension functions for the class in the same file, where it is defined.

Invalid example:

class SomeClass {

}

fun SomeClass.deleteAllSpaces() {

}

6.2.4 Use 'lastIndex' in case you need to get latest element of a collection

You should not use property length with operation - 1, you can change this to lastIndex

Invalid example:

val A = "name"
val B = A.length - 1
val C = A[A.length - 1]

Valid example:

val A = "name"
val B = A.lastIndex
val C = A[A.lastIndex]

6.3 Interfaces

An Interface in Kotlin can contain declarations of abstract methods, as well as method implementations. What makes them different from abstract classes is that interfaces cannot store state. They can have properties, but these need to be abstract or to provide accessor implementations.

Kotlin's interfaces can define attributes and functions. In Kotlin and Java, the interface is the main presentation means of application programming interface (API) design and should take precedence over the use of (abstract) classes.

6.4 Objects

This section describes the rules of using objects in code.

6.4.1 Instead of using utility classes/objects, use extensions

Avoid using utility classes/objects; use extensions instead. As described in 6.2 Extension functions, using extension functions is a powerful method. This enables you to avoid unnecessary complexity and class/object wrapping and use top-level functions instead.

Invalid example:

object StringUtil {
    fun stringInfo(myString: String): Int {
        return myString.count{ "something".contains(it) }
    }
}
StringUtil.stringInfo("myStr")

Valid example:

fun String.stringInfo(): Int {
    return this.count{ "something".contains(it) }
}

"myStr".stringInfo()

6.4.2 Objects should be used for Stateless Interfaces

Kotlin’s objects are extremely useful when you need to implement some interface from an external library that does not have any state. There is no need to use classes for such structures.

Valid example:

interface I {
    fun foo()
}

object O: I {
    override fun foo() {}
}

6.5 Kts Files

This section describes general rules for .kts files

6.5.1 kts files should wrap logic into top-level scope

It is still recommended wrapping logic inside functions and avoid using top-level statements for function calls or wrapping blocks of code in top-level scope functions like run.

Valid example:

run {
    // some code
}

fun foo() {

}

diktat's Issues

Rule 3.4 For non-empty blocks and block structures, the opening brace is placed at the end of the line

Rule 3.4 For non-empty blocks and block structures, the opening brace is placed at the end of the line

For non-empty code blocks with braces, they should follow the K&R style (1TBS or OTBS style):

• The opening brace is on the same same line with the first line of the code block
• The closing brace is on it's new line
• The closing brace can be followed by a new line or else, finally or catch keywords

Good example：

       return () -> {
           while (condition()) {
               method()
           }
       }

       return MyClass() {
           @Override
             fun method() {
               if (condition()) {
                   try {
                       something()
                   } catch (ProblemException e) {
                       recover()
                   }
               } else if (otherCondition()) {
                   somethingElse()
               } else {
                   lastThing()
               }
           }
       }

[Rule 2.4] Warn and fix if header comment is placed before package and imports directives

Can be detected as follows: warn if there are two consecutive KDocs - i.e. one is misplaced top-level, which isn't bound to any entity, and another one is KDoc for the next entity. Ensure the former is at the top of the file, right after the copyright block if it is necessary.

diktat incorrectly calculates package name (domain name duplication)

[INFO]    [ktlint] C:\Users\pwx5333130\Documents\diKTat\diktat-common\src\test\kotlin\org\cqfn\diktat\test\JsonReaderTest.kt:1:9: [5] package name does not match the directory hierarchy for this file, the path to the file is: org.cqfn.diktat.test.org.cqfn.diktat.test

Do not check KDoc on method main

Incorrect work of ASTNodeUtils: isNodeFromCompanionObject

It incorrectly checks object companion.

Add enable/disable configuration for debug logging in diktat and ktlint

Now it is awful:

if (debug) {
}

Add it to Homebrew

I can install KTlint through Homebrew, but can't do the same for diKTat. Would be great if you can make it possible.

Add more tests for checking file length properly

https://github.com/akuleshov7/diKTat/pull/7#discussion_r449765301

Kdoc should be inserted before all annotations to class/function not after

@deprecated("Foo")
/**

• @param i1
• @param i2
• @param i3
• @return
  */
  fun foo1(

False positive triggering of FUNCTION_BOOLEAN_PREFIX

[INFO]    [ktlint] C:\Users\pwx5333130\Documents\diKTat\diktat-rules\src\main\kotlin\org\cqfn\diktat\ruleset\rules\kdoc\KdocFormatting.kt:298:25: [17] functions that return the value of Boolean type should have <is> or <has> prefix: hasEmptyLineAfter

[INFO]    [ktlint] C:\Users\pwx5333130\Documents\diKTat\diktat-rules\src\main\kotlin\org\cqfn\diktat\ruleset\utils\FunctonASTNodeUtils.kt:21:13: [17] functions that return the value of Boolean type should have <is> or <has> prefix: hasParametersKDoc

[INFO]    [ktlint] C:\Users\pwx5333130\Documents\diKTat\diktat-rules\src\main\kotlin\org\cqfn\diktat\ruleset\utils\KDocUtils.kt:20:23: [17] functions that return the value of Boolean type should have <is> or <has> prefix: hasKnownKDocTag

[INFO]    [ktlint] C:\Users\pwx5333130\Documents\diKTat\diktat-rules\src\main\kotlin\org\cqfn\diktat\ruleset\utils\StringUtils.kt:23:12: [17] functions that return the value of Boolean type should have <is> or <has> prefix: isASCIILettersAndDigits

Probably because this is an extension function.

Add tests for StringCaseUtils

Fix failing test in PackageNamingWarnTest.kt

    @Test
    @Ignore("this test is failing because params.fileName!! throws NPE")
    fun `missing package name (check)`() {

Diktat rule set should not trigger standard ruleset when is called by ktlint

Recommendation 3.2: The declaration part of a class-like code structures (class/interface/e.t.c) should be in the proper order

Notes:

• There should be no blank lines between properties without comments;
• Properties with comments/Kdoc should be separated by a newline before the comment/Kdoc

The declaration part of a class or interface should be in the following order:

• compile-time constants (for objects)
• Properties
• late-init class properties
• init-blocks
• constructors
• methods or nested classes. Put nested classes next to the code that uses those classes. If the classes are intended to be used externally and aren't referenced inside the class, put them in the end, after the companion object.
• companion object
• Exception： All variants of a private val logger should be placed in the beginning of the class (private val log/LOG/logger/e.t.c)

Bugs with identifiers naming checks

• toUpperCase incorrectly convert names like iAmConstant
• I_AM_CONSTANT1 - Incorrectly raises warning when sees digit in the name
• STRANGE_name - incorrect case fixing

KDocMethods should check if @param arguments are actually present in arguments list

For example, developer could have renamed parameter in code and forgot to update KDoc. Currently KDocMethods rule only checks if all arguments are present in KDoc, not vice versa.

Add usage instruction with gradle to README

Gradle is really popular in kotlin community, also ktlint has good integration with gradle. We should add instructions on how to add artipie and our dependencies in build.gradle and how to use diktat with ktlint plugin.

Error on argument with function type

On

fun ASTNode.findChildrenMatching(elementType: IElementType? = null, predicate: (ASTNode) -> Boolean): List<ASTNode> =

diktat fails with

[INFO]    [ktlint] C:\Users\pwx5333130\Documents\diKTat\diktat-rules\src\main\kotlin\org\cqfn\diktat\ruleset\utils\AstNodeUtils.kt:182:81: Internal Error (diktat-ruleset:identifier-naming). Please create a ticket at https://github.com/pinterest/ktlint/issues (if possible, provide the source code that triggered an error) (cannot be auto-corrected)

Offset corresponds to opening parentheses at (ASTNode)

diKTat should not fail on missing configuration. It should raise a warning in this case

[DEBUG] Internal Error (diktat-ruleset:package-naming)
com.pinterest.ktlint.core.RuleExecutionException: java.util.NoSuchElementException: Key domainName is missing in the map.
at com.pinterest.ktlint.core.KtLint$lint$1.invoke(KtLint.kt:177)
at com.pinterest.ktlint.core.KtLint$lint$1.invoke(KtLint.kt:43)
at com.pinterest.ktlint.core.KtLint$visitor$2$1.invoke(KtLint.kt:246)
at com.pinterest.ktlint.core.KtLint$visitor$2$1.invoke(KtLint.kt:43)
at com.pinterest.ktlint.core.KtLint.visit(KtLint.kt:572)
at com.pinterest.ktlint.core.KtLint.access$visit(KtLint.kt:43)
at com.pinterest.ktlint.core.KtLint$visitor$2.invoke(KtLint.kt:244)
at com.pinterest.ktlint.core.KtLint$visitor$2.invoke(KtLint.kt:43)
at com.pinterest.ktlint.core.KtLint.lint(KtLint.kt:162)
at com.pinterest.ktlint.internal.FileUtilsKt.lintFile(FileUtils.kt:51)

[CI/CD] diktat analyzer should be checking it's own code

diktat should check it's own code

diKTat should support work as gradle plugin

Fix KdocMethods#addKdocTemplate

KDocs added by KDocMethods rule are not properly indented by IndentationRule. This is probably because KDoc template is added as LeafPsiElement, while it should be a CompositeElement.
Example of CompositeElement construction can be found in KdocUtils: ASTNode.insertTagBefore.
Once this is fixed, one should try applying KDocMethods and IndentationRule simultaneously. Such case should also be added in #50 .

False trigger of identifier naming rule at underscores

Underscores should be allowed for ignored parameters

[INFO]    [ktlint] C:\Users\pwx5333130\Documents\diKTat\diktat-rules\src\test\kotlin\org\cqfn\diktat\ruleset\utils\TestUtils.kt:23:31: [9] variable name should be in camel case (correct: checkIpConfig, incorrect: CheckIPConfig) should contain only latin (ASCII) letters or numbers and should start from lower letter: _

Release 1.0.1 version and prepare release instructions

We have a critical bugfix (#77 #78 ) for maven plugin that will enable it. Need to release new version and update release instructions.

rules-config.json is not properly read when diktat works as a separate jar

./ktlint -R diktat.jar will fail with an exception that it cannot find rules-config.json

Special handling of methods in tests

• No need to check method name for case and length, if it is in back ticks and consists of multiple words
• Do not force KDoc even if test method is public

Method is considered from tests if one of the following is true:

• Annotated with @Test
• Located in src/test
• File name ends with test

Describe order of all top-level structures inside a file

Currently we have rule 3.2 regarding file header and recommendation 3.2 regarding order of declarations inside class or object. Need to add requirements on declarations inside a file as a whole.

[Static analysis] FileSize code has big nested block depth - please fix it

NestedBlockDepth - 5/4 - [visit] at C:\Users\a00543375\Desktop\projects\diKTat\diktat-ules\src\main\kotlin\org\cqfn\diktat\ruleset\rules\FileSize.kt:28:18

Automatic release: add and test action for it

There are several tools in the market place:
-- https://github.com/actions/create-release
-- https://github.com/marketplace/actions/maven-release

[Formatting rules] Add support for checking and fixing copyright date in the Kdoc

If your code has a copyright and it's actual year differs from the current year - it should be fixed (or warning should be raised).
For example if current year is 2020, this code

/** 
* Copyright (c) Ivanoff Technologies Co., Ltd. 1992-2017. All rights reserved
*/

should be changed to this one:

/** 
* Copyright (c) Ivanoff Technologies Co., Ltd. 1992-2020. All rights reserved
*/

Sort everything (enum values, function parameters...)

Sort ENUM values alphabetically, sort function parameters alphabetically, sort argument list alphabetically, e.t.c

Include 'best practices' to code style

• For methods with "(get|set)" names look for fields with same name and suggest to use kotlin-style get()/set(value)

Move it to Maven Central

Now it's hosted on Artipie. I don't see why can't we host it on Maven Central under org.cqfn domain.

Check formatting for @since tag in KDoc

In addition to rule 2.3:

• Need to ensure that this tag is used for versions, not dates.

Code scan: we need to add unit-test coverage tool

There are actions and tools like "codecov" they have maven plugin - need to integrate it

Smoke tests for diktat rules

• Create verbose examples for expected diktat behavior, when many warnings are applied simultaneously.
• Try to make them 'real-world' examples for common use cases.
• Probably, use TestEntry from diktat-test-framework?

[Rule 3.3] Braces

Rule 3.3 Braces must be used in conditional statements and loop blocks

In if, else, when, for, do, and while statements, even if the program body is empty or contains only one statement, braces should be used.

Exception: Only The only exception is ternary operator in Kotlin (it is a single line if () <> else <> )
When the entire expression can be

Bad example:

val value = if (string.isEmpty())  // WRONG!
                0
            else
                1

Valid example:

val value = if (string.isEmpty()) 0 else 1  // Okay

if (condition) {
    println("test")
} else {
    println(0)
}

[Formatting rules] Improve analysis of KDocs for functions

In addition to rule 2.5:

• Do not force KDocs for methods with name "(get|set).*" and single line of body
• Do not force @return, @param tag for getters/setters at all.
• The following KDocs are considered useless: if they start with words return/get/set and contains one or two more words
• Do not force KDoc for standard methods like toString, equals and hashCode

Validate diktat-analysis.yml before start of analysis

If there are issues with user's json config, we should report it asap and fail without start of analysis. Possible issues:

• wrong warning names
  * wrong fields in configuration moved to #395
  * wrong values in configuration (e.g. numbers in wrong format) same

Improvements for diktat check

• Add maven cache to github workflow
• In release workflow, when new version of diktat is released, create pull request with updated version in diktat check (antrun plugin) #91 for this
• Ideally, resolve #69

Automatically from release workflow open PR with fresh version of diktat in antrun diktat config

mvn versions:set-property -Dproperty=diktat-check.version etc.
Property is introduced in #111

Rule 3.5: Use spaces for indentation, indenting is equal to 4 spaces

May be you can look if it is already done in ktlint-standard? If yes - simply inherit it with customizations

Only spaces are allowed for indentation and each indentation should equal to 4 spaces (tabs are not allowed).
In case you prefer using tabs - just simply configure auto change of tabs to spaces in your IDE.
Exceptions:

1. When breaking parameter list of a method/class constructor it can be aligned with 8 spaces or a parameter that was moved to a newline can be on the same level as the previous argument:

class Class(propertiesFileName: String,
            otherName: String) {

or

fun visit(
        node: ASTNode,
        autoCorrect: Boolean,
        params: KtLint.Params,
        emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit
) {

2. Operators like +/-/*/e.t.c can be indented with 8 spaces:

val abcdef = "my splitted" +
                " string"

Add tests for AstNodeUtils

Recommendation 3.1 - recommended ordering of imports

The following snippet can be a starting point for implementation inside FileStructureRule.kt:

private val recommendedComparator = Comparator<ASTNode> { import1, import2 ->
        require(import1.elementType == IMPORT_DIRECTIVE && import2.elementType == IMPORT_DIRECTIVE) { "This comparator is for sorting imports" }
        val pathSegments1 = (import1.psi as KtImportDirective).importPath!!.fqName.pathSegments()
        val pathSegments2 = (import2.psi as KtImportDirective).importPath!!.fqName.pathSegments()

        return@Comparator 0
    }

diKTat code style should prohibit quoted function names

We have to prohibit fun 'some name'() usage everywhere in the code, except test files

IdentifierNaming#checkObjectNaming throws NPE on checking companion object

   [ktlint] Caused by: kotlin.KotlinNullPointerException
   [ktlint] 	at org.cqfn.diktat.ruleset.rules.IdentifierNaming.checkObjectNaming(IdentifierNaming.kt:185)
   [ktlint] 	at org.cqfn.diktat.ruleset.rules.IdentifierNaming.visit(IdentifierNaming.kt:69)
   [ktlint] 	at com.pinterest.ktlint.core.KtLint$lint$1.invoke(KtLint.kt:167)
   [ktlint] 	... 20 more

Same occurs on anonymous objects

object : Rule("astnode-utils-test") {
                                    override fun visit(node: ASTNode,

Fix issues related to github pages

Now it is failing due to a code style on chinese

Automate documentation generation

Currently we write all new warnings with description, list of tests and fixmes into a table manually. What could be automated:

• Get list of warnings from Warnings.kt
• Create mechanism to store descriptions in code
• Get descriptions from code
• Get list of tests from names of @Test methods

Add automatic dependency updates

There is awesome app like Depfu, but it cannot be used for maven and Kotlin. Need to find some analog for it.

[Static analysis] Long Method issue - split these methods to smaller

src\main\kotlin\org\cqfn\diktat\ruleset\rules\KdocMethods.kt:70:17