Oul reimplement during packaging (#6658)

Author: rjhancock

.editorconfig

@@ -7,13 +7,13 @@ indent_size = 4
 end_of_line = lf
 trim_trailing_whitespace = true
 insert_final_newline = true
-max_line_length = 140 # Google Style Guide
+max_line_length = 120
 curly_bracket_next_line = false
 spaces_around_operators = true
 spaces_around_brackets = "both"
 indent_brace_style = "K&R"
 wildcard_import_limit = 10
-continuation_indent_size = 4 # Google Style Guid
+continuation_indent_size = 6
 
 [*.xml]
 indent_style = "space"

.github/workflows/java-doc-on-pr.yml

@@ -0,0 +1,35 @@
+name: JavaDoc Generation
+
+on:
+  pull_request:
+    branches: [master]
+
+env:
+  GRADLE_OPTS: "-Dscan.link.VCS=${{ github.event.pull_request.html_url }}"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: "Check out MegaMek"
+        uses: actions/checkout@v4
+        with:
+          path: megamek
+
+      - name: Set up Temurin JDK 17
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 17
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+        with:
+          build-scan-publish: true
+          build-scan-terms-of-use-url: "https://gradle.com/terms-of-service"
+          build-scan-terms-of-use-agree: "yes"
+
+      - name: Build with Gradle
+        working-directory: megamek
+        run: ./gradlew javadoc

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradlew

@@ -183,6 +183,14 @@ task deleteAtlasedImages(dependsOn: createImageAtlases) {
     }
 }
 
+task officialUnitList(type: JavaExec, dependsOn: jar) {
+    description = 'Compiles a list of all units that come from official sources and saves it in the docs folder.'
+    group = 'utility'
+    classpath = sourceSets.main.runtimeClasspath
+    mainClass = 'megamek.MegaMek'
+    args = ['-oul', "${projectDir}/docs/OfficialUnitList.txt"]
+}
+
 task unitFilesZip (dependsOn: copyFiles) {
     description = 'Creates zip archives of all the unit file folders.'
     file(unitFiles).eachDir {subDir ->
@@ -211,6 +219,7 @@ task ratZip (type: Zip) {
 task stageFiles {
     description = 'Process data files to be included in distribution'
     group = 'distribution'
+    dependsOn officialUnitList
     dependsOn unitFilesZip
     dependsOn ratZip
     dependsOn deleteAtlasedImages
@@ -333,20 +342,11 @@ task testWithGUITests(type: Test) {
     jvmArgs = mmJvmOptions
     environment 'GUITests', "true"
 
-    group 'verification'
-    description 'Sets environment var to include GUI unit tests; no report generated.'
+    group='verification'
+    description='Sets environment var to include GUI unit tests; no report generated.'
 }
 
 // These are utility classes for all of the classes with the src/utilities folder.
-
-task officialUnitList(type: JavaExec, dependsOn: jar) {
-    description = 'Compiles a list of all units that come from official sources and saves it in the docs folder.'
-    group = 'utility'
-    classpath = sourceSets.main.runtimeClasspath
-    mainClass = 'megamek.MegaMek'
-    args = ['-oul', "${projectDir}/docs/OfficialUnitList.txt"]
-}
-
 task equipmentList(type: JavaExec, dependsOn: jar) {
     description = 'Generate Full Equipment Database'
     group = 'database'
@@ -460,7 +460,7 @@ task nameChangesValidator(type: JavaExec, dependsOn: jar) {
 }
 
 task ratGeneratorEditor(type: JavaExec, dependsOn: copyFiles) {
-    description = 'Checks for issues related to name changes.'
+    description = 'RAT Editor.'
     group = 'utility'
     classpath = sourceSets.main.runtimeClasspath
     mainClass = 'megamek.utilities.RATGeneratorEditor'
@@ -474,7 +474,7 @@ task techLevelCompareTool(type: JavaExec, dependsOn: jar) {
 }
 
 task unitFileMigrationTool(type: JavaExec, dependsOn: jar) {
-    description = 'Tech Level Comparison Tool'
+    description = 'Unit File Migration Tool'
     group = 'utility'
     classpath = sourceSets.main.runtimeClasspath
     mainClass = 'megamek.utilities.UnitFileMigrationTool'

megamek/build.gradle

@@ -55,7 +55,7 @@ https://raw.githubusercontent.com/checkstyle/checkstyle/master/src/main/resource
 
     <module name="LineLength">
         <property name="fileExtensions" value="java" />
-        <property name="max" value="140" />
+        <property name="max" value="120" />
         <property name="ignorePattern"
             value="^package.*|^import.*|href\s*=\s*&quot;[^&quot;]*&quot;|http://|https://|ftp://" />
     </module>