org.pkl.codegen.java.Main.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pkl-tools Show documentation
Fat Jar containing pkl-cli, pkl-codegen-java, pkl-codegen-kotlin, pkl-config-java, pkl-core, pkl-doc, and their shaded third-party dependencies.
There is a newer version: 0.27.1
Show newest version
/*
 * 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.
 */
@file:JvmName("Main")

package org.pkl.codegen.java

import org.pkl.thirdparty.clikt.parameters.options.associate
import org.pkl.thirdparty.clikt.parameters.options.default
import org.pkl.thirdparty.clikt.parameters.options.flag
import org.pkl.thirdparty.clikt.parameters.options.option
import org.pkl.thirdparty.clikt.parameters.types.path
import java.nio.file.Path
import org.pkl.commons.cli.CliBaseOptions
import org.pkl.commons.cli.cliMain
import org.pkl.commons.cli.commands.ModulesCommand
import org.pkl.commons.toPath
import org.pkl.core.Release

/** Main method for the Java code generator CLI. */
internal fun main(args: Array) {
  cliMain { PklJavaCodegenCommand().main(args) }
}

class PklJavaCodegenCommand :
  ModulesCommand(
    name = "pkl-codegen-java",
    helpLink = Release.current().documentation().homepage(),
  ) {

  private val defaults = CliJavaCodeGeneratorOptions(CliBaseOptions(), "".toPath())

  private val outputDir: Path by
    option(
        names = arrayOf("-o", "--output-dir"),
        metavar = "",
        help = "The directory where generated source code is placed."
      )
      .path()
      .default(defaults.outputDir)

  private val indent: String by
    option(
        names = arrayOf("--indent"),
        metavar = "",
        help = "The characters to use for indenting generated source code."
      )
      .default(defaults.indent)

  private val generateGetters: Boolean by
    option(
        names = arrayOf("--generate-getters"),
        help =
          "Whether to generate public getter methods and " +
            "private final fields instead of public final fields."
      )
      .flag()

  private val generateJavadoc: Boolean by
    option(
        names = arrayOf("--generate-javadoc"),
        help =
          "Whether to generate Javadoc based on doc comments " +
            "for Pkl modules, classes, and properties."
      )
      .flag()

  private val generateSpringboot: Boolean by
    option(
        names = arrayOf("--generate-spring-boot"),
        help = "Whether to generate config classes for use with Spring boot."
      )
      .flag()

  private val paramsAnnotation: String? by
    option(
      names = arrayOf("--params-annotation"),
      help = "Fully qualified name of the annotation to use on constructor parameters."
    )

  private val nonNullAnnotation: String? by
    option(
      names = arrayOf("--non-null-annotation"),
      help =
        """
      Fully qualified named of the annotation class to use for non-null types.
      This annotation is required to have `java.lang.annotation.ElementType.TYPE_USE` as a `@Target`
      or it may generate code that does not compile.
    """
          .trimIndent()
    )

  private val implementSerializable: Boolean by
    option(
        names = arrayOf("--implement-serializable"),
        help = "Whether to make generated classes implement java.io.Serializable."
      )
      .flag()

  private val renames: Map by
    option(
        names = arrayOf("--rename"),
        metavar = "",
        help =
          """
            Replace a prefix in the names of the generated Java classes (repeatable).
            By default, the names of generated classes are derived from the Pkl module names.
            With this option, you can override the modify the default names, renaming entire
            classes or just their packages.
          """
            .trimIndent()
      )
      .associate()

  override fun run() {
    val options =
      CliJavaCodeGeneratorOptions(
        base = baseOptions.baseOptions(modules, projectOptions),
        outputDir = outputDir,
        indent = indent,
        generateGetters = generateGetters,
        generateJavadoc = generateJavadoc,
        generateSpringBootConfig = generateSpringboot,
        paramsAnnotation = paramsAnnotation,
        nonNullAnnotation = nonNullAnnotation,
        implementSerializable = implementSerializable,
        renames = renames
      )
    CliJavaCodeGenerator(options).run()
  }
}