commonMain.git.Git.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of kommandline-jvm Show documentation
Kotlin DSL for popular CLI commands.
The newest version!
package pl.mareklangiewicz.kommand.git

import pl.mareklangiewicz.annotations.DelicateApi
import pl.mareklangiewicz.bad.*
import pl.mareklangiewicz.kommand.*
import pl.mareklangiewicz.kommand.git.GitCmd.*

/** @return single line with hash of given revision/commit */
@OptIn(DelicateApi::class)
fun gitHash(revision: String = "HEAD") = git(RevParse) { +revision }

@OptIn(DelicateApi::class)
fun gitHelp(commandOrConcept: String? = null) = git(Help) { commandOrConcept?.let { +it } }

@OptIn(DelicateApi::class)
fun gitStatus(short: Boolean = false, verbose: Boolean = false, vararg pathSpecs: String) = git(Status) {
  if (short) +"-s"
  if (verbose) +"-v"
  if (pathSpecs.any { it.startsWith("-") }) +"--"
  pathSpecs.forEach { +it }
}

@OptIn(DelicateApi::class)
fun git(cmd: GitCmd? = null, init: Git.() -> Unit = {}) = Git().apply {
  init()
  cmd?.let {
    chk(opts.all { it !is GitCmd }) { "There can be only one GitCmd" }
    -cmd
  }
}

/** https://git-scm.com/docs/user-manual.html */
@DelicateApi
data class Git(
  override val opts: MutableList = mutableListOf(), // last GitOpt should always be GitCmd
  override val nonopts: MutableList = mutableListOf(), // here is all stuff local for given GitCmd
) : KommandTypical {
  override val name get() = "git"
}

@OptIn(DelicateApi::class)
interface GitOpt : KOptTypical {

  // region [GNU Common Opts]
  // https://www.gnu.org/software/coreutils/manual/html_node/Common-options.html
  data object Help : KOptLN(), GitOpt // Don't risk short -h (ambiguity: sudo -h host; ls -h (human-readable), etc.)
  data object Version : KOptLN(), GitOpt // Don't risk short -v (ambiguity with "verbose" for many commands)
  data object EOOpt : KOptL(""), GitOpt
  // endregion [GNU Common Opts]

  data object Paginate : GitOpt, KOptLN()
  data object Bare : GitOpt, KOptLN()

  data class InPath(val path: String) : GitOpt, KOptS("C", path)

  data class GitDir(val dir: String) : GitOpt, KOptLN(dir)
  data class WorkTree(val path: String) : GitOpt, KOptLN(path)
  data class Namespace(val path: String) : GitOpt, KOptLN(path)
}

@OptIn(DelicateApi::class)
sealed class GitCmd : GitOpt, KOptLN(namePrefix = "") {
  data object Add : GitCmd()
  data object Archive : GitCmd()
  data object Bisect : GitCmd()
  data object Branch : GitCmd()
  data object Bundle : GitCmd()
  data object Checkout : GitCmd()
  data object CherryPick : GitCmd()
  data object Citool : GitCmd()
  data object Clean : GitCmd()
  data object Clone : GitCmd()
  data object Commit : GitCmd()
  data object Describe : GitCmd()
  data object Diff : GitCmd()
  data object Fetch : GitCmd()
  data object Gc : GitCmd()
  data object Grep : GitCmd()
  data object Gui : GitCmd()
  data object Help : GitCmd()
  data object Init : GitCmd()
  data object Log : GitCmd()
  data object Maintenance : GitCmd()
  data object Merge : GitCmd()
  data object Mv : GitCmd()
  data object Notes : GitCmd()
  data object Pull : GitCmd()
  data object Push : GitCmd()
  data object Rebase : GitCmd()
  data object Reset : GitCmd()
  data object Restore : GitCmd()
  data object Revert : GitCmd()
  data object Rm : GitCmd()
  data object Shortlog : GitCmd()
  data object Show : GitCmd()
  data object Stash : GitCmd()
  data object Status : GitCmd()
  data object Submodule : GitCmd()
  data object Switch : GitCmd()
  data object Tag : GitCmd()
  data object Worktree : GitCmd()
  data object RevParse : GitCmd()
}