Kotlin の新規プロジェクトで最初に導入するもの

{
  //
  // automerge
  // https://docs.renovatebot.com/configuration-options/#automerge
  //
  // 自動マージ
  // メジャーバージョン・マイナーバージョンで自動マージの true/false を設定できる
  //
  // default false
  automerge: true,

  //
  // extends
  // https://docs.renovatebot.com/configuration-options/#extends
  //
  // プリセットを使用
  //
  extends: [
    "config:base",
    //
    // timezone
    // https://docs.renovatebot.com/configuration-options/#timezone
    // https://docs.renovatebot.com/presets-default/#timezonearg0
    //
    // 概要
    // - タイムゾーン
    //
    // default: null(UTC)
    //
    ":timezone(Asia/Tokyo)"
  ],

  //
  // labels
  // https://docs.renovatebot.com/configuration-options/#labels
  //
  // 概要
  // - 全てのPRにつけるラベル
  //
  labels: ["dependencies"],

  //
  // dependencyDashboard
  // https://docs.renovatebot.com/configuration-options/#dependencydashboard
  //
  // 概要
  // - ダッシュボード作成する・しない
  //
  // default: false
  //
  dependencyDashboard: true,

  //
  // packageRules
  // https://docs.renovatebot.com/configuration-options/#packagerules
  //
  // 概要
  // - updateするパッケージの単位(まとめることができる)
  //
  // default: なし
  //
}

{
  //
  // automerge
  // https://docs.renovatebot.com/configuration-options/#automerge
  //
  // 自動マージ
  // メジャーバージョン・マイナーバージョンで自動マージの true/false を設定できる
  //
  // default false
  automerge: true,
 
  //
  // packageRules
  // https://docs.renovatebot.com/configuration-options/#packagerules
  //
  // 概要
  // - updateするパッケージの単位(まとめることができる)
  //
  // default: なし
  //
  packageRules: [
    {
      groupName: "org.jetbrains.kotlin.*",
      description: "一緒に上げないとCIが落ちる",
      matchPackagePrefixes: [
        "org.jetbrains.kotlin."
      ]
    },
  ]
}

.PHONY: test
test: ## テスト実行
	./gradlew test

.PHONY: fmt
fmt: ## format
	./gradlew detekt --auto-correct

.PHONY: lint
lint: ## lint
	./gradlew detekt
################################################################################
# Utility-Command help
################################################################################
.DEFAULT_GOAL := help

################################################################################
# マクロ
################################################################################
# Makefileの中身を抽出してhelpとして1行で出す
# $(1): Makefile名
define help
  grep -E '^[\.a-zA-Z0-9_-]+:.*?## .*$$' $(1) \
  | grep --invert-match "## non-help" \
  | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
endef

################################################################################
# タスク
################################################################################
.PHONY: help
help: ## Make タスク一覧
	@echo '######################################################################'
	@echo '# Makeタスク一覧'
	@echo '# $$ make XXX'
	@echo '# or'
	@echo '# $$ make XXX --dry-run'
	@echo '######################################################################'
	@echo $(MAKEFILE_LIST) \
	| tr ' ' '\n' \
	| xargs -I {included-makefile} $(call help,{included-makefile})

fun main(args: Array<String>) {
	@Suppress("SpreadOperator")
	runApplication<OpenapiGeneratorSampleApplication>(*args)
}

@SpringBootTest
class OpenapiGeneratorSampleApplicationTests {

	@Test
	@Suppress("EmptyFunctionBlock")
	fun contextLoads() {
	}

}

./gradlew detektGenerateConfig

touch config/detekt/detekt-override.yml

