Minor fixes to formatting to prepare for KtLint 1.0 #1183

TWiStErRob · 2023-12-10T16:54:34Z

Prep for Update dependency com.pinterest.ktlint:ktlint-rule-engine to v1 #1076

"Preparation" as in reduce the future PR size by applying manual intervention requiring fixes earlier and fix things that prevent spotlessApply from executing.

The changes are exhaustive, but intentionally didn't include the fix for (i.e. #1076 will fail with this error still):

> Task :paparazzi:spotlessKotlin FAILED
Step 'ktlint' found problem in 'src\main\java\app\cash\paparazzi\internal\ImageUtils.kt':
Error on line: 72, column: 9
rule: standard:property-naming
Property name should start with a lowercase letter and use camel case

because that will be fixed in ktlint 1.0.2 or 1.1.0: pinterest/ktlint#2352

…d use a single source of truth.

Step 'ktlint' found problem in 'src\main\java\app\cash\paparazzi\sample\ResourcesDemo.kt': Error on line: 31, column: 5 rule: standard:function-naming Function name should start with a lowercase letter (except factory methods) and use camel case

Step 'ktlint' found problem in 'src\main\java\app\cash\paparazzi\sample\ResourcesDemo.kt': Error on line: 27, column: 11 rule: standard:property-naming Property name should use the screaming snake case notation when the value can not be changed

Step 'ktlint' found problem in 'src\test\java\app\cash\paparazzi\sample\ComposeA11yTest.kt': Error on line: 56, column: 39 rule: standard:discouraged-comment-location A comment in a 'value_argument_list' is only allowed when placed on a separate line

Step 'ktlint' found problem in 'src\main\java\app\cash\paparazzi\internal\interceptors\MatrixMatrixMultiplicationInterceptor.kt': Error on line: 19, column: 11 rule: standard:property-naming Property name should start with a lowercase letter and use camel case

Step 'ktlint' found problem in 'src\main\java\app\cash\paparazzi\internal\resources\Pseudolocalizer.kt': Error on line: 351, column: 15 rule: standard:property-naming Property name should start with a lowercase letter and use camel case

Step 'ktlint' found problem in 'src\main\java\app\cash\paparazzi\internal\resources\RepositoryLoader.kt': Error on line: 124, column: 15 rule: standard:property-naming Property name should start with a lowercase letter and use camel case

Step 'ktlint' found problem in 'src\main\java\app\cash\paparazzi\internal\interceptors\MatrixVectorMultiplicationInterceptor.kt': Error on line: 23, column: 2 rule: standard:max-line-length Exceeded max line length (140)

Step 'ktlint' found problem in 'src\main\java\app\cash\paparazzi\internal\resources\Pseudolocalizer.kt': Error on line: 22, column: 1 rule: standard:no-consecutive-comments an EOL comment may not be preceded by a KDoc. Reversed order is allowed though when separated by a newline.

Step 'ktlint' found problem in 'src\test\java\app\cash\paparazzi\internal\resources\PseudolocaleGeneratorTest.kt': Error on line: 85, column: 1 rule: standard:max-line-length Exceeded max line length (140)

Step 'ktlint' found problem in 'src\main\java\app\cash\paparazzi\internal\interceptors\MatrixMatrixMultiplicationInterceptor.kt': Error on line: 38, column: 15 rule: standard:function-naming Function name should start with a lowercase letter (except factory methods) and use camel case

Step 'ktlint' found problem in 'src\test\projects\lifecycle-usages\src\test\java\app\cash\paparazzi\plugin\test\LifecycleUsageTest.kt': Error on line: 21, column: 13 rule: standard:function-naming Function name should start with a lowercase letter (except factory methods) and use camel case

TWiStErRob · 2023-12-10T20:52:00Z

