Introduce `TypeMemberOrder` check by benhalasi · Pull Request #636 · PicnicSupermarket/error-prone-support

benhalasi · 2023-05-18T08:31:49Z

Suggested commit message

Introduce `TypeMemberOrder` check (#636)

github-actions · 2023-05-18T08:51:36Z

Surviving mutants in this change: 23
Killed mutants in this change: 63

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	23	63

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

benhalasi · 2023-05-18T17:08:00Z

Verifying that the whitespace is untouched maybe a bit harder than I thought because TestMode.TEXT_MATCH formats both input and output.

I looked into doTest and TestMode and it doesn't seem too hard to just implement a new one that doesn't format, but I'll wait for some input before getting into it.

Indentation of replaced code might cause some challenge.

github-actions · 2023-05-18T18:06:10Z

Surviving mutants in this change: 11
Killed mutants in this change: 61

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	11	61

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2023-05-24T13:02:35Z

Surviving mutants in this change: 11
Killed mutants in this change: 61

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	11	61

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

rickie

There were some imports from ASTHelpers that we usually do not statically import :).

Added a commit! The setup looks nice, didn't get till the end, but already flushing my comments 😄.

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MemberOrdering.java

github-actions · 2023-05-25T11:34:05Z

Surviving mutants in this change: 11
Killed mutants in this change: 61

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	11	61

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MemberOrdering.java

rickie · 2023-05-25T11:41:44Z

(Okay apparently I had to rebuild, the test locally passed 😄, will take a look).

I didn't test if MemberOrdering respects annotations, I assumed annotations are part of the member Tree.

@benhalasi I would add a testcase with an annotation in that case 😉 .

I'm not sure how to approach verifying that this checker doesn't mess with whitespaces - as it's hard to test something it shouldn't do - I'm leaning towards to have a separate test method that has all the whitespace cases we want to test, which I'd need input on - and have the other cases properly formatted.

When using the suppression for ErrorProneTestHelperSourceFormat it should be fine to test the whitespaces right?

sonarqubecloud · 2023-05-25T11:49:20Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
3 Code Smells

91.5% Coverage
0.0% Duplication

github-actions · 2023-05-25T11:50:06Z

Surviving mutants in this change: 11
Killed mutants in this change: 61

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	11	61

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

rickie · 2023-05-25T11:51:17Z

I reverted the commit as I'd need some more time to properly fix this. I'm wondering however, maybe we should use a different method altogether. In the SourceCode file and in our recently moved StringLocaleUsage check (see here), we have examples of going over the ErrorProneTokens.getTokens. Maybe we should use that to get "the full Tree" that we need to replace. I'm not sure which direction is currently the best way to go in.

github-actions · 2023-07-08T17:54:33Z

Surviving mutants in this change: 11
Killed mutants in this change: 61

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	11	61

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2023-07-09T10:33:04Z

Surviving mutants in this change: 10
Killed mutants in this change: 51

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	10	49
🎉`tech.picnic.errorprone.bugpatterns.MemberOrdering$MemberWithComments`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2023-07-10T06:34:30Z

Surviving mutants in this change: 10
Killed mutants in this change: 51

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	10	49
🎉`tech.picnic.errorprone.bugpatterns.MemberOrdering$MemberWithComments`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MemberOrdering.java

github-actions · 2023-07-24T13:02:41Z

Surviving mutants in this change: 4
Killed mutants in this change: 44

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	4	42
🎉`tech.picnic.errorprone.bugpatterns.MemberOrdering$ClassMemberWithComments`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

oxkitsune · 2023-07-24T13:02:49Z

ErrorProneTokens#getTokens(String, Context) doesn't include comments as it relies on the start position of the provided member (e.g., the position of void). Comments don't count as tokens but do affect token positions.

To include comments, we can use VisitorState#getOffsetTokens(int, int) to obtain tokens in a specific range. By starting the range at the end position of the previous token and ending it at the end of the current member, we'll obtain the same tokens, now including comments in the resulting ErrorProneToken.

github-actions · 2023-07-24T13:10:10Z

Surviving mutants in this change: 4
Killed mutants in this change: 44

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	4	42
🎉`tech.picnic.errorprone.bugpatterns.MemberOrdering$ClassMemberWithComments`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2023-07-25T08:19:50Z

Surviving mutants in this change: 4
Killed mutants in this change: 44

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	4	42
🎉`tech.picnic.errorprone.bugpatterns.MemberOrdering$ClassMemberWithComments`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2023-07-25T15:23:57Z

Surviving mutants in this change: 5
Killed mutants in this change: 50

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	5	48
🎉`tech.picnic.errorprone.bugpatterns.MemberOrdering$ClassMemberWithComments`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

benhalasi · 2023-07-25T15:24:37Z

Thanks oxkitsune for the ErrorProneTokens#getTokens(String, Context)!