---
# comments のルール
comments:
  active: true
  #
  # UndocumentedPublicClass
  #
  # 概要
  # - コメントがないパブリッククラスを禁止する
  #
  UndocumentedPublicClass:
    active: true  # (default: false)
  #
  # UndocumentedPublicClass
  #
  # 概要
  # - コメントがないパブリックな関数を禁止する
  #
  UndocumentedPublicFunction:
    active: true  # (default: false)
  #
  # UndocumentedPublicClass
  #
  # 概要
  # - コメントがないパブリックなプロパティを禁止する
  #
  UndocumentedPublicProperty:
    active: true  # (default: false)

# style のルール
style:
  active: true
  #
  # UnusedImports
  #
  # 概要
  # - 未使用の import を禁止する
  #
  UnusedImports:
    active: true  # (default: false)

/**
 * detektの設定
 *
 * 基本的に全て `detekt-override.yml` で設定する
 */
detekt {
    /**
     * ./gradlew detektGenerateConfig でdetekt.ymlが生成される(バージョンが上がる度に再生成する)
     */
    config = files(
        "$projectDir/config/detekt/detekt.yml",
        "$projectDir/config/detekt/detekt-override.yml",
    )
}

mkdir ./.githooks
touch ./.githooks/pre-commit

#!/usr/bin/env bash
echo "Running detekt check..."
OUTPUT="/tmp/detekt-main-$(date +%s)"
make lint.main > $OUTPUT
EXIT_CODE=$?
if [ $EXIT_CODE -ne 0 ]; then
  cat $OUTPUT
  rm $OUTPUT
  echo "**********************************************************"
  echo "                   Detekt failed                          "
  echo " make fmt.main を実行するか、直接修正してからコミットしてください "
  echo "**********************************************************"
  exit $EXIT_CODE
fi
rm $OUTPUT

OUTPUT="/tmp/detekt-test-$(date +%s)"
make lint.test > $OUTPUT
EXIT_CODE=$?
if [ $EXIT_CODE -ne 0 ]; then
  cat $OUTPUT
  rm $OUTPUT
  echo "**********************************************************"
  echo "                   Detekt failed                          "
  echo " make fmt.test を実行するか、直接修正してからコミットしてください "
  echo "**********************************************************"
  exit $EXIT_CODE
fi
rm $OUTPUT

chmod +x .githooks/pre-commit
git config --local core.hooksPath .githooks

plugins {
    /**
     * openapi.generator
     *
     * 公式ページ
     * - https://openapi-generator.tech/
     * GradlePlugins(plugins.gradle.org)
     * - https://plugins.gradle.org/plugin/org.openapi.generator
     * GitHub
     * - https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-gradle-plugin
     * Main用途
     * - スキーマファイルからコード生成
     * Sub用途
     * - スキーマファイルからドキュメント生成
     * 概要
     * - スキーマ駆動開発するために使う
     * - API仕様をスキーマファイル(yaml)に書いて、コード生成し、それを利用するようにする
     * - 可能な限りプロダクトコードに依存しないようにする(生成したコードにプロダクトコードを依存させる)
     */
    id("org.openapi.generator") version "6.2.0"
}

dependencies {
    /**
     * Swagger Annotations
     * Swagger Models
     * Jakarta Annotations API
     *
     * MavenCentral
     * - https://mvnrepository.com/artifact/io.swagger.core.v3/swagger-annotations
     * - https://mvnrepository.com/artifact/io.swagger.core.v3/swagger-models
     * - https://mvnrepository.com/artifact/jakarta.annotation/jakarta.annotation-api
     * Main用途
     * - OpenAPI Generatorで作成されるコードで利用
     * Sub用途
     * - 無し
     * 概要
     * - OpenAPI Generatorで作成されるコードがimportしている
     * - 基本的にプロダクションコードでは使わない想定
     */
    compileOnly("io.swagger.core.v3:swagger-annotations:2.2.6")
    compileOnly("io.swagger.core.v3:swagger-models:2.2.6")
    compileOnly("jakarta.annotation:jakarta.annotation-api:2.1.1")

    /**
     * Spring Boot Starter Validation
     *
     * MavenCentral
     * - https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-validation
     * Main用途
     * - OpenAPI Generatorで作成されるコードで利用
     * Sub用途
     * - 無し
     * 概要
     * - OpenAPI Generatorで作成されるコードがimportしている
     * - javax.validation*を利用するため
     * [Spring-Boot-2.3ではjavax.validationを依存関係に追加しなければならない](https://qiita.com/tatetsujitomorrow/items/a397c311a95d66e4f955)
     */
    implementation("org.springframework.boot:spring-boot-starter-validation")
}

