Add build task experimental rules

.editorconfig

@@ -15,6 +15,14 @@ indent_size = 4
 
 [*.{kt,kts}]
 ij_kotlin_imports_layout=*
+# Ideally, no experimental rule should be disabled. Ktlint should follow the dogfooding principle. This means that an
+# experimental rule should only be added to the master branch no sooner than that this rule has been applied on the
+# ktlint code base itself.
+# For now, the experimental:argument-list-wrapping still needs to be disabled as it fails the build due to false
+# positives. See https://github.com/pinterest/ktlint/pull/1284
+disabled_rules=experimental:argument-list-wrapping
+ij_kotlin_allow_trailing_comma=false
+ij_kotlin_allow_trailing_comma_on_call_site=false
 
 [{Makefile,*.go}]
 indent_style = tab

CHANGELOG.md

@@ -20,6 +20,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 - Update Kotlin version to `1.6.0` release
 - Add separate tasks to run tests on JDK 11 - "testOnJdk11"
 - Update Dokka to `1.6.0` release
+- Apply ktlint experimental rules on the ktlint code base itself.
 - Update shadow plugin to `7.1.1` release
 
 ### Removed

build.gradle

@@ -45,10 +45,14 @@ dependencies {
 }
 
 task ktlint(type: JavaExec, group: LifecycleBasePlugin.VERIFICATION_GROUP) {
- description = "Check Kotlin code style."
+ description = "Check Kotlin code style including experimental rules."
  classpath = configurations.ktlint
  main = 'com.pinterest.ktlint.Main'
- args '**/src/**/*.kt', '!**/resources/cli/**', '--baseline=ktlint-baseline.xml', '--verbose'
+ // Experimental rules run by default run on the ktlint code base itself. Experimental rules should not be released if
+ // we are not pleased ourselves with the results on the ktlint code base.
+ // Sources in "ktlint/src/test/resources" are excluded as those source contain lint errors that have to be detected by
+ // unit tests and should not be reported/fixed.
+ args '**/src/**/*.kt', '!ktlint/src/test/resources/**', '--baseline=ktlint/src/test/resources/test-baseline.xml', '--experimental', '--verbose'
 }
 
 /**

ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt

@@ -63,7 +63,7 @@ public object KtLint {
  val cb: (e: LintError, corrected: Boolean) -> Unit,
  val script: Boolean = false,
  val editorConfigPath: String? = null,
- val debug: Boolean = false,
+ val debug: Boolean = false
  )
 
  /**
@@ -97,7 +97,7 @@ public object KtLint {
  val editorConfigPath: String? = null,
  val debug: Boolean = false,
  val editorConfigOverride: EditorConfigOverridesMap = emptyMap(),
- val isInvokedFromCli: Boolean = false,
+ val isInvokedFromCli: Boolean = false
  ) {
  internal val normalizedFilePath: Path? get() = if (fileName == STDIN_FILE || fileName == null) {
  null
@@ -358,12 +358,6 @@ public object KtLint {
  @OptIn(FeatureInAlphaState::class)
  public fun format(params: Params): String = format(toExperimentalParams(params))
 
- /**
- * Fix style violations.
- *
- * @throws ParseException if text is not a valid Kotlin code
- * @throws RuleExecutionException in case of internal failure caused by a bug in rule implementation
- */
  /**
  * Fix style violations.
  *

ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/Reporter.kt

@@ -14,15 +14,18 @@ interface Reporter {
  * It's guarantied to be called before any of the other [Reporter]s methods.
  */
  fun beforeAll() {}
+
  /**
  * Called when file (matching the pattern) is found but before it's parsed.
  */
  fun before(file: String) {}
  fun onLintError(file: String, err: LintError, corrected: Boolean)
+
  /**
  * Called after ktlint is done with the file.
  */
  fun after(file: String) {}
+
  /**
  * Called once, after all the files (if any) have been processed.
  * It's guarantied to be called after all other [Reporter]s methods.

ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/Rule.kt

@@ -39,6 +39,7 @@ abstract class Rule(val id: String) {
  * (in other words, [visit] will be called on [FileASTNode] but not on [FileASTNode] children).
  */
  interface RestrictToRoot