Apart from the minor questions below, the only big thing to tackle is verifying that this checker reserves whitespaces or deciding that we don't verify it.

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MemberOrdering.java

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

Error Prone

[Error Prone] _{reported by reviewdog 🐶}

error-prone-support/error-prone-experimental/src/test/java/tech/picnic/errorprone/experimental/bugpatterns/BlockStartWhitespaceTest.java

Line 142 in 580fac0

" return 1;",

github-actions · 2025-06-24T18:09:56Z

Surviving mutants in this change: 17
Killed mutants in this change: 102

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	10	82
🧟`tech.picnic.errorprone.utils.MoreASTHelpers`	5	0
🧟`tech.picnic.errorprone.experimental.bugpatterns.BlockStartWhitespace`	2	18
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Arcmutate licence valid until 2025-10-27 (yyyy/mm/dd) (non-commercial use only)

github-actions · 2025-06-25T06:53:29Z

Surviving mutants in this change: 16
Killed mutants in this change: 101

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	10	82
🧟`tech.picnic.errorprone.utils.MoreASTHelpers`	5	0
🧟`tech.picnic.errorprone.experimental.bugpatterns.BlockStartWhitespace`	1	17
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Arcmutate licence valid until 2025-10-27 (yyyy/mm/dd) (non-commercial use only)

github-actions · 2025-06-25T07:03:23Z

Surviving mutants in this change: 11
Killed mutants in this change: 101

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	10	82
🧟`tech.picnic.errorprone.experimental.bugpatterns.BlockStartWhitespace`	1	17
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Arcmutate licence valid until 2025-10-27 (yyyy/mm/dd) (non-commercial use only)

sonarqubecloud · 2025-06-25T07:11:37Z

Quality Gate passed

Issues
10 New issues
0 Accepted issues

Measures
0 Security Hotspots
95.1% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2025-06-25T07:11:42Z

Surviving mutants in this change: 12
Killed mutants in this change: 102

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	11	83
🧟`tech.picnic.errorprone.experimental.bugpatterns.BlockStartWhitespace`	1	17
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Arcmutate licence valid until 2025-10-27 (yyyy/mm/dd) (non-commercial use only)

sonarqubecloud · 2025-10-02T06:43:56Z

Quality Gate passed

Issues
9 New issues
0 Accepted issues

Measures
0 Security Hotspots
94.4% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2025-10-02T06:44:06Z

Surviving mutants in this change: 13
Killed mutants in this change: 109

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	10	87
🧟`tech.picnic.errorprone.experimental.bugpatterns.BlockStartWhitespace`	3	20
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Arcmutate licence valid until 2025-10-27 (yyyy/mm/dd) (non-commercial use only)

github-actions · 2025-11-07T07:10:25Z

Surviving mutants in this change: 13
Killed mutants in this change: 109

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	10	87
🧟`tech.picnic.errorprone.experimental.bugpatterns.BlockStartWhitespace`	3	20
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)

github-actions · 2025-11-07T07:11:18Z

Surviving mutants in this change: 13
Killed mutants in this change: 109

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	10	87
🧟`tech.picnic.errorprone.experimental.bugpatterns.BlockStartWhitespace`	3	20
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)

github-actions · 2025-11-07T07:32:28Z

Surviving mutants in this change: 11
Killed mutants in this change: 109

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	8	87
🧟`tech.picnic.errorprone.experimental.bugpatterns.BlockStartWhitespace`	3	20
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)

github-actions · 2025-11-07T08:06:23Z

Surviving mutants in this change: 11
Killed mutants in this change: 109

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	8	87
🧟`tech.picnic.errorprone.experimental.bugpatterns.BlockStartWhitespace`	3	20
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)

github-actions · 2025-11-07T08:21:50Z

Surviving mutants in this change: 11
Killed mutants in this change: 109

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	8	87
🧟`tech.picnic.errorprone.experimental.bugpatterns.BlockStartWhitespace`	3	20
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)

rickie · 2025-11-11T07:34:56Z

/integration-test

github-actions · 2025-11-11T07:37:22Z

Surviving mutants in this change: 11
Killed mutants in this change: 109

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	8	87
🧟`tech.picnic.errorprone.experimental.bugpatterns.BlockStartWhitespace`	3	20
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)

sonarqubecloud · 2025-11-11T10:11:15Z

Quality Gate passed

Issues
5 New issues
0 Accepted issues

Measures
0 Security Hotspots
96.2% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2025-11-11T10:11:25Z

Surviving mutants in this change: 11
Killed mutants in this change: 109

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	8	87
🧟`tech.picnic.errorprone.experimental.bugpatterns.BlockStartWhitespace`	3	20
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)

github-actions · 2025-11-11T10:11:50Z

.../src/test/java/tech/picnic/errorprone/experimental/bugpatterns/BlockStartWhitespaceTest.java

