org.pkl.doc.CliDocGeneratorOptions.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.
 */
package org.pkl.doc

import java.nio.file.Path
import org.pkl.commons.cli.CliBaseOptions
import org.pkl.commons.resolveSafely

/** Configuration options for [CliDocGenerator]. */
data class CliDocGeneratorOptions
@JvmOverloads
constructor(
  /** Base options shared between CLI commands. */
  val base: CliBaseOptions,

  /** The directory where generated documentation is placed. */
  val outputDir: Path,

  /**
   * Internal option only used for testing.
   *
   * Generates source URLs with fixed line numbers `#L123-L456` to avoid churn in expected output
   * files (e.g., when stdlib line numbers change).
   */
  val isTestMode: Boolean = false
) {
  /** [outputDir] after undergoing normalization. */
  val normalizedOutputDir: Path = base.normalizedWorkingDir.resolveSafely(outputDir)
}