Rename progName to programName

Author: xenomachina

src/main/kotlin/com/xenomachina/argparser/DefaultHelpFormatter.kt

@@ -66,7 +66,7 @@ class DefaultHelpFormatter(
     val indentWidth = indent.codePointWidth()
 
     override fun format(
-            progName: String?,
+            programName: String?,
             columns: Int,
             values: List<HelpFormatter.Value>
     ): String {
@@ -76,7 +76,7 @@ class DefaultHelpFormatter(
             else -> columns
         }
         val sb = StringBuilder()
-        appendUsage(sb, effectiveColumns, progName, values)
+        appendUsage(sb, effectiveColumns, programName, values)
         sb.append("\n")
 
         if (!prologue.isNullOrEmpty()) {
@@ -143,8 +143,8 @@ class DefaultHelpFormatter(
     private fun usageText(value: HelpFormatter.Value) =
             value.usages.map { it.replace(' ', '\u00a0') }.joinToString(", ")
 
-    private fun appendUsage(sb: StringBuilder, columns: Int, progName: String?, values: List<HelpFormatter.Value>) {
-        var usageStart = USAGE_PREFIX + (if (progName != null) " $progName" else "")
+    private fun appendUsage(sb: StringBuilder, columns: Int, programName: String?, values: List<HelpFormatter.Value>) {
+        var usageStart = USAGE_PREFIX + (if (programName != null) " $programName" else "")
 
         val valueSB = StringBuilder()
         for (value in values) value.run {

src/main/kotlin/com/xenomachina/argparser/Exceptions.kt

@@ -28,8 +28,8 @@ class ShowHelpException internal constructor(
         private val helpFormatter: HelpFormatter,
         private val delegates: List<ArgParser.Delegate<*>>
 ) : SystemExitException("Help was requested", 0) {
-    override fun printUserMessage(writer: Writer, progName: String?, columns: Int) {
-        writer.write(helpFormatter.format(progName, columns, delegates.map { it.toHelpFormatterValue() }))
+    override fun printUserMessage(writer: Writer, programName: String?, columns: Int) {
+        writer.write(helpFormatter.format(programName, columns, delegates.map { it.toHelpFormatterValue() }))
     }
 }
 

src/main/kotlin/com/xenomachina/argparser/HelpFormatter.kt

@@ -25,13 +25,13 @@ interface HelpFormatter {
     /**
      * Formats a help message.
      *
-     * @param progName name of the program as it should appear in usage information, or null if
+     * @param programName name of the program as it should appear in usage information, or null if
      * program name is unknown.
      * @param columns width of display help should be formatted for, measured in character cells, or 0 for infinite
      * width.
      * @param values [Value] objects describing the arguments types available.
      */
-    fun format(progName: String?, columns: Int, values: List<Value>): String
+    fun format(programName: String?, columns: Int, values: List<Value>): String
 
     /**
      * An option or positional argument type which should be formatted for help

src/main/kotlin/com/xenomachina/argparser/SystemExitException.kt

@@ -33,12 +33,12 @@ open class SystemExitException(message: String, val returnCode: Int) : Exception
      * Prints a message for the user to either `System.err` or `System.out`, and then exits with the appropriate
      * return code.
      *
-     * @param progName the name of this program as invoked, or null if not known
+     * @param programName the name of this program as invoked, or null if not known
      * @param columns the number of columns to wrap at, or 0 if not to wrap at all
      */
-    fun printAndExit(progName: String? = null, columns: Int = 0): Nothing {
+    fun printAndExit(programName: String? = null, columns: Int = 0): Nothing {
         val writer = OutputStreamWriter(if (returnCode == 0) System.out else System.err)
-        printUserMessage(writer, progName, columns)
+        printUserMessage(writer, programName, columns)
         writer.flush()
         exitProcess(returnCode)
     }
@@ -47,11 +47,11 @@ open class SystemExitException(message: String, val returnCode: Int) : Exception
      * Prints a message for the user to the specified `Writer`.
      *
      * @param writer where to write message for the user
-     * @param progName the name of this program as invoked, or null if not known
+     * @param programName the name of this program as invoked, or null if not known
      * @param columns the number of columns to wrap at, or 0 if not to wrap at all
      */
-    open fun printUserMessage(writer: Writer, progName: String?, columns: Int) {
-        val leader = if (progName == null) "" else "$progName: "
+    open fun printUserMessage(writer: Writer, programName: String?, columns: Int) {
+        val leader = if (programName == null) "" else "$programName: "
         writer.write("$leader$message\n")
     }
 }
@@ -60,16 +60,16 @@ open class SystemExitException(message: String, val returnCode: Int) : Exception
  * Calls [SystemExitException.printAndExit] on any `SystemExitException` that
  * is caught.
  *
- * @param progName the name of the program, or null if not known
+ * @param programName the name of the program, or null if not known
  * @param columns the number of columns to wrap any caught
  * `SystemExitException` to.  Specify null for reasonable defaults, or 0 to not
  * wrap at all.
  * @param body the code that may throw a `SystemExitException`
  */
-fun <R> mainBody(progName: String? = null, columns: Int? = null, body: () -> R): R {
+fun <R> mainBody(programName: String? = null, columns: Int? = null, body: () -> R): R {
     try {
         return body()
     } catch (e: SystemExitException) {
-        e.printAndExit(progName, columns ?: System.getenv("COLUMNS")?.toInt() ?: 80)
+        e.printAndExit(programName, columns ?: System.getenv("COLUMNS")?.toInt() ?: 80)
     }
 }