+  @Test
+  void handlesCommentsOddCommentsContainingLBraces() {
+    BugCheckerRefactoringTestHelper.newInstance(BlockStartWhitespace.class, getClass())
+        .addInputLines(


[javac] _{reported by reviewdog 🐶}
[ErrorProneTestHelperSourceFormat] Test code should follow the Google Java style

github-actions · 2025-11-11T10:14:05Z

.../src/test/java/tech/picnic/errorprone/experimental/bugpatterns/BlockStartWhitespaceTest.java

+  void handlesCommentsOddCommentsContainingLBraces() {
+    BugCheckerRefactoringTestHelper.newInstance(BlockStartWhitespace.class, getClass())
+        .addInputLines(
+            "A.java", "class A /* { */", "", "{", "", "  private static final int foo = 1;", "}")


[Error Prone] _{reported by reviewdog 🐶}

Suggested change

"A.java", "class A /* { */", "", "{", "", " private static final int foo = 1;", "}")

"A.java", "class A /* { */ {", "", " private static final int foo = 1;", "}")

This comment was marked as outdated.

Sign in to view

benhalasi force-pushed the benhalasi/sort-members-constructors-methods branch from 00eebf3 to ebb9041 Compare May 18, 2023 08:48

benhalasi linked an issue May 18, 2023 that may be closed by this pull request

Sort member variables, constructors, and methods #595

Open

3 tasks

rickie self-requested a review May 23, 2023 14:51

benhalasi force-pushed the benhalasi/sort-members-constructors-methods branch from ca7ada8 to 11816d9 Compare May 24, 2023 12:59

rickie reviewed May 25, 2023

View reviewed changes

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MemberOrdering.java Outdated Show resolved Hide resolved

benhalasi force-pushed the benhalasi/sort-members-constructors-methods branch from 2fcedcd to 291a517 Compare July 8, 2023 17:52

oxkitsune reviewed Jul 24, 2023

View reviewed changes

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MemberOrdering.java Outdated Show resolved Hide resolved

benhalasi force-pushed the benhalasi/sort-members-constructors-methods branch from ee2cb5e to b0a23ba Compare July 25, 2023 08:17

benhalasi self-assigned this Jul 25, 2023

benhalasi commented Jul 25, 2023

View reviewed changes

github-actions bot reviewed Jun 24, 2025

View reviewed changes

benhalasi and others added 6 commits November 7, 2025 08:08

Introduce TypeMemberOrder check

b5c79c1

Introduce Whitespace check

adccacc

Apply EPS suggestions

d94d027

Pair review

c15e725

Pair review 2

a53d710

Pair review 3

1b6726c

Tweaks

3f572cf

Format

0575f7b

Fix the dependencies

cf261e2

Small tweaks

337bf25

Small tweaks

d8d4a5f

github-actions bot reviewed Nov 11, 2025

View reviewed changes

	"A.java", "class A /* { */", "", "{", "", " private static final int foo = 1;", "}")
	"A.java", "class A /* { */ {", "", " private static final int foo = 1;", "}")

Conversation

benhalasi commented May 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Suggested commit message

Uh oh!

This comment was marked as outdated.

github-actions bot commented May 18, 2023

Uh oh!

benhalasi commented May 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 18, 2023

Uh oh!

github-actions bot commented May 24, 2023

Uh oh!

rickie left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented May 25, 2023

Uh oh!

Uh oh!

rickie commented May 25, 2023

Uh oh!

sonarqubecloud bot commented May 25, 2023

Uh oh!

github-actions bot commented May 25, 2023

Uh oh!

rickie commented May 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 8, 2023

Uh oh!

github-actions bot commented Jul 9, 2023

Uh oh!

github-actions bot commented Jul 10, 2023

Uh oh!

Uh oh!

github-actions bot commented Jul 24, 2023

Uh oh!

oxkitsune commented Jul 24, 2023

Uh oh!

github-actions bot commented Jul 24, 2023

Uh oh!

github-actions bot commented Jul 25, 2023

Uh oh!

github-actions bot commented Jul 25, 2023

Uh oh!

benhalasi commented Jul 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 24, 2025

Uh oh!

github-actions bot commented Jun 25, 2025

Uh oh!

github-actions bot commented Jun 25, 2025

Uh oh!

sonarqubecloud bot commented Jun 25, 2025

Quality Gate passed

Uh oh!

github-actions bot commented Jun 25, 2025

Uh oh!

sonarqubecloud bot commented Oct 2, 2025

Quality Gate passed

Uh oh!

github-actions bot commented Oct 2, 2025

Uh oh!

github-actions bot commented Nov 7, 2025

Uh oh!

benhalasi commented May 18, 2023 •

edited

Loading

benhalasi commented May 18, 2023 •

edited

Loading

rickie left a comment •

edited

Loading

rickie commented May 25, 2023 •

edited

Loading

benhalasi commented Jul 25, 2023 •

edited

Loading