Merge pull request #639 from square/rick/enable_ktlint_rules

enable disabled ktlint rules

Author: RBusarow

.editorconfig

@@ -9,7 +9,7 @@
 #
 # Some keys were manually changed:
 #   * insert_final_newline (is false, changed to true, expected by KtLint)
-#   * kotlin_imports_layout (see comment below, needed for KtLint)
+#   * ktlint_ignore_back_ticked_identifier (enabled, see comment below)
 #   * root (see comment below)
 
 # Tells tools to stop searching upwards.
@@ -30,10 +30,9 @@ ij_formatter_tags_enabled = false
 ij_smart_tabs = false
 ij_wrap_on_typing = false
 
-# This config is needed for KtLint. It configures the import rule order to use IntelliJ IDEA's
-# default style, see also:
-# https://github.com/pinterest/ktlint#custom-ktlint-specific-editorconfig-properties
-kotlin_imports_layout = *,java.**,javax.**,kotlin.**,^
+# Back-ticked method names are allowed to exceed the line length. That's especially helpful for
+# test methods with descriptive names.
+ktlint_ignore_back_ticked_identifier = true
 
 [*.java]
 ij_java_align_consecutive_assignments = false

build.gradle.kts

@@ -66,28 +66,6 @@ subprojects {
       // Default "plain" reporter is actually harder to read.
       reporter(ReporterType.JSON)
     }
-
-    disabledRules.set(
-      setOf(
-        // IntelliJ refuses to sort imports correctly.
-        // This is a known issue: https://github.com/pinterest/ktlint/issues/527
-        "import-ordering",
-
-        // We had to disable the indent and parameter-list-wrapping rules, because they lead to
-        // false positives even in the most recent KtLint version. We created tickets:
-        //
-        // https://github.com/pinterest/ktlint/issues/963
-        // https://github.com/pinterest/ktlint/issues/964
-        // https://github.com/pinterest/ktlint/issues/965
-        //
-        // We can't revert the KtLint version, because they only work with Kotlin 1.3 and would
-        // block Kotlin 1.4. We rather have a newer Kotlin version than a proper indent. The
-        // indent rule needs to be disabled globally due to another bug:
-        // https://github.com/pinterest/ktlint/issues/967
-        "indent",
-        "parameter-list-wrapping"
-      )
-    )
   }
 }
 

internal-testing-utils/src/main/java/com/squareup/workflow1/internal/util/UncaughtExceptionGuard.kt

@@ -40,7 +40,7 @@ public class UncaughtExceptionGuard {
 
     // If the block completed successfully, but an uncaught exception was reported, report it now.
     uncaughtException.get()
-        ?.let { throw it }
+      ?.let { throw it }
 
     return result
   }

internal-testing-utils/src/test/java/com/squareup/workflow1/internal/util/UncaughtExceptionGuardTest.kt

