From 7a0e018fb90a2d7fdc195ff713e9380e5b3fa761 Mon Sep 17 00:00:00 2001
From: trydofor <trydofor@gmail.com>
Date: Sun, 14 Jan 2024 09:38:08 +0800
Subject: [PATCH] =?UTF-8?q?=F0=9F=92=9A=20delombok=20and=20javadoc=20#181?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .github/workflows/release.yml |   4 +-
 observe/docs                  |   2 +-
 pom.xml                       | 125 +++++++++++++++++++++++++++-------
 radiant/pom.xml               |   6 --
 wings/pom.xml                 |   6 --
 5 files changed, 104 insertions(+), 39 deletions(-)

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 584a1abf5..4040a5254 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -94,7 +94,7 @@ jobs:
         if: inputs.testCoverReport
         run: >
           mvn 
-          -P ci
+          -P test
           --quiet
           -Duser.timezone=Asia/Shanghai
           -Dtesting-json='{
@@ -121,7 +121,7 @@ jobs:
       - name: Maven Deploy
         run: >
           mvn 
-          -P ossrh,-example
+          -P ossrh,doc,-example
           ${{ steps.opt-revision.outputs.OPT_REVISION }}
           -Dgpg.passphrase=${MVN_GPG_PASS}
           clean deploy
diff --git a/observe/docs b/observe/docs
index aa3c3fd76..8de53dce9 160000
--- a/observe/docs
+++ b/observe/docs
@@ -1 +1 @@
-Subproject commit aa3c3fd7637dd8a30b39813784c7529e444b9304
+Subproject commit 8de53dce97c35c2a0589cb8840586913c406194d
diff --git a/pom.xml b/pom.xml
index 9543575da..a8ee2af5b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -70,10 +70,20 @@
         <nexus-staging-plugin.version>1.6.13</nexus-staging-plugin.version> <!-- https://github.com/sonatype/nexus-maven-plugins/tree/main/staging/maven-plugin -->
         <coveralls-maven-plugin.version>4.3.0</coveralls-maven-plugin.version> <!-- https://github.com/hazendaz/coveralls-maven-plugin -->
         <jacoco-maven-plugin.version>0.8.11</jacoco-maven-plugin.version> <!-- https://www.jacoco.org/jacoco/trunk/doc/maven.html -->
-        <testing-json>{}</testing-json>
+        <dokka-maven-plugin.version>1.9.10</dokka-maven-plugin.version> <!-- https://kotlinlang.org/docs/dokka-maven.html#general-configuration -->
+        <lombok-maven-plugin.version>1.18.20.0</lombok-maven-plugin.version> <!-- https://github.com/awhitford/lombok.maven -->
+        <!-- java, kotlin sources  -->
+        <source.srcMainJava>${project.basedir}/src/main/java</source.srcMainJava>
+        <source.srcMainKotlin>${project.basedir}/src/main/kotlin</source.srcMainKotlin>
+        <source.srcTestJava>${project.basedir}/src/test/java</source.srcTestJava>
+        <source.srcTestKotlin>${project.basedir}/src/test/kotlin</source.srcTestKotlin>
+        <!-- delombok: javadoc cannot find symbol  -->
+        <source.srcMainDelombok>${project.build.directory}/delombok-main</source.srcMainDelombok>
+        <!-- test,doc,deploy -->
+        <testing-json>{}</testing-json> <!-- springboot surefire config  -->
         <argLine/> <!-- surefire:argLine -->
         <surefireArgLine/> <!-- jacoco-agent:argLine -->
-        <wings.java-opens>
+        <javaopenArgLine>
             --add-modules=java.se <!-- Hazelcast -->
             --add-opens=java.base/java.io=ALL-UNNAMED <!-- FastJson -->
             --add-opens=java.base/java.lang.invoke=ALL-UNNAMED <!-- FastJson2 -->
@@ -89,7 +99,7 @@
             --add-opens=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED <!-- Boot -->
             --add-opens=jdk.management/com.sun.management.internal=ALL-UNNAMED <!-- Hazelcast -->
             --add-opens=jdk.unsupported/sun.misc=ALL-UNNAMED <!-- Boot -->
-        </wings.java-opens>
+        </javaopenArgLine>
     </properties>
 
     <licenses>
@@ -449,6 +459,12 @@
                 <version>${sentry.version}</version>
             </dependency>
             <!-- dev -->
+            <dependency>
+                <groupId>org.projectlombok</groupId>
+                <artifactId>lombok</artifactId>
+                <version>${lombok.version}</version>
+                <scope>provided</scope>
+            </dependency>
             <dependency>
                 <groupId>org.jetbrains</groupId>
                 <artifactId>annotations</artifactId>
@@ -516,7 +532,7 @@
                         <systemPropertyVariables>
                             <SPRING_APPLICATION_JSON>${testing-json}</SPRING_APPLICATION_JSON>
                         </systemPropertyVariables>
-                        <argLine>-Xmx2g @{wings.java-opens} @{argLine} @{surefireArgLine}</argLine>
+                        <argLine>-Xmx2g @{argLine} @{javaopenArgLine} @{surefireArgLine}</argLine>
                     </configuration>
                 </plugin>
                 <plugin>
@@ -594,19 +610,6 @@
                         </execution>
                     </executions>
                 </plugin>
-                <plugin>
-                    <groupId>org.apache.maven.plugins</groupId>
-                    <artifactId>maven-javadoc-plugin</artifactId>
-                    <version>${maven-javadoc-plugin.version}</version>
-                    <executions>
-                        <execution>
-                            <id>attach-javadocs</id>
-                            <goals>
-                                <goal>jar</goal>
-                            </goals>
-                        </execution>
-                    </executions>
-                </plugin>
                 <plugin>
                     <groupId>org.springframework.boot</groupId>
                     <artifactId>spring-boot-maven-plugin</artifactId>
