Object property naming convention

Reports properties that do not follow the naming conventions.

The following properties are reported:

Top-level properties
Properties in objects and companion objects

You can specify the required pattern in the inspection options.

Recommended naming conventions: it has to start with an uppercase letter, use camel case and no underscores.

Example:

  // top-level property
  val USER_NAME_FIELD = "UserName"
  // top-level property holding reference to singleton object
  val PersonComparator: Comparator<Person> = /*...*/

  class Person {
    companion object {
      // property in companion object
      val NO_NAME = Person()
    }
  }

Locating this inspection

By ID

Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.

ObjectPropertyName

Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | Kotlin | Naming conventions

Inspection options

Here you can find the description of settings available for the Object property naming convention inspection, and the reference of their default values.

Pattern: [A-Za-z][_A-Za-z\d]*

Availability

By default bundled with: IntelliJ IDEA 2024.1, Qodana for JVM 2024.1,
Can be installed with plugin: Kotlin, 241.18072-IJ

Last modified: 18 June 2024