cli/foundry.cli.gradle/GradleProjectFlattenerCli

GradleProjectFlattenerCli

class GradleProjectFlattenerCli : CliktCommand(source)

A CLI that flattens all gradle projects in a given directory to be top level while preserving their original project paths.

This is useful for flattening nested projects that use Dokka, which does not currently support easy doc gen for nested projects and end up with colliding names.

It's recommended to run ./gradlew clean first before running this script to minimize work.

Constructors

GradleProjectFlattenerCli

constructor()

Types

Factory

@AutoService(value = [CommandFactory::class])

class Factory : CommandFactory

Properties

allowMultipleSubcommands

open val allowMultipleSubcommands: Boolean

autoCompleteEnvvar

open val autoCompleteEnvvar: String?

commandName

val commandName: String

currentContext

val currentContext: Context

helpTags

open val helpTags: Map<String, String>

hiddenFromHelp

open val hiddenFromHelp: Boolean

invokeWithoutSubcommand

open val invokeWithoutSubcommand: Boolean

messages

val messages: List<String>

printHelpOnEmptyArgs

open val printHelpOnEmptyArgs: Boolean

treatUnknownOptionsAsArgs

open val treatUnknownOptionsAsArgs: Boolean

Functions

aliases

open fun aliases(): Map<String, List<String>>

allHelpParams

open fun allHelpParams(): List<HelpFormatter.ParameterHelp>

configureContext

fun configureContext(block: Context.Builder.() -> Unit)

dryRunOption

fun CliktCommand.dryRunOption(vararg names: String = arrayOf("--dry-run"), help: String = "Runs this as a dry run, no modifications."): OptionWithValues<Boolean, Boolean, Boolean>

A dry run option for clikt commands.

echo

fun echo()

fun echo(message: Any?, trailingNewline: Boolean, err: Boolean)

echoFormattedHelp

fun echoFormattedHelp(error: CliktError?)

getFormattedHelp

fun getFormattedHelp(error: CliktError?): String?

help

open override fun help(context: Context): String

helpEpilog

open fun helpEpilog(context: Context): String

issueMessage

fun issueMessage(message: String)

projectDirOption

fun CliktCommand.projectDirOption(vararg names: String = arrayOf("--project-dir"), help: String = "The project directory. Defaults to the current working directory."): OptionDelegate<Path>

A project dir option for clikt commands.

registerArgument

fun registerArgument(argument: Argument)

registeredArguments