@@ -665,8 +668,8 @@
                             </goals>
                             <configuration>
                                 <sources>
-                                    <source>${project.basedir}/src/main/kotlin</source>
-                                    <source>${project.basedir}/src/main/java</source>
+                                    <source>${source.srcMainKotlin}</source>
+                                    <source>${source.srcMainJava}</source>
                                 </sources>
                             </configuration>
                         </execution>
@@ -722,6 +725,19 @@
                         </dependency>
                     </dependencies>
                 </plugin>
+                <plugin>
+                    <groupId>org.jetbrains.dokka</groupId>
+                    <artifactId>dokka-maven-plugin</artifactId>
+                    <version>${dokka-maven-plugin.version}</version>
+                    <executions>
+                        <execution>
+                            <phase>prepare-package</phase>
+                            <goals>
+                                <goal>javadocJar</goal>
+                            </goals>
+                        </execution>
+                    </executions>
+                </plugin>
                 <!-- build info -->
                 <plugin>
                     <groupId>io.github.git-commit-id</groupId>
@@ -801,8 +817,8 @@
                                 </goals>
                                 <configuration>
                                     <sourceDirs>
-                                        <sourceDir>${project.basedir}/src/test/kotlin</sourceDir>
-                                        <sourceDir>${project.basedir}/src/test/java</sourceDir>
+                                        <sourceDir>${source.srcTestKotlin}</sourceDir>
+                                        <sourceDir>${source.srcTestJava}</sourceDir>
                                     </sourceDirs>
                                 </configuration>
                             </execution>
@@ -860,8 +876,8 @@
                                 </goals>
                                 <configuration>
                                     <sourceDirs>
-                                        <sourceDir>${project.basedir}/src/main/kotlin</sourceDir>
-                                        <sourceDir>${project.basedir}/src/main/java</sourceDir>
+                                        <sourceDir>${source.srcMainKotlin}</sourceDir>
+                                        <sourceDir>${source.srcMainJava}</sourceDir>
                                     </sourceDirs>
                                 </configuration>
                             </execution>
@@ -890,7 +906,7 @@
         </profile>
         <profile>
             <!-- -DrepoToken=${{ secrets.COVERALLS_REPO_TOKEN }} -->
-            <id>ci</id>
+            <id>test</id>
             <properties>
                 <maven.test.skip>false</maven.test.skip>
                 <surefire.timeout>0</surefire.timeout> <!-- going to kill self fork JVM -->
@@ -930,6 +946,67 @@
                 </plugins>
             </build>
         </profile>
+        <profile>
+            <id>doc</id>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.projectlombok</groupId>
+                        <artifactId>lombok-maven-plugin</artifactId>
+                        <version>${lombok-maven-plugin.version}</version>
+                        <configuration>
+                            <addOutputDirectory>false</addOutputDirectory>
+                            <sourceDirectory>${source.srcMainJava}</sourceDirectory>
+                            <outputDirectory>${source.srcMainDelombok}</outputDirectory>
+                        </configuration>
+                        <executions>
+                            <execution>
+                                <phase>generate-sources</phase>
+                                <goals>
+                                    <goal>delombok</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                        <dependencies>
+                            <dependency>
+                                <groupId>org.projectlombok</groupId>
+                                <artifactId>lombok</artifactId>
+                                <version>${lombok.version}</version>
+                            </dependency>
+                        </dependencies>
+                    </plugin>
+                    <!--
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-javadoc-plugin</artifactId>
+                        <version>${maven-javadoc-plugin.version}</version>
+                        <configuration>
+                            <sourcepath>${source.srcMainDelombok}</sourcepath>
+                            <doclint>none</doclint>
+                        </configuration>
+                        <executions>
+                            <execution>
+                                <id>attach-javadocs</id>
+                                <goals>
+                                    <goal>jar</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                    </plugin>
+                    -->
+                    <plugin>
+                        <groupId>org.jetbrains.dokka</groupId>
+                        <artifactId>dokka-maven-plugin</artifactId>
+                        <configuration>
+                            <sourceDirectories>
+                                <dir>${source.srcMainDelombok}</dir>
+                                <dir>${source.srcMainKotlin}</dir>
+                            </sourceDirectories>
+                        </configuration>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
         <profile>
             <id>ossrh</id>
             <properties>
diff --git a/radiant/pom.xml b/radiant/pom.xml
index dc751784f..41ef3b165 100644
--- a/radiant/pom.xml
+++ b/radiant/pom.xml
@@ -50,8 +50,6 @@
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
-            <scope>provided</scope>
-            <optional>true</optional>
         </dependency>
         <dependency>
             <groupId>org.mapstruct</groupId>
@@ -94,10 +92,6 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-resources-plugin</artifactId>
             </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-javadoc-plugin</artifactId>
-            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-source-plugin</artifactId>
diff --git a/wings/pom.xml b/wings/pom.xml
index 341640847..edec0d0f2 100644
--- a/wings/pom.xml
+++ b/wings/pom.xml
@@ -70,8 +70,6 @@
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
-            <scope>provided</scope>
-            <optional>true</optional>
         </dependency>
         <dependency>
             <groupId>org.mapstruct</groupId>
@@ -114,10 +112,6 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-resources-plugin</artifactId>
             </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-javadoc-plugin</artifactId>
-            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-source-plugin</artifactId>