import org.openapitools.generator.gradle.plugin.tasks.GenerateTask // GenerateTask のオプションのために、import が必要。あらかじめ、build して依存ファイルがないと import できない

/**
 * OpenAPI Generator を使ってコード生成
 */
task<GenerateTask>("generateApiServer") {
	generatorName.set("kotlin-spring")
	inputSpec.set("$projectDir/openapi.yaml")
	outputDir.set("$buildDir/openapi/server-code/") // .gitignoreされているので注意(わざとここにあります)
	apiPackage.set("com.example.yourapp.openapi.generated.controller") // 各自のアプリケーションに合わせてパス名を変更する
	modelPackage.set("com.example.yourapp.openapi.generated.model") // 各自のアプリケーションに合わせてパス名を変更する
	configOptions.set(
		mapOf(
			"interfaceOnly" to "true",
		)
	)
	/**
	 * true にすると tags 準拠で、API の interface を生成する
	 */
	additionalProperties.set(
		mapOf(
			"useTags" to "true"
		)
	)
}

/**
 * Kotlinをコンパイルする前に、generateApiServerタスクを実行
 * 必ずスキーマファイルから最新のコードが生成され、もし変更があったらコンパイル時に失敗して気付けるため
 */
tasks.compileKotlin {
	dependsOn("generateApiServer")
}

/**
 * OpenAPI Generator によって生成されたコードを import できるようにする
 */
kotlin.sourceSets.main {
	kotlin.srcDir("$buildDir/openapi/server-code/src/main")
}

dependencies {
   // 略

    /**
     * Database Rider
     *
     * - Rider Core
     * - Rider Spring
     * - Rider JUnit 5
     *
     * URL
     * - https://database-rider.github.io/database-rider/
     * MavenCentral
     * - https://mvnrepository.com/artifact/com.github.database-rider/rider-core
     * - https://mvnrepository.com/artifact/com.github.database-rider/rider-spring
     * - https://mvnrepository.com/artifact/com.github.database-rider/rider-junit5
     * Main用途
     * - JUnitでDB周りのテスト時のヘルパー
     * 概要
     * - テーブルの事前条件、事後条件を簡潔に設定できる
     */
    implementation("com.github.database-rider:rider-core:1.35.0")
    implementation("com.github.database-rider:rider-spring:1.35.0")
    testImplementation("com.github.database-rider:rider-junit5:1.35.0")
}

class ClassNameTest {

    @TestInstance(TestInstance.Lifecycle.PER_CLASS)
    @DBRider
    @DisplayName("List(コメント一覧を表示)")
    class InnterClassNameTest {
        @Test
        @DBRider
        @DataSet("datasets/path/to/input/data.{yml,csv,cml}") // 入力データのファイルを指定
        @ExpectedDataSet(
            value = ["datasets/path/to/expected/data.{yml,csv,cml}"], // 期待値のデータのファイルを指定
            orderBy = ["id"],
            ignoreCols = ["createdAt", "updatedAt"], // メタデータを無視する
        )
        // NOTE: 一度データを書き出したら、コメントアウトする
        @ExportDataSet(
            format = DataSetFormat.YML, // テスト完了後にデータを書き出す形式を指定
            outputName = "src/test/resources/datasets/path/to/export/data.{yml,csv,cml}", // 書き出すファイル先を指定
            includeTables = ["customer"] // 含めるカラムを指定
        )
        fun `テスト`() {
                // テストを書く
        }
    }
}

./gradlew dokkaHtml