+
  /**
  * Marker interface to indicate that rule must be executed after all other rules (order among multiple
  * [RestrictToRootLast] rules is not defined and should be assumed to be random).

ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/api/OptInFeatures.kt

@@ -8,7 +8,7 @@ package com.pinterest.ktlint.core.api
 @Target(
  AnnotationTarget.CLASS,
  AnnotationTarget.FUNCTION,
- AnnotationTarget.TYPEALIAS,
+ AnnotationTarget.TYPEALIAS
 )
 public annotation class FeatureInAlphaState
 
@@ -20,6 +20,6 @@ public annotation class FeatureInAlphaState
 @Target(
  AnnotationTarget.CLASS,
  AnnotationTarget.FUNCTION,
- AnnotationTarget.TYPEALIAS,
+ AnnotationTarget.TYPEALIAS
 )
 public annotation class FeatureInBetaState

ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/internal/EditorConfigGeneratorTest.kt

@@ -33,7 +33,7 @@ internal class EditorConfigGeneratorTest {
 
  val generatedEditorConfig = editorConfigGenerator.generateEditorconfig(
  filePath = tempFileSystem.normalizedPath(rootDir).resolve("test.kt"),
- rules = rules,
+ rules = rules
  )
 
  assertThat(generatedEditorConfig.lines()).doesNotContainAnyElementsOf(listOf("root = true"))

ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/internal/EditorConfigLoaderTest.kt

@@ -87,7 +87,7 @@ internal class EditorConfigLoaderTest {
  .isEqualTo(
  mapOf(
  "indent_size" to "2",
- "tab_width" to "2",
+ "tab_width" to "2"
  )
  )
  }
@@ -137,7 +137,7 @@ internal class EditorConfigLoaderTest {
  mapOf(
  "indent_size" to "2",
  "tab_width" to "2",
- "indent_style" to "space",
+ "indent_style" to "space"
  )
  )
 
@@ -149,7 +149,7 @@ internal class EditorConfigLoaderTest {
  mapOf(
  "indent_size" to "4",
  "tab_width" to "4",
- "indent_style" to "space",
+ "indent_style" to "space"
  )
  )
 
@@ -159,15 +159,17 @@ internal class EditorConfigLoaderTest {
 
  assertThat(parsedEditorConfig).isEqualTo(
  mapOf(
- "end_of_line" to "lf",
+ "end_of_line" to "lf"
  )
  )
  }
 
  @Test
  fun `Should parse assignment with spaces`() {
  val projectDir = "/project"
- @Language("EditorConfig") val editorconfigFile =
+
+ @Language("EditorConfig")
+ val editorconfigFile =
  """
  [*.{kt,kts}]
  insert_final_newline = true
@@ -183,15 +185,17 @@ internal class EditorConfigLoaderTest {
  assertThat(parsedEditorConfig).isEqualTo(
  mapOf(
  "insert_final_newline" to "true",
- "disabled_rules" to "import-ordering",
+ "disabled_rules" to "import-ordering"
  )
  )
  }
 
  @Test
  fun `Should parse unset values`() {
  val projectDir = "/project"
- @Language("EditorConfig") val editorconfigFile =
+
+ @Language("EditorConfig")
+ val editorconfigFile =
  """
  [*.{kt,kts}]
  indent_size = unset
@@ -206,15 +210,17 @@ internal class EditorConfigLoaderTest {
  assertThat(parsedEditorConfig).isEqualTo(
  mapOf(
  "indent_size" to "unset",
- "tab_width" to "unset",
+ "tab_width" to "unset"
  )
  )
  }
 
  @Test
  fun `Should parse list with spaces after comma`() {
  val projectDir = "/project"
- @Language("EditorConfig") val editorconfigFile =
+
+ @Language("EditorConfig")
+ val editorconfigFile =
  """
  [*.{kt,kts}]
  disabled_rules=import-ordering, no-wildcard-imports
@@ -228,7 +234,7 @@ internal class EditorConfigLoaderTest {
  assertThat(parsedEditorConfig).isNotEmpty
  assertThat(parsedEditorConfig).isEqualTo(
  mapOf(
- "disabled_rules" to "import-ordering, no-wildcard-imports",
+ "disabled_rules" to "import-ordering, no-wildcard-imports"
  )
  )
  }
@@ -253,7 +259,8 @@ internal class EditorConfigLoaderTest {
 
  @Test
  fun `Should return properties for stdin from current directory`() {
- @Language("EditorConfig") val editorconfigFile =
+ @Language("EditorConfig")
+ val editorconfigFile =
  """
  [*.{kt,kts}]
  insert_final_newline = true
@@ -265,7 +272,7 @@ internal class EditorConfigLoaderTest {
  filePath = null,
  isStdIn = true,
  rules = rules,
- debug = true,
+ debug = true
  )
  val parsedEditorConfig = editorConfigProperties.convertToRawValues()
 
@@ -377,7 +384,9 @@ internal class EditorConfigLoaderTest {
  @Test
  fun `Should support editorconfig globs when loading properties for file specified under such glob`() {
  val projectDir = "/project"
- @Language("EditorConfig") val editorconfigFile =
+
+ @Language("EditorConfig")
+ val editorconfigFile =
  """
  [*.{kt,kts}]
  insert_final_newline = true
@@ -398,15 +407,17 @@ internal class EditorConfigLoaderTest {
  assertThat(parsedEditorConfig).isEqualTo(
  mapOf(
  "insert_final_newline" to "true",
- "disabled_rules" to "class-must-be-internal",
+ "disabled_rules" to "class-must-be-internal"
  )
  )
  }
 
  @Test
  fun `Should add property from override`() {
  val projectDir = "/project"
- @Language("EditorConfig") val editorconfigFile =
+
+ @Language("EditorConfig")
+ val editorconfigFile =
  """
  [*.{kt,kts}]
  disabled_rules=import-ordering, no-wildcard-imports
@@ -436,7 +447,9 @@ internal class EditorConfigLoaderTest {
  @Test
  fun `Should replace property from override`() {
  val projectDir = "/project"
- @Language("EditorConfig") val editorconfigFile =
+
+ @Language("EditorConfig")
+ val editorconfigFile =
  """
  [*.{kt,kts}]
  insert_final_newline = true

ktlint-reporter-baseline/src/test/kotlin/com/pinterest/ktlint/reporter/baseline/BaselineReporterTest.kt

@@ -16,49 +16,34 @@ class BaselineReporterTest {
  val reporter = BaselineReporter(PrintStream(out, true))
  reporter.onLintError(
  "$basePath/one-fixed-and-one-not.kt",
- LintError(
- 1, 1, "rule-1",
- "<\"&'>"
- ),
+ LintError(1, 1, "rule-1", "<\"&'>"),
  false
  )
  reporter.onLintError(
  "$basePath/one-fixed-and-one-not.kt",
- LintError(
- 2, 1, "rule-2",
- "And if you see my friend"
- ),
+ LintError(2, 1, "rule-2", "And if you see my friend"),
  true
  )
 
  reporter.onLintError(
  "$basePath/two-not-fixed.kt",
- LintError(
- 1, 10, "rule-1",
- "I thought I would again"
- ),
+ LintError(1, 10, "rule-1", "I thought I would again"),
  false
  )
  reporter.onLintError(
  "$basePath/two-not-fixed.kt",
- LintError(
- 2, 20, "rule-2",
- "A single thin straight line"
- ),
+ LintError(2, 20, "rule-2", "A single thin straight line"),
  false
  )
 
  reporter.onLintError(
  "$basePath/all-corrected.kt",
- LintError(
- 1, 1, "rule-1",
- "I thought we had more time"
- ),
+ LintError(1, 1, "rule-1", "I thought we had more time"),
  true
  )
  reporter.afterAll()
  assertThat(String(out.toByteArray())).isEqualTo(
-"""
+ """
 <?xml version="1.0" encoding="utf-8"?>
 <baseline version="1.0">
  <file name="one-fixed-and-one-not.kt">

ktlint-reporter-html/src/main/kotlin/com/pinterest/ktlint/reporter/html/HtmlReporter.kt

@@ -60,7 +60,6 @@ class HtmlReporter(private val out: PrintStream) : Reporter {
  }
  body {
  if (!acc.isEmpty()) {
-
  h1 { text("Overview") }
 
  paragraph {

ktlint-ruleset-experimental/src/test/kotlin/com/pinterest/ktlint/ruleset/experimental/EnumEntryNameCaseRuleTest.kt

@@ -47,7 +47,7 @@ class EnumEntryNameCaseRuleTest {
  5,
  "enum-entry-name-case",
  EnumEntryNameCaseRule.ERROR_MESSAGE
- ),
+ )
  )
  )
  }