Skip to content

Rename optional in BuildGenUtil to renderIfArgsNonEmpty to make it more consistent with the other function names #5847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Rename optional in BuildGenUtil to renderIfArgsNonEmpty to make it more consistent with the other function names #5847

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71a3394
Update a TODO comment
ShreckYe Sep 12, 2025
98a7dd3
Rename `optional` in `BuildGenUtil` to `renderIfArgsNonEmpty`
ShreckYe Sep 12, 2025
75bb185
[autofix.ci] apply automated fixes
autofix-ci[bot] Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 19 additions & 14 deletions libs/init/buildgen/src/mill/main/buildgen/BuildGenUtil.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,11 +356,16 @@ object BuildGenUtil {
def renderVersionControl(vc: IrVersionControl): String =
s"VersionControl(${escapeOption(vc.url)}, ${escapeOption(vc.connection)}, ${escapeOption(vc.devConnection)}, ${escapeOption(vc.tag)})"

// TODO consider renaming to `renderOptionalDef` or `renderIfArgsNonEmpty`?
def optional(construct: String, args: IterableOnce[String]): String =
optional(construct + "(", args, ",", ")")

def optional(start: String, args: IterableOnce[String], sep: String, end: String): String = {
// TODO more alternative names: `renderOptional(Def)` or `render(Def)IfArgsNonEmpty`?
def renderIfArgsNonEmpty(construct: String, args: IterableOnce[String]): String =
renderIfArgsNonEmpty(construct + "(", args, ",", ")")

def renderIfArgsNonEmpty(
start: String,
args: IterableOnce[String],
sep: String,
end: String
): String = {
val itr = args.iterator
if (itr.isEmpty) ""
else itr.mkString(start, sep, end)
Expand Down Expand Up @@ -406,25 +411,25 @@ object BuildGenUtil {
else s"def artifactName = ${escape(name)}"

def renderBomMvnDeps(args: IterableOnce[String]): String =
optional("def bomMvnDeps = super.bomMvnDeps() ++ Seq", args)
renderIfArgsNonEmpty("def bomMvnDeps = super.bomMvnDeps() ++ Seq", args)

def renderMvnDeps(args: IterableOnce[String]): String =
optional("def mvnDeps = Seq", args)
renderIfArgsNonEmpty("def mvnDeps = Seq", args)

def renderModuleDeps(args: IterableOnce[String]): String =
optional("def moduleDeps = super.moduleDeps ++ Seq", args)
renderIfArgsNonEmpty("def moduleDeps = super.moduleDeps ++ Seq", args)

def renderCompileMvnDeps(args: IterableOnce[String]): String =
optional("def compileMvnDeps = Seq", args)
renderIfArgsNonEmpty("def compileMvnDeps = Seq", args)

def renderCompileModuleDeps(args: IterableOnce[String]): String =
optional("def compileModuleDeps = super.compileModuleDeps ++ Seq", args)
renderIfArgsNonEmpty("def compileModuleDeps = super.compileModuleDeps ++ Seq", args)

def renderRunMvnDeps(args: IterableOnce[String]): String =
optional("def runMvnDeps = Seq", args)
renderIfArgsNonEmpty("def runMvnDeps = Seq", args)

def renderRunModuleDeps(args: IterableOnce[String]): String =
optional("def runModuleDeps = super.runModuleDeps ++ Seq", args)
renderIfArgsNonEmpty("def runModuleDeps = super.runModuleDeps ++ Seq", args)

def renderJavacOptions(args: Seq[String], superArgs: Seq[String] = Seq.empty): String =
renderSeqTaskDefWithSuper("javacOptions", args, superArgs, "String", escape).getOrElse("")
Expand Down Expand Up @@ -455,7 +460,7 @@ object BuildGenUtil {
).getOrElse("")

def renderResources(args: IterableOnce[os.SubPath]): String =
optional(
renderIfArgsNonEmpty(
"""def resources = Task { super.resources() ++ customResources() }
|def customResources = Task.Sources(""".stripMargin,
args.iterator.map(sub => escape(sub.toString())),
Expand Down Expand Up @@ -491,7 +496,7 @@ object BuildGenUtil {
args: Seq[(String, String)]
): String = {
val tuples = args.iterator.map { case (k, v) => s"(${escape(k)}, ${escape(v)})" }
optional("def publishProperties = super.publishProperties() ++ Map", tuples)
renderIfArgsNonEmpty("def publishProperties = super.publishProperties() ++ Map", tuples)
}

def renderJvmWorker(moduleName: String): String =
Expand Down
Loading