Add Ktlint Step into GitHub Actions

.editorconfig

@@ -0,0 +1,132 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+max_line_length = 140
+tab_width = 4
+trim_trailing_whitespace = true
+ij_continuation_indent_size = 8
+ij_formatter_off_tag = @formatter:off
+ij_formatter_on_tag = @formatter:on
+ij_formatter_tags_enabled = false
+ij_smart_tabs = false
+ij_visual_guides = none
+ij_wrap_on_typing = false
+
+[{*.kt,*.kts}]
+disabled_rules = import-ordering
+ij_kotlin_align_in_columns_case_branch = false
+ij_kotlin_align_multiline_binary_operation = false
+ij_kotlin_align_multiline_extends_list = false
+ij_kotlin_align_multiline_method_parentheses = false
+ij_kotlin_align_multiline_parameters = true
+ij_kotlin_align_multiline_parameters_in_calls = false
+ij_kotlin_allow_trailing_comma = false
+ij_kotlin_allow_trailing_comma_on_call_site = false
+ij_kotlin_assignment_wrap = normal
+ij_kotlin_blank_lines_after_class_header = 0
+ij_kotlin_blank_lines_around_block_when_branches = 0
+ij_kotlin_blank_lines_before_declaration_with_comment_or_annotation_on_separate_line = 1
+ij_kotlin_block_comment_at_first_column = true
+ij_kotlin_call_parameters_new_line_after_left_paren = true
+ij_kotlin_call_parameters_right_paren_on_new_line = true
+ij_kotlin_call_parameters_wrap = on_every_item
+ij_kotlin_catch_on_new_line = false
+ij_kotlin_class_annotation_wrap = split_into_lines
+ij_kotlin_code_style_defaults = KOTLIN_OFFICIAL
+ij_kotlin_continuation_indent_for_chained_calls = false
+ij_kotlin_continuation_indent_for_expression_bodies = false
+ij_kotlin_continuation_indent_in_argument_lists = false
+ij_kotlin_continuation_indent_in_elvis = false
+ij_kotlin_continuation_indent_in_if_conditions = false
+ij_kotlin_continuation_indent_in_parameter_lists = false
+ij_kotlin_continuation_indent_in_supertype_lists = false
+ij_kotlin_else_on_new_line = false
+ij_kotlin_enum_constants_wrap = off
+ij_kotlin_extends_list_wrap = normal
+ij_kotlin_field_annotation_wrap = split_into_lines
+ij_kotlin_finally_on_new_line = false
+ij_kotlin_if_rparen_on_new_line = true
+ij_kotlin_import_nested_classes = false
+ij_kotlin_imports_layout = *,java.**,javax.**,kotlin.**,^
+ij_kotlin_insert_whitespaces_in_simple_one_line_method = true
+ij_kotlin_keep_blank_lines_before_right_brace = 2
+ij_kotlin_keep_blank_lines_in_code = 2
+ij_kotlin_keep_blank_lines_in_declarations = 2
+ij_kotlin_keep_first_column_comment = true
+ij_kotlin_keep_indents_on_empty_lines = false
+ij_kotlin_keep_line_breaks = true
+ij_kotlin_lbrace_on_next_line = false
+ij_kotlin_line_comment_add_space = false
+ij_kotlin_line_comment_at_first_column = true
+ij_kotlin_method_annotation_wrap = split_into_lines
+ij_kotlin_method_call_chain_wrap = normal
+ij_kotlin_method_parameters_new_line_after_left_paren = true
+ij_kotlin_method_parameters_right_paren_on_new_line = true
+ij_kotlin_method_parameters_wrap = on_every_item
+ij_kotlin_name_count_to_use_star_import = 2147483647
+ij_kotlin_name_count_to_use_star_import_for_members = 2147483647
+ij_kotlin_packages_to_use_import_on_demand = java.util.*,io.ktor.**
+ij_kotlin_parameter_annotation_wrap = off
+ij_kotlin_space_after_comma = true
+ij_kotlin_space_after_extend_colon = true
+ij_kotlin_space_after_type_colon = true
+ij_kotlin_space_before_catch_parentheses = true
+ij_kotlin_space_before_comma = false
+ij_kotlin_space_before_extend_colon = true
+ij_kotlin_space_before_for_parentheses = true
+ij_kotlin_space_before_if_parentheses = true
+ij_kotlin_space_before_lambda_arrow = true
+ij_kotlin_space_before_type_colon = false
+ij_kotlin_space_before_when_parentheses = true
+ij_kotlin_space_before_while_parentheses = true
+ij_kotlin_spaces_around_additive_operators = true
+ij_kotlin_spaces_around_assignment_operators = true
+ij_kotlin_spaces_around_equality_operators = true
+ij_kotlin_spaces_around_function_type_arrow = true
+ij_kotlin_spaces_around_logical_operators = true
+ij_kotlin_spaces_around_multiplicative_operators = true
+ij_kotlin_spaces_around_range = false
+ij_kotlin_spaces_around_relational_operators = true
+ij_kotlin_spaces_around_unary_operator = false
+ij_kotlin_spaces_around_when_arrow = true
+ij_kotlin_variable_annotation_wrap = off
+ij_kotlin_while_on_new_line = false
+ij_kotlin_wrap_elvis_expressions = 1
+ij_kotlin_wrap_expression_body_functions = 1
+ij_kotlin_wrap_first_method_in_call_chain = false
+
+[**/test/**.kt]
+max_line_length = off
+
+[{*.markdown,*.md}]
+trim_trailing_whitespace = false
+max_line_length = off
+ij_markdown_force_one_space_after_blockquote_symbol = true
+ij_markdown_force_one_space_after_header_symbol = true
+ij_markdown_force_one_space_after_list_bullet = true
+ij_markdown_force_one_space_between_words = true
+ij_markdown_keep_indents_on_empty_lines = false
+ij_markdown_max_lines_around_block_elements = 1
+ij_markdown_max_lines_around_header = 1
+ij_markdown_max_lines_between_paragraphs = 1
+ij_markdown_min_lines_around_block_elements = 1
+ij_markdown_min_lines_around_header = 1
+ij_markdown_min_lines_between_paragraphs = 1
+
+[{*.yaml,*.yml}]
+indent_size = 2
+ij_yaml_align_values_properties = do_not_align
+ij_yaml_autoinsert_sequence_marker = true
+ij_yaml_block_mapping_on_new_line = false
+ij_yaml_indent_sequence_value = true
+ij_yaml_keep_indents_on_empty_lines = false
+ij_yaml_keep_line_breaks = true
+ij_yaml_sequence_on_new_line = false
+ij_yaml_space_before_colon = false
+ij_yaml_spaces_within_braces = true
+ij_yaml_spaces_within_brackets = true

.github/workflows/build.yml

@@ -19,6 +19,8 @@ jobs:
  java-version: '11'
  - name: Run tests
  run: ./gradlew test
+ - name: Run Ktlint check
+ run: ./gradlew ktCh --continue
  - name: Upload test results
  uses: actions/upload-artifact@v3.1.0
  if: always()

build.gradle.kts

@@ -6,8 +6,9 @@ plugins {
  * but it is not working as expected in Quarkus atm. See:
  * https://quarkusio.zulipchat.com/#narrow/stream/187030-users/topic/kotlin.2Eplugin.2Enoarg/near/245461656
  */
- kotlin( "plugin.jpa") version "1.4.32"
+ kotlin("plugin.jpa") version "1.4.32"
  id("io.quarkus")
+ id("org.jlleitschuh.gradle.ktlint") version "11.0.0"
 }
 
 repositories {
@@ -18,10 +19,9 @@ repositories {
 val quarkusPlatformGroupId: String by project
 val quarkusPlatformArtifactId: String by project
 val quarkusPlatformVersion: String by project
-val ktlint: Configuration by configurations.creating
 
 dependencies {
- implementation(enforcedPlatform("${quarkusPlatformGroupId}:${quarkusPlatformArtifactId}:${quarkusPlatformVersion}"))
+ implementation(enforcedPlatform("$quarkusPlatformGroupId:$quarkusPlatformArtifactId:$quarkusPlatformVersion"))
  implementation("io.quarkus:quarkus-kotlin")
  implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
  implementation("io.quarkus:quarkus-hibernate-orm-panache-kotlin")
@@ -39,37 +39,11 @@ dependencies {
  testImplementation("io.rest-assured:rest-assured")
  testImplementation("org.mockito.kotlin:mockito-kotlin:3.2.0")
  testImplementation("nl.jqno.equalsverifier:equalsverifier:3.5")
-
- ktlint("com.pinterest:ktlint:0.41.0") {
- attributes {
- attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling.EXTERNAL))
- }
- }
 }
 
 /** Kotlin linter settings ************************/
-
-val outputDir = "${project.buildDir}/reports/ktlint/"
-val inputFiles = project.fileTree(mapOf("dir" to "src", "include" to "**/*.kt"))
-
-val ktlintCheck by tasks.creating(JavaExec::class) {
- inputs.files(inputFiles)
- outputs.dir(outputDir)
-
- description = "Check Kotlin code style."
- classpath = ktlint
- main = "com.pinterest.ktlint.Main"
- args = listOf("src/**/*.kt")
-}
-
-val ktlintFormat by tasks.creating(JavaExec::class) {
- inputs.files(inputFiles)
- outputs.dir(outputDir)
-
- description = "Fix Kotlin code style deviations."
- classpath = ktlint
- main = "com.pinterest.ktlint.Main"
- args = listOf("-F", "src/**/*.kt")
+ktlint {
+ verbose.set(true)
 }
 
 group = "io.realworld"

src/main/kotlin/io/realworld/domain/article/Article.kt

@@ -12,12 +12,18 @@ import org.hibernate.annotations.OnDelete
 import org.hibernate.annotations.OnDeleteAction.CASCADE
 import java.time.Instant
 import java.time.Instant.now
-import java.util.*
+import java.util.UUID
 import java.util.UUID.randomUUID
-import javax.persistence.*
+import javax.persistence.Entity
 import javax.persistence.CascadeType.PERSIST
 import javax.persistence.CascadeType.REMOVE
+import javax.persistence.Column
 import javax.persistence.FetchType.EAGER
+import javax.persistence.Id
+import javax.persistence.JoinTable
+import javax.persistence.ManyToMany
+import javax.persistence.ManyToOne
+import javax.persistence.OneToMany
 import javax.validation.constraints.NotBlank
 import javax.validation.constraints.PastOrPresent
 import javax.validation.constraints.Size

src/main/kotlin/io/realworld/domain/article/ArticleCreateRequest.kt

@@ -5,7 +5,7 @@ import com.fasterxml.jackson.annotation.JsonRootName
 import io.quarkus.runtime.annotations.RegisterForReflection
 import io.realworld.domain.tag.Tag
 import io.realworld.domain.user.User
-import java.util.*
+import java.util.UUID
 import java.util.UUID.randomUUID
 
 @JsonRootName("article")

src/main/kotlin/io/realworld/domain/article/ArticleRepository.kt

@@ -7,8 +7,10 @@ import io.quarkus.panache.common.Sort
 import io.realworld.infrastructure.database.Tables.ARTICLE_TABLE
 import io.realworld.infrastructure.database.Tables.FOLLOW_RELATIONSHIP
 import io.realworld.utils.QueryBuilder
-import io.realworld.utils.QueryBuilder.*
-import java.util.*
+import io.realworld.utils.QueryBuilder.JOIN
+import io.realworld.utils.QueryBuilder.SELECT
+import io.realworld.utils.QueryBuilder.WHERE
+import java.util.UUID
 import javax.enterprise.context.ApplicationScoped
 
 @ApplicationScoped
@@ -54,18 +56,15 @@ class ArticleRepository : PanacheRepositoryBase<Article, UUID> {
  offset: Int = 0,
  userId: String,
  ): List<Article> = run {
+ val usernames = QueryBuilder().add(
+ SELECT("follows.id.followingId from $FOLLOW_RELATIONSHIP follows"),
+ WHERE("follows.id.userId = :loggedInUserId")
+ )
  find(
  query = QueryBuilder().add(
  SELECT("articles from $ARTICLE_TABLE as articles"),
  JOIN("articles.author as authors"),
- WHERE(
- "authors.username in ( ${
- QueryBuilder().add(
- SELECT("follows.id.followingId from $FOLLOW_RELATIONSHIP follows"),
- WHERE("follows.id.userId = :loggedInUserId")
- )
- } )"
- )
+ WHERE("authors.username in ( $usernames )")
  ).build(),
  sort = Sort
  .descending("createdAt")

src/main/kotlin/io/realworld/domain/article/ArticleResource.kt

@@ -7,13 +7,22 @@ import io.realworld.infrastructure.security.Role.USER
 import io.realworld.infrastructure.web.NoJsonRootWrap
 import io.realworld.infrastructure.web.Routes.ARTICLES_PATH
 import io.realworld.utils.ValidationMessages.Companion.REQUEST_BODY_MUST_NOT_BE_NULL
-import java.util.*
+import java.util.UUID
 import javax.annotation.security.PermitAll
 import javax.annotation.security.RolesAllowed
 import javax.transaction.Transactional
 import javax.validation.Valid
 import javax.validation.constraints.NotNull
-import javax.ws.rs.*
+import javax.ws.rs.Consumes
+import javax.ws.rs.DELETE
+import javax.ws.rs.DefaultValue
+import javax.ws.rs.GET
+import javax.ws.rs.POST
+import javax.ws.rs.PUT
+import javax.ws.rs.Path
+import javax.ws.rs.PathParam
+import javax.ws.rs.Produces
+import javax.ws.rs.QueryParam
 import javax.ws.rs.core.Context
 import javax.ws.rs.core.MediaType.APPLICATION_JSON
 import javax.ws.rs.core.Response

src/main/kotlin/io/realworld/domain/article/ArticleService.kt

@@ -2,7 +2,7 @@ package io.realworld.domain.article
 
 import io.realworld.domain.exception.ArticleNotFoundException
 import io.realworld.domain.profile.FollowRelationshipRepository
-import java.util.*
+import java.util.UUID
 import javax.enterprise.context.ApplicationScoped
 import javax.transaction.Transactional
 

src/main/kotlin/io/realworld/domain/article/ArticleUpdateRequest.kt

@@ -4,7 +4,7 @@ import com.fasterxml.jackson.annotation.JsonProperty
 import com.fasterxml.jackson.annotation.JsonRootName
 import io.quarkus.runtime.annotations.RegisterForReflection
 import io.realworld.domain.tag.Tag
-import java.util.*
+import java.util.UUID
 
 @JsonRootName("article")
 @RegisterForReflection

src/main/kotlin/io/realworld/domain/article/FavoriteRelationshipKey.kt

@@ -2,7 +2,7 @@ package io.realworld.domain.article
 
 import io.quarkus.runtime.annotations.RegisterForReflection
 import java.io.Serializable
-import java.util.*
+import java.util.UUID
 import java.util.UUID.randomUUID
 import javax.persistence.Column
 import javax.persistence.Embeddable

src/main/kotlin/io/realworld/domain/article/FavoriteRelationshipRepository.kt

@@ -2,7 +2,7 @@ package io.realworld.domain.article
 
 import io.quarkus.hibernate.orm.panache.kotlin.PanacheRepositoryBase
 import io.quarkus.panache.common.Parameters
-import java.util.*
+import java.util.UUID
 import javax.enterprise.context.ApplicationScoped
 
 @ApplicationScoped

src/main/kotlin/io/realworld/domain/comment/CommentCreateRequest.kt

@@ -6,7 +6,7 @@ import io.quarkus.runtime.annotations.RegisterForReflection
 import io.realworld.domain.article.Article
 import io.realworld.domain.user.User
 import java.time.Instant.now
-import java.util.*
+import java.util.UUID
 
 @JsonRootName("comment")
 @RegisterForReflection

src/main/kotlin/io/realworld/domain/comment/CommentRepository.kt

@@ -2,7 +2,7 @@ package io.realworld.domain.comment
 
 import io.quarkus.hibernate.orm.panache.kotlin.PanacheRepository
 import io.quarkus.panache.common.Parameters
-import java.util.*
+import java.util.UUID
 import javax.enterprise.context.ApplicationScoped
 
 @ApplicationScoped

src/main/kotlin/io/realworld/domain/comment/CommentResource.kt

@@ -5,13 +5,19 @@ import io.realworld.infrastructure.security.Role.ADMIN
 import io.realworld.infrastructure.security.Role.USER
 import io.realworld.infrastructure.web.Routes.ARTICLES_PATH
 import io.realworld.utils.ValidationMessages.Companion.REQUEST_BODY_MUST_NOT_BE_NULL
-import java.util.*
+import java.util.UUID
 import javax.annotation.security.PermitAll
 import javax.annotation.security.RolesAllowed
 import javax.transaction.Transactional
 import javax.validation.Valid
 import javax.validation.constraints.NotNull
-import javax.ws.rs.*
+import javax.ws.rs.Consumes
+import javax.ws.rs.DELETE
+import javax.ws.rs.GET
+import javax.ws.rs.POST
+import javax.ws.rs.Path
+import javax.ws.rs.PathParam
+import javax.ws.rs.Produces
 import javax.ws.rs.core.Context
 import javax.ws.rs.core.MediaType.APPLICATION_JSON
 import javax.ws.rs.core.Response

src/main/kotlin/io/realworld/domain/comment/CommentService.kt

@@ -1,7 +1,7 @@
 package io.realworld.domain.comment
 
 import io.realworld.domain.profile.FollowRelationshipRepository
-import java.util.*
+import java.util.UUID
 import javax.enterprise.context.ApplicationScoped
 
 @ApplicationScoped

src/main/kotlin/io/realworld/domain/profile/ProfileResource.kt

@@ -4,7 +4,12 @@ import io.realworld.infrastructure.security.Role.USER
 import io.realworld.infrastructure.web.Routes.PROFILES_PATH
 import javax.annotation.security.PermitAll
 import javax.annotation.security.RolesAllowed
-import javax.ws.rs.*
+import javax.ws.rs.DELETE
+import javax.ws.rs.GET
+import javax.ws.rs.POST
+import javax.ws.rs.Path
+import javax.ws.rs.PathParam
+import javax.ws.rs.Produces
 import javax.ws.rs.core.Context
 import javax.ws.rs.core.MediaType.APPLICATION_JSON
 import javax.ws.rs.core.Response