paparazzi/src/main/java/app/cash/paparazzi/internal/resources/RepositoryLoader.kt

      handleParsingError(file, e)
    } catch (e: XmlPullParserException) {
      handleParsingError(file, e)
    } catch (e: XmlSyntaxException) {
      handleParsingError(file, e)
    } catch (e: RuntimeException) {
+      // KXmlParser throws RuntimeException for an undefined prefix and an illegal attribute name.


Note: this was originally meant for a group of 4 catches, but I guess based on the wording it belongs here.

https://android.googlesource.com/platform/tools/base/+/6c21fa43c56804ab5f4d3a3fc59b5c1158750fa6/resource-repository/main/java/com/android/resources/base/RepositoryLoader.java#545

obsoleted by suggestion to add:

ktlint_standard_discouraged-comment-location = disabled

jrodbx · 2023-12-11T04:19:16Z

paparazzi/src/main/java/app/cash/paparazzi/internal/resources/Pseudolocalizer.kt

@@ -347,9 +347,11 @@ class PseudoMethodAccent : PseudoMethodImpl() {
    return currentIndex
  }

-  // Yes, "fiveteen".
-  private val EXPANSION_STRING = "one two three four five six seven eight nine ten eleven " +
-    "twelve thirteen fourteen fiveteen sixteen seventeen nineteen twenty"


move to line 35

jrodbx · 2023-12-11T04:22:38Z

paparazzi/src/main/java/app/cash/paparazzi/internal/resources/ModuleResourceRepository.kt

@@ -43,7 +43,8 @@ internal class ModuleResourceRepository private constructor(
      resourceDirectories: List<File>
    ): LocalResourceRepository {
      return ModuleResourceRepository(
-        displayName = "", // TODO


An anti-bikeshedding Kotlin linter with built-in formatter

yea....

let's disable this rule in .editorconfig

ktlint_standard_discouraged-comment-location = disabled

btw, I tried doing this locally and came across the error mentioned here:
pinterest/ktlint#2338 (comment)

That looks to be fixed here: pinterest/ktlint#2371
but set to be released in 1.1, so I think this PR will likely hang out (or maybe we can merge some of the changes without bumping to 1.0?) since the "discouraged comment location" is more opinionated than I like.

This PR does NOT bump the ktlint version, that's the point. But I'll have to retry some of this it seems based on your feedback with the intellij style re-applied.

ok, sounds good. i can also continue work on this effort, if that's easier for you.

jrodbx · 2023-12-11T04:23:21Z

.../main/java/app/cash/paparazzi/internal/interceptors/MatrixVectorMultiplicationInterceptor.kt

    resultVec[resultVecOffset + 0] =
-      lhsMat[I(0, 0, lhsMatOffset)] * x + lhsMat[I(1, 0, lhsMatOffset)] * y + lhsMat[I(2, 0, lhsMatOffset)] * z + lhsMat[I(3, 0, lhsMatOffset)] * w


revert and add "ktlint:standard:property-naming" to @Suppress above intercept method

jrodbx · 2023-12-11T04:23:58Z

.../main/java/app/cash/paparazzi/internal/interceptors/MatrixMatrixMultiplicationInterceptor.kt

    // #define I(_i, _j) ((_j)+ 4*(_i))
-    return offset + j + 4 * i
-  }


revert all this, since you've added "ktlint:standard:property-naming" to @Suppress above intercept method?

jrodbx · 2023-12-11T04:24:21Z

paparazzi/src/main/java/app/cash/paparazzi/internal/Renderer.kt

@@ -84,7 +84,8 @@ internal class Renderer(
                val resourceDirPath = Paths.get(dir)
                AarSourceResourceRepository.create(
                  resourceDirectoryOrFile = resourceDirPath,
-                  libraryName = resourceDirPath.parent.fileName.name // segment before /res
+                  // segment before /res
+                  libraryName = resourceDirPath.parent.fileName.name


obsoleted by suggestion to add:

ktlint_standard_discouraged-comment-location = disabled

jrodbx · 2023-12-11T04:58:50Z

paparazzi/src/test/java/app/cash/paparazzi/internal/resources/PseudolocaleGeneratorTest.kt

+        assertThat(getElement(0))
+          .isEqualTo("${bidiWordStart}First$bidiWordEnd ${bidiWordStart}Test$bidiWordEnd ${bidiWordStart}String$bidiWordEnd")
+        assertThat(getElement(1))
+          .isEqualTo("${bidiWordStart}Second$bidiWordEnd ${bidiWordStart}Test$bidiWordEnd ${bidiWordStart}String$bidiWordEnd")


what changes led to these? revert?

jrodbx · 2023-12-11T04:58:57Z

sample/src/test/java/app/cash/paparazzi/sample/ResourcesTest.kt

+    Default(null),
+    Arabic("ar"),
+    Accent("en-rXA"),
+    Bidi("ar-rXB")


jrodbx · 2023-12-11T04:59:15Z

paparazzi/src/main/java/app/cash/paparazzi/internal/resources/RepositoryLoader.kt

-      attr = BasicAttrResourceItem(attr.name, attr.sourceFile, attr.visibility, attr.description, attr.groupName, DEFAULT_ATTR_FORMATS, emptyMap(), emptyMap())
+      attr = BasicAttrResourceItem(
+        attr.name, attr.sourceFile, attr.visibility, attr.description, attr.groupName, DEFAULT_ATTR_FORMATS, emptyMap(), emptyMap()
+      )


jrodbx · 2023-12-11T04:59:21Z

paparazzi/src/main/java/app/cash/paparazzi/internal/resources/RepositoryLoader.kt

      handleParsingError(file, e)
    } catch (e: XmlPullParserException) {
      handleParsingError(file, e)
    } catch (e: java.lang.RuntimeException) {
+      // KXmlParser throws RuntimeException for an undefined prefix and an illegal attribute name.


obsoleted by suggestion to add:

ktlint_standard_discouraged-comment-location = disabled

jrodbx · 2023-12-11T04:59:27Z

paparazzi/src/main/java/app/cash/paparazzi/internal/resources/RepositoryLoader.kt

      handleParsingError(file, e)
    } catch (e: XmlPullParserException) {
      handleParsingError(file, e)
    } catch (e: XmlSyntaxException) {
      handleParsingError(file, e)
    } catch (e: RuntimeException) {
+      // KXmlParser throws RuntimeException for an undefined prefix and an illegal attribute name.


obsoleted by suggestion to add:

ktlint_standard_discouraged-comment-location = disabled

jrodbx · 2024-01-09T21:04:53Z

Applied suggested feedback, manually squashed and pushed. Thanks!

TWiStErRob added 15 commits December 10, 2023 16:46

Sync up spotless.kotlin.ktlint config overrides with .editorconfig an…

9c14f18

…d use a single source of truth.

Help IDEA indent correctly when user has tabs enabled.

06d4137

> Task :sample:spotlessKotlin FAILED

3d27a62

Step 'ktlint' found problem in 'src\main\java\app\cash\paparazzi\sample\ResourcesDemo.kt': Error on line: 31, column: 5 rule: standard:function-naming Function name should start with a lowercase letter (except factory methods) and use camel case

> Task :sample:spotlessKotlin FAILED

704857d

Step 'ktlint' found problem in 'src\main\java\app\cash\paparazzi\sample\ResourcesDemo.kt': Error on line: 27, column: 11 rule: standard:property-naming Property name should use the screaming snake case notation when the value can not be changed

> Task :paparazzi:spotlessKotlin FAILED

e4ce6f0

Step 'ktlint' found problem in 'src\main\java\app\cash\paparazzi\internal\resources\Pseudolocalizer.kt': Error on line: 351, column: 15 rule: standard:property-naming Property name should start with a lowercase letter and use camel case

> Task :paparazzi:spotlessKotlin FAILED

75f002a

Step 'ktlint' found problem in 'src\main\java\app\cash\paparazzi\internal\resources\RepositoryLoader.kt': Error on line: 124, column: 15 rule: standard:property-naming Property name should start with a lowercase letter and use camel case

> Task :paparazzi:spotlessKotlin FAILED

46fabf2

Step 'ktlint' found problem in 'src\main\java\app\cash\paparazzi\internal\interceptors\MatrixVectorMultiplicationInterceptor.kt': Error on line: 23, column: 2 rule: standard:max-line-length Exceeded max line length (140)

> Task :paparazzi:spotlessKotlin FAILED

7cc86a8

Step 'ktlint' found problem in 'src\test\java\app\cash\paparazzi\internal\resources\PseudolocaleGeneratorTest.kt': Error on line: 85, column: 1 rule: standard:max-line-length Exceeded max line length (140)

Move comment to relevant block to prevent pinterest/ktlint#2427

408a90d

partial gradlew spotlessApply

6025f33

TWiStErRob mentioned this pull request Dec 10, 2023

Update dependency com.pinterest.ktlint:ktlint-rule-engine to v1 #1076

Closed

1 task

TWiStErRob commented Dec 10, 2023

View reviewed changes

jrodbx reviewed Dec 11, 2023

View reviewed changes

jrodbx closed this Jan 9, 2024

TWiStErRob deleted the ktlint-prep branch January 9, 2024 22:44

TWiStErRob mentioned this pull request May 5, 2024

Upgrade ktlint 0.50.0 to 1.2.1 #1409

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Minor fixes to formatting to prepare for KtLint 1.0 #1183

Minor fixes to formatting to prepare for KtLint 1.0 #1183

TWiStErRob commented Dec 10, 2023

TWiStErRob Dec 10, 2023

jrodbx Dec 11, 2023

jrodbx Dec 11, 2023

jrodbx Dec 11, 2023

jrodbx Dec 11, 2023

TWiStErRob Dec 11, 2023

jrodbx Dec 11, 2023

jrodbx Dec 11, 2023

jrodbx Dec 11, 2023

jrodbx Dec 11, 2023

jrodbx Dec 11, 2023

jrodbx Dec 11, 2023

jrodbx Dec 11, 2023

jrodbx Dec 11, 2023

jrodbx Dec 11, 2023

jrodbx commented Jan 9, 2024

		resultVec[resultVecOffset + 0] =
		lhsMat[I(0, 0, lhsMatOffset)] * x + lhsMat[I(1, 0, lhsMatOffset)] * y + lhsMat[I(2, 0, lhsMatOffset)] * z + lhsMat[I(3, 0, lhsMatOffset)] * w

Minor fixes to formatting to prepare for KtLint 1.0 #1183

Minor fixes to formatting to prepare for KtLint 1.0 #1183

Conversation

TWiStErRob commented Dec 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jrodbx commented Jan 9, 2024