Run spotless apply

2026-09-18 15:51:22 +02:00 · 2024-07-01 09:24:04 -07:00
parent 7a9b571f6e
commit 8c1c10528f
127 changed files with 5325 additions and 3450 deletions
@@ -1,3 +1,18 @@
+/**
+ * Copyright © 2024 Apple Inc. and the Pkl project authors. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 import org.gradle.api.GradleException
 import org.gradle.api.artifacts.Configuration
 import org.gradle.api.component.AdhocComponentWithVariants
@@ -18,41 +33,43 @@ val fatJarConfiguration: Configuration = configurations.create("fatJar")
 val fatJarPublication: MavenPublication = publishing.publications.create<MavenPublication>("fatJar")

 // ideally we'd configure this automatically based on project dependencies
-val firstPartySourcesJarsConfiguration: Configuration = configurations.create("firstPartySourcesJars")
+val firstPartySourcesJarsConfiguration: Configuration =
+  configurations.create("firstPartySourcesJars")

-val relocations = mapOf(
-  // pkl-core dependencies
-  "org.antlr.v4." to "org.pkl.thirdparty.antlr.v4.",
-  "com.oracle.truffle" to "org.pkl.thirdparty.truffle",
-  "org.graalvm." to "org.pkl.thirdparty.graalvm.",
-  "org.organicdesign.fp." to "org.pkl.thirdparty.paguro.",
-  "org.snakeyaml.engine." to "org.pkl.thirdparty.snakeyaml.engine.",
-  "org.msgpack." to "org.pkl.thirdparty.msgpack.",
-  "org.w3c.dom." to "org.pkl.thirdparty.w3c.dom",
-  "com.oracle.svm.core." to "org.pkl.thirdparty.svm.",
+val relocations =
+  mapOf(
+    // pkl-core dependencies
+    "org.antlr.v4." to "org.pkl.thirdparty.antlr.v4.",
+    "com.oracle.truffle" to "org.pkl.thirdparty.truffle",
+    "org.graalvm." to "org.pkl.thirdparty.graalvm.",
+    "org.organicdesign.fp." to "org.pkl.thirdparty.paguro.",
+    "org.snakeyaml.engine." to "org.pkl.thirdparty.snakeyaml.engine.",
+    "org.msgpack." to "org.pkl.thirdparty.msgpack.",
+    "org.w3c.dom." to "org.pkl.thirdparty.w3c.dom",
+    "com.oracle.svm.core." to "org.pkl.thirdparty.svm.",

-  // pkl-cli dependencies
-  "org.jline." to "org.pkl.thirdparty.jline.",
-  "com.github.ajalt.clikt." to "org.pkl.thirdparty.clikt.",
-  "kotlin." to "org.pkl.thirdparty.kotlin.",
-  "kotlinx." to "org.pkl.thirdparty.kotlinx.",
-  "org.intellij." to "org.pkl.thirdparty.intellij.",
-  "org.fusesource.jansi." to "org.pkl.thirdparty.jansi",
-  "org.fusesource.hawtjni." to "org.pkl.thirdparty.hawtjni",
+    // pkl-cli dependencies
+    "org.jline." to "org.pkl.thirdparty.jline.",
+    "com.github.ajalt.clikt." to "org.pkl.thirdparty.clikt.",
+    "kotlin." to "org.pkl.thirdparty.kotlin.",
+    "kotlinx." to "org.pkl.thirdparty.kotlinx.",
+    "org.intellij." to "org.pkl.thirdparty.intellij.",
+    "org.fusesource.jansi." to "org.pkl.thirdparty.jansi",
+    "org.fusesource.hawtjni." to "org.pkl.thirdparty.hawtjni",

-  // pkl-doc dependencies
-  "org.commonmark." to "org.pkl.thirdparty.commonmark.",
-  "org.jetbrains." to "org.pkl.thirdparty.jetbrains.",
-  
-  // pkl-config-java dependencies
-  "io.leangen.geantyref." to "org.pkl.thirdparty.geantyref.",
+    // pkl-doc dependencies
+    "org.commonmark." to "org.pkl.thirdparty.commonmark.",
+    "org.jetbrains." to "org.pkl.thirdparty.jetbrains.",

-  // pkl-codegen-java dependencies
-  "com.squareup.javapoet." to "org.pkl.thirdparty.javapoet.",
+    // pkl-config-java dependencies
+    "io.leangen.geantyref." to "org.pkl.thirdparty.geantyref.",

-  // pkl-codegen-kotlin dependencies
-  "com.squareup.kotlinpoet." to "org.pkl.thirdparty.kotlinpoet.",
-)
+    // pkl-codegen-java dependencies
+    "com.squareup.javapoet." to "org.pkl.thirdparty.javapoet.",
+
+    // pkl-codegen-kotlin dependencies
+    "com.squareup.kotlinpoet." to "org.pkl.thirdparty.kotlinpoet.",
+  )

 val nonRelocations = listOf("com/oracle/truffle/")

@@ -82,82 +99,81 @@ tasks.shadowJar {

 // workaround for https://github.com/johnrengelman/shadow/issues/651
 components.withType(AdhocComponentWithVariants::class.java).forEach { c ->
-  c.withVariantsFromConfiguration(project.configurations.shadowRuntimeElements.get()) {
-    skip()
+  c.withVariantsFromConfiguration(project.configurations.shadowRuntimeElements.get()) { skip() }
+}
+
+val testFatJar by
+  tasks.registering(Test::class) {
+    testClassesDirs = files(tasks.test.get().testClassesDirs)
+    classpath =
+      // compiled test classes
+      sourceSets.test.get().output +
+        // fat Jar
+        tasks.shadowJar.get().outputs.files +
+        // test-only dependencies
+        // (test dependencies that are also main dependencies must already be contained in fat Jar;
+        // to verify that, we don't want to include them here)
+        (configurations.testRuntimeClasspath.get() - configurations.runtimeClasspath.get())
  }
-}

-val testFatJar by tasks.registering(Test::class) {
-  testClassesDirs = files(tasks.test.get().testClassesDirs)
-  classpath =
-    // compiled test classes
-    sourceSets.test.get().output +
-      // fat Jar
-      tasks.shadowJar.get().outputs.files +
-      // test-only dependencies
-      // (test dependencies that are also main dependencies must already be contained in fat Jar;
-      // to verify that, we don't want to include them here)
-      (configurations.testRuntimeClasspath.get() - configurations.runtimeClasspath.get())
-}
+tasks.check { dependsOn(testFatJar) }

-tasks.check {
-  dependsOn(testFatJar)
-}
+val validateFatJar by
+  tasks.registering {
+    val outputFile = layout.buildDirectory.file("validateFatJar/result.txt")
+    inputs.files(tasks.shadowJar)
+    inputs.property("nonRelocations", nonRelocations)
+    outputs.file(outputFile)

-val validateFatJar by tasks.registering {
-  val outputFile = layout.buildDirectory.file("validateFatJar/result.txt")
-  inputs.files(tasks.shadowJar)
-  inputs.property("nonRelocations", nonRelocations)
-  outputs.file(outputFile)
-
-  doLast {
-    val unshadowedFiles = mutableListOf<String>()
-    zipTree(tasks.shadowJar.get().outputs.files.singleFile).visit {
-      val fileDetails = this
-      val path = fileDetails.relativePath.pathString
-      if (!(fileDetails.isDirectory ||
-          path.startsWith("org/pkl/") ||
-          path.startsWith("META-INF/") || 
-          nonRelocations.any { path.startsWith(it) })) {
-        // don't throw exception inside `visit` 
-        // as this gives a misleading "Could not expand ZIP" error message
-        unshadowedFiles.add(path)
+    doLast {
+      val unshadowedFiles = mutableListOf<String>()
+      zipTree(tasks.shadowJar.get().outputs.files.singleFile).visit {
+        val fileDetails = this
+        val path = fileDetails.relativePath.pathString
+        if (
+          !(fileDetails.isDirectory ||
+            path.startsWith("org/pkl/") ||
+            path.startsWith("META-INF/") ||
+            nonRelocations.any { path.startsWith(it) })
+        ) {
+          // don't throw exception inside `visit`
+          // as this gives a misleading "Could not expand ZIP" error message
+          unshadowedFiles.add(path)
+        }
+      }
+      if (unshadowedFiles.isEmpty()) {
+        outputFile.get().asFile.writeText("SUCCESS")
+      } else {
+        outputFile.get().asFile.writeText("FAILURE")
+        throw GradleException("Found unshadowed files:\n" + unshadowedFiles.joinToString("\n"))
      }
    }
-    if (unshadowedFiles.isEmpty()) {
-      outputFile.get().asFile.writeText("SUCCESS")
-    } else {
-      outputFile.get().asFile.writeText("FAILURE")
-      throw GradleException("Found unshadowed files:\n" + unshadowedFiles.joinToString("\n"))
-    }
  }
-}
-tasks.check {
-  dependsOn(validateFatJar)
-}

-val resolveSourcesJars by tasks.registering(ResolveSourcesJars::class) {
-  configuration.set(configurations.runtimeClasspath)
-  outputDir.set(layout.buildDirectory.dir("resolveSourcesJars"))
-}
+tasks.check { dependsOn(validateFatJar) }

-val fatSourcesJar by tasks.registering(MergeSourcesJars::class) {
-  plugins.withId("pklJavaLibrary") {
-    inputJars.from(tasks.named("sourcesJar"))
+val resolveSourcesJars by
+  tasks.registering(ResolveSourcesJars::class) {
+    configuration.set(configurations.runtimeClasspath)
+    outputDir.set(layout.buildDirectory.dir("resolveSourcesJars"))
  }
-  inputJars.from(firstPartySourcesJarsConfiguration)
-  inputJars.from(resolveSourcesJars.map { fileTree(it.outputDir) })

-  mergedBinaryJars.from(tasks.shadowJar)
-  relocatedPackages.set(relocations)
-  outputJar.fileProvider(provider {
-    file(tasks.shadowJar.get().archiveFile.get().asFile.path.replace(".jar", "-sources.jar"))
-  })
-}
+val fatSourcesJar by
+  tasks.registering(MergeSourcesJars::class) {
+    plugins.withId("pklJavaLibrary") { inputJars.from(tasks.named("sourcesJar")) }
+    inputJars.from(firstPartySourcesJarsConfiguration)
+    inputJars.from(resolveSourcesJars.map { fileTree(it.outputDir) })

-artifacts {
-  add("fatJar", tasks.shadowJar)
-}
+    mergedBinaryJars.from(tasks.shadowJar)
+    relocatedPackages.set(relocations)
+    outputJar.fileProvider(
+      provider {
+        file(tasks.shadowJar.get().archiveFile.get().asFile.path.replace(".jar", "-sources.jar"))
+      }
+    )
+  }
+
+artifacts { add("fatJar", tasks.shadowJar) }

 publishing {
  publications {
@@ -165,16 +181,12 @@ publishing {
      project.shadow.component(this)

      // sources Jar is fat
-      artifact(fatSourcesJar.flatMap { it.outputJar.asFile }) {
-        classifier = "sources"
-      }
+      artifact(fatSourcesJar.flatMap { it.outputJar.asFile }) { classifier = "sources" }

      plugins.withId("pklJavaLibrary") {
        val javadocJar by tasks.existing(Jar::class)
        // Javadoc Jar is not fat (didn't invest effort)
-        artifact(javadocJar.flatMap { it.archiveFile }) {
-          classifier = "javadoc"
-        }
+        artifact(javadocJar.flatMap { it.archiveFile }) { classifier = "javadoc" }
      }
    }
  }