@@ -47,7 +47,7 @@ class UncaughtExceptionGuardTest {
     try {
       rethrowingUncaughtExceptions {
         Thread.getDefaultUncaughtExceptionHandler()
-            .uncaughtException(Thread.currentThread(), RuntimeException("fail"))
+          .uncaughtException(Thread.currentThread(), RuntimeException("fail"))
       }
       fail("Expected exception.")
     } catch (e: RuntimeException) {
@@ -67,7 +67,7 @@ class UncaughtExceptionGuardTest {
         // Wait for all the other threads are also ready…
         startLatch.await()
         Thread.getDefaultUncaughtExceptionHandler()
-            .uncaughtException(Thread.currentThread(), RuntimeException("fail $i"))
+          .uncaughtException(Thread.currentThread(), RuntimeException("fail $i"))
         finishedLatch.countDown()
       }.start()
     }

samples/compose-samples/src/main/java/com/squareup/sample/compose/hellocomposebinding/HelloBindingActivity.kt

@@ -35,22 +35,22 @@ class HelloBindingActivity : AppCompatActivity() {
 
     val model: HelloBindingModel by viewModels()
     setContentView(
-        WorkflowLayout(this).apply {
-          start(
-              renderings = model.renderings,
-              environment = viewEnvironment
-          )
-        }
+      WorkflowLayout(this).apply {
+        start(
+          renderings = model.renderings,
+          environment = viewEnvironment
+        )
+      }
     )
   }
 
   class HelloBindingModel(savedState: SavedStateHandle) : ViewModel() {
     @OptIn(WorkflowUiExperimentalApi::class)
     val renderings: StateFlow<Any> by lazy {
       renderWorkflowIn(
-          workflow = HelloWorkflow,
-          scope = viewModelScope,
-          savedStateHandle = savedState
+        workflow = HelloWorkflow,
+        scope = viewModelScope,
+        savedStateHandle = savedState
       )
     }
   }

samples/compose-samples/src/main/java/com/squareup/sample/compose/hellocomposeworkflow/ComposeWorkflowImpl.kt

@@ -4,14 +4,14 @@ import androidx.compose.runtime.Composable
 import androidx.compose.runtime.MutableState
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.structuralEqualityPolicy
+import com.squareup.sample.compose.hellocomposeworkflow.ComposeWorkflowImpl.State
 import com.squareup.workflow1.Sink
 import com.squareup.workflow1.Snapshot
 import com.squareup.workflow1.StatefulWorkflow
 import com.squareup.workflow1.action
 import com.squareup.workflow1.contraMap
 import com.squareup.workflow1.ui.ViewEnvironment
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
-import com.squareup.sample.compose.hellocomposeworkflow.ComposeWorkflowImpl.State
 import com.squareup.workflow1.ui.compose.ComposeRendering
 
 @WorkflowUiExperimentalApi
@@ -35,15 +35,18 @@ internal class ComposeWorkflowImpl<PropsT, OutputT : Any>(
     val propsHolder = mutableStateOf(props, policy = structuralEqualityPolicy())
     val sinkHolder = SinkHolder<OutputT>()
 
-    return State(propsHolder, sinkHolder, object : ComposeRendering {
-      @Composable override fun Content(viewEnvironment: ViewEnvironment) {
-        // The sink will get set on the first render pass, which must happen before this is first
-        // composed, so it should never be null.
-        val sink = sinkHolder.sink!!
-        // Important: Use the props from the MutableState, _not_ the one passed into render.
-        workflow.RenderingContent(propsHolder.value, sink, viewEnvironment)
+    return State(
+      propsHolder, sinkHolder,
+      object : ComposeRendering {
+        @Composable override fun Content(viewEnvironment: ViewEnvironment) {
+          // The sink will get set on the first render pass, which must happen before this is first
+          // composed, so it should never be null.
+          val sink = sinkHolder.sink!!
+          // Important: Use the props from the MutableState, _not_ the one passed into render.
+          workflow.RenderingContent(propsHolder.value, sink, viewEnvironment)
+        }
       }
-    })
+    )
   }
 
   override fun onPropsChanged(

samples/compose-samples/src/main/java/com/squareup/sample/compose/inlinerendering/InlineRenderingWorkflow.kt

@@ -65,8 +65,10 @@ object InlineRenderingWorkflow : StatefulWorkflow<Unit, Int, Nothing, AndroidVie
   AnimatedContent(
     targetState = counterValue,
     transitionSpec = {
-      (slideInVertically() + fadeIn() with
-        slideOutVertically() + fadeOut())
+      (
+        slideInVertically() + fadeIn() with
+          slideOutVertically() + fadeOut()
+        )
         .using(SizeTransform(clip = false))
     }
   ) { content(it) }

samples/compose-samples/src/main/java/com/squareup/sample/compose/launcher/SampleLauncherApp.kt

@@ -45,11 +45,11 @@ import com.squareup.sample.compose.R
 @Composable fun SampleLauncherApp() {
   MaterialTheme(colors = darkColors()) {
     Scaffold(
-        topBar = {
-          TopAppBar(title = {
-            Text(stringResource(R.string.app_name))
-          })
-        }
+      topBar = {
+        TopAppBar(title = {
+          Text(stringResource(R.string.app_name))
+        })
+      }
     ) {
       LazyColumn {
         items(samples) {
@@ -75,12 +75,12 @@ import com.squareup.sample.compose.R
   val globalBounds = remember { Ref<Rect>() }
 
   ListItem(
-      text = { Text(sample.name) },
-      secondaryText = { Text(sample.description) },
-      singleLineSecondaryText = false,
-      // Animate the activities as scaling up from where the preview is drawn.
-      icon = { SamplePreview(sample) { globalBounds.value = it.boundsInRoot() } },
-      modifier = Modifier.clickable { launchSample(sample, rootView, globalBounds.value) }
+    text = { Text(sample.name) },
+    secondaryText = { Text(sample.description) },
+    singleLineSecondaryText = false,
+    // Animate the activities as scaling up from where the preview is drawn.
+    icon = { SamplePreview(sample) { globalBounds.value = it.boundsInRoot() } },
+    modifier = Modifier.clickable { launchSample(sample, rootView, globalBounds.value) }
   )
 }
 
@@ -100,24 +100,24 @@ import com.squareup.sample.compose.R
   // the measurements here otherwise the rest of the UI will think the previews are full-size even
   // though they're graphically scaled down.
   Box(
-      modifier = Modifier
-          .height(previewHeight)
-          .aspectRatio(screenRatio)
-          .onGloballyPositioned(onPreviewCoordinates)
+    modifier = Modifier
+      .height(previewHeight)
+      .aspectRatio(screenRatio)
+      .onGloballyPositioned(onPreviewCoordinates)
   ) {
     // Preview the samples with a light theme, since that's what most of them use.
     MaterialTheme(lightColors()) {
       Surface {
         Box(
-            modifier = Modifier
-                // This preview isn't meant to be interactive.
-                .disableTouchInput()
-                // Measure/layout the child at full screen size, and then just scale the pixels
-                // down. This way all the text and other density-dependent things get scaled
-                // correctly too.
-                .requiredHeight(configuration.screenHeightDp.dp)
-                .requiredWidth(configuration.screenWidthDp.dp)
-                .graphicsLayer(scaleX = scale, scaleY = scale)
+          modifier = Modifier
+            // This preview isn't meant to be interactive.
+            .disableTouchInput()
+            // Measure/layout the child at full screen size, and then just scale the pixels
+            // down. This way all the text and other density-dependent things get scaled
+            // correctly too.
+            .requiredHeight(configuration.screenHeightDp.dp)
+            .requiredWidth(configuration.screenWidthDp.dp)
+            .graphicsLayer(scaleX = scale, scaleY = scale)
         ) {
           sample.preview()
         }
@@ -135,11 +135,11 @@ private fun launchSample(
   val intent = Intent(context, sample.activityClass.java)
   val options: Bundle? = sourceBounds?.let {
     makeScaleUpAnimation(
-        rootView,
-        it.left.toInt(),
-        it.top.toInt(),
-        it.width.toInt(),
-        it.height.toInt()
+      rootView,
+      it.left.toInt(),
+      it.top.toInt(),
+      it.width.toInt(),
+      it.height.toInt()
     ).toBundle()
   }
   startActivity(context, intent, options)

samples/compose-samples/src/main/java/com/squareup/sample/compose/launcher/Samples.kt

@@ -4,12 +4,12 @@ package com.squareup.sample.compose.launcher
 
 import androidx.activity.ComponentActivity
 import androidx.compose.runtime.Composable
-import com.squareup.sample.compose.hellocomposeworkflow.HelloComposeWorkflowActivity
-import com.squareup.sample.compose.hellocomposeworkflow.HelloComposeWorkflowPreview
 import com.squareup.sample.compose.hellocompose.App
 import com.squareup.sample.compose.hellocompose.HelloComposeActivity
 import com.squareup.sample.compose.hellocomposebinding.DrawHelloRenderingPreview
 import com.squareup.sample.compose.hellocomposebinding.HelloBindingActivity
+import com.squareup.sample.compose.hellocomposeworkflow.HelloComposeWorkflowActivity
+import com.squareup.sample.compose.hellocomposeworkflow.HelloComposeWorkflowPreview
 import com.squareup.sample.compose.inlinerendering.InlineRenderingActivity
 import com.squareup.sample.compose.inlinerendering.InlineRenderingWorkflowPreview
 import com.squareup.sample.compose.nestedrenderings.NestedRenderingsActivity

samples/compose-samples/src/main/java/com/squareup/sample/compose/nestedrenderings/RecursiveViewFactory.kt

@@ -80,7 +80,8 @@ val RecursiveViewFactory = composeViewFactory<Rendering> { rendering, viewEnviro
             children = listOf("bar"),
             onAddChildClicked = {}, onResetClicked = {}
           )
-        ), onAddChildClicked = {}, onResetClicked = {}
+        ),
+        onAddChildClicked = {}, onResetClicked = {}
       ),
       placeholderModifier = Modifier.fillMaxSize()
     )