Suitable formatter for Ebean

[soda-salie]

Hello!

I have tried different formatters for Java, not only regarding Ebean, but in general

Each of them had flaws with respect to some things, settled on Palantir, a fork of Google java format

He was the lesser of the evils, in general I like how he formats, another thing is that he formats the ORM Query in Ebean randomly, it's unreadable

And this applies to any formatter, not just Palantir

I have made several patches in the formatter regarding Ebean

Now instead of:

public Page<Post> pageByUserIdWithAccessCheck(
        long userId, Paging paging, boolean withModeration, long currentUserId) {
    var P = QPost.alias();
    return Pages.toPage(new QPost()
            .select(findByUserIdFetchGroup)
            .reactionsCount
            .fetchQuery()
            .reactionsCount
            .filterMany(q -> q.reactionType
                    .in(ReactionType.LIKE_REACTION, ReactionType.DISLIKE_REACTION)
                    .count
                    .gt(0))
            .commentCount
            .fetchQuery()
            .commentCount
            .filterMany(q -> q.reactionType.eq(ReactionType.COMMENT))
            .repostCount
            .fetchQuery()
            .repostCount
            .filterMany(q -> q.reactionType.eq(ReactionType.REPOST))
            .myReaction
            .fetchQuery()
            .myReaction
            .filterMany(q -> q.user.id.eq(currentUserId))
            .or()
            .user
            .id
            .eq(userId)
            .and()
            .postCoAuthors
            .author
            .id
            .eq(userId)
            .postCoAuthors
            .isConfirmed
            .isTrue()
            .endAnd()
            .endOr()
            .postToMedia
            .isNotEmpty()
            .alsoIf(() -> withModeration, q -> q.raw(withModeration()))
            .or()
            .user
            .id
            .eq(currentUserId)
            .and()
            .user
            .id
            .ne(currentUserId)
            .user
            .isPrivate
            .isFalse()
            .exists(new QRelationship()
                    .select("id")
                    .user
                    .id
                    .eq(P.user.id)
                    .friend
                    .id
                    .eq(currentUserId)
                    .status
                    .in(RelationStatusType.FRIENDS)
                    .query())
            .endAnd()
            .endOr()
            .setPaging(paging)
            .createdAt
            .desc()
            .findPagedList());
}

It formats like this

public Page<Post> pageByUserIdWithAccessCheck(
    long userId, Paging paging, boolean withModeration, long currentUserId) {
  var P = QPost.alias();
  return Pages.toPage(new QPost()
      .select(findByUserIdFetchGroup)
      .reactionsCount.fetchQuery()
      .reactionsCount.filterMany(
          q -> q.reactionType.in(ReactionType.LIKE_REACTION, ReactionType.DISLIKE_REACTION).count.gt(0))
      .commentCount.fetchQuery()
      .commentCount.filterMany(q -> q.reactionType.eq(ReactionType.COMMENT))
      .repostCount.fetchQuery()
      .repostCount.filterMany(q -> q.reactionType.eq(ReactionType.REPOST))
      .myReaction.fetchQuery()
      .myReaction.filterMany(q -> q.user.id.eq(currentUserId))
      .or()
          .user.id.eq(userId)
          .and()
              .postCoAuthors.author.id.eq(userId)
              .postCoAuthors.isConfirmed.isTrue()
          .endAnd()
      .endOr()
      .postToMedia.isNotEmpty()
      .alsoIf(() -> withModeration, q -> q.raw(withModeration()))
      .or()
          .user.id.eq(currentUserId)
          .and()
              .user.id.ne(currentUserId)
              .user.isPrivate.isFalse()
              .exists(new QRelationship()
                  .select("id")
                  .user.id.eq(P.user.id)
                  .friend.id.eq(currentUserId)
                  .status.in(RelationStatusType.FRIENDS)
                  .query())
          .endAnd()
      .endOr()
      .setPaging(paging)
      .createdAt.desc()
      .findPagedList());
}

I'm still too lazy to make a separate repo, I would throw the whole garbage out of this project and leave only the plugin

So far, I'm just attaching a plugin file that can be uploaded to Intellij IDEA

I just want to share my best practices, I don't know if this has been done before me, I didn't find anything in the discussions and google group

Although I see beautifully formatted examples in the documentation, obviously I'm not the only one struggling with this)

I'm relatively new to Ebean, I really like this ORM, so I'm wondering what else can be improved in this regard, I'll be glad for advice)

palantir-java-format-59e4fcf.zip

[jnehlmeier]

The new formatting looks great! I usually format by hand and then wrap the code with some // @formatter:off and // @formatter:on markers so that a formatter does not destroy my format.

However, I have to say with all the recent supply chain attacks (e.g. Shai-Hulud NPM worm, GlassWorm via VSCode plugins and it seems also via some Github repos) I would never install a random upload as IDE plugin as it can do anything on my host. I think you really need a repo/fork so code changes can be seen/verified and the project can be built locally.

[soda-salie]

https://github.com/soda-salie/palantir-java-formatter

[soda-salie]

./gradlew :idea-plugin:spotlessApply
./gradlew :idea-plugin:build

[soda-salie]

branch feature/chains-improvement