status-im
/
nim-confutils
mirror of https://github.com/status-im/nim-confutils.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

More renames for consistency

This commit is contained in:
Zahary Karadjov 2019-11-11 16:10:28 +00:00
parent 4ad95ce154
commit b42717a73a
No known key found for this signature in database
GPG Key ID: C8936F8A3073D609
1 changed files with 20 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
confutils.nim
View File

@ -9,8 +9,8 @@ export
const const
useBufferedOutput = defined(nimscript) useBufferedOutput = defined(nimscript)
noColors = useBufferedOutput or defined(confutils_no_colors) noColors = useBufferedOutput or defined(confutils_no_colors)
descriptionPadding = 6 descPadding = 6
minLongformsWidth = 24 - descriptionPadding minNameWidth = 24 - descPadding
when not defined(nimscript): when not defined(nimscript):
import import
@ -21,10 +21,10 @@ type
HelpAppInfo = ref object HelpAppInfo = ref object
appInvocation: string appInvocation: string
copyrightBanner: string copyrightBanner: string
hasShortforms: bool hasAbbrs: bool
maxLongformLen: int maxNameLen: int
terminalWidth: int terminalWidth: int
longformsWidth: int namesWidth: int
CmdInfo = ref object CmdInfo = ref object
name: string name: string
@ -169,7 +169,7 @@ iterator subCmds(cmd: CmdInfo): CmdInfo =
template isSubCommand(cmd: CmdInfo): bool = template isSubCommand(cmd: CmdInfo): bool =
cmd.name.len > 0 cmd.name.len > 0
func maxLongformLen(cmd: CmdInfo): int = func maxNameLen(cmd: CmdInfo): int =
result = 0 result = 0
for opt in cmd.opts: for opt in cmd.opts:
if opt.kind == Arg or opt.kind == Discriminator and opt.isCommand: if opt.kind == Arg or opt.kind == Discriminator and opt.isCommand:
@ -177,9 +177,9 @@ func maxLongformLen(cmd: CmdInfo): int =
result = max(result, opt.name.len) result = max(result, opt.name.len)
if opt.kind == Discriminator: if opt.kind == Discriminator:
for subCmd in opt.subCmds: for subCmd in opt.subCmds:
result = max(result, subCmd.maxLongformLen) result = max(result, subCmd.maxNameLen)
func hasShortforms(cmd: CmdInfo): bool = func hasAbbrs(cmd: CmdInfo): bool =
for opt in cmd.opts: for opt in cmd.opts:
if opt.kind == Arg or opt.kind == Discriminator and opt.isCommand: if opt.kind == Arg or opt.kind == Discriminator and opt.isCommand:
continue continue
@ -187,7 +187,7 @@ func hasShortforms(cmd: CmdInfo): bool =
return true return true
if opt.kind == Discriminator: if opt.kind == Discriminator:
for subCmd in opt.subCmds: for subCmd in opt.subCmds:
if hasShortforms(subCmd): if hasAbbrs(subCmd):
return true return true
func humaneName(opt: OptInfo): string = func humaneName(opt: OptInfo): string =
@ -200,7 +200,7 @@ template padding(output: string, desiredWidth: int): string =
proc writeDesc(help: var string, appInfo: HelpAppInfo, desc: string) = proc writeDesc(help: var string, appInfo: HelpAppInfo, desc: string) =
const descSpacing = " " const descSpacing = " "
let let
descIndent = (5 + appInfo.longformsWidth + descSpacing.len) descIndent = (5 + appInfo.namesWidth + descSpacing.len)
remainingColumns = appInfo.terminalWidth - descIndent remainingColumns = appInfo.terminalWidth - descIndent
if remainingColumns < 36: if remainingColumns < 36:
@ -231,7 +231,7 @@ proc describeInvocation(help: var string,
for arg in cmd.args: for arg in cmd.args:
if arg.desc.len > 0: if arg.desc.len > 0:
let cliArg = "<" & arg.humaneName & ">" let cliArg = "<" & arg.humaneName & ">"
helpOutput cliArg, padding(cliArg, 6 + appInfo.longformsWidth) helpOutput cliArg, padding(cliArg, 6 + appInfo.namesWidth)
help.writeDesc appInfo, arg.desc help.writeDesc appInfo, arg.desc
type type
@ -262,16 +262,16 @@ proc describeOptions(help: var string,
if opt.abbr.len > 0: if opt.abbr.len > 0:
helpOutput fgOption, styleBright, "-", opt.abbr, ", " helpOutput fgOption, styleBright, "-", opt.abbr, ", "
elif appInfo.hasShortforms: elif appInfo.hasAbbrs:
# Add additional indentatition, so all longforms are aligned # Add additional indentatition, so all names are aligned
helpOutput " " helpOutput " "
if opt.name.len > 0: if opt.name.len > 0:
let switch = "--" & opt.name let switch = "--" & opt.name
helpOutput fgOption, styleBright, helpOutput fgOption, styleBright,
switch, padding(switch, appInfo.longformsWidth) switch, padding(switch, appInfo.namesWidth)
else: else:
helpOutput spaces(2 + appInfo.longformsWidth) helpOutput spaces(2 + appInfo.namesWidth)
if opt.desc.len > 0: if opt.desc.len > 0:
help.writeDesc appInfo, opt.desc.replace("%t", opt.typename) help.writeDesc appInfo, opt.desc.replace("%t", opt.typename)
@ -310,11 +310,10 @@ proc showHelp(help: var string,
let cmd = activeCmds[^1] let cmd = activeCmds[^1]
appInfo.maxLongformLen = cmd.maxLongformLen appInfo.maxNameLen = cmd.maxNameLen
appInfo.hasShortforms = cmd.hasShortforms appInfo.hasAbbrs = cmd.hasAbbrs
appInfo.terminalWidth = terminalWidth() appInfo.terminalWidth = terminalWidth()
appInfo.longformsWidth = min(minLongformsWidth, appInfo.maxLongformLen) + appInfo.namesWidth = min(minNameWidth, appInfo.maxNameLen) + descPadding
descriptionPadding
var cmdInvocation = appInfo.appInvocation var cmdInvocation = appInfo.appInvocation
for i in 1 ..< activeCmds.len: for i in 1 ..< activeCmds.len:
@ -791,13 +790,13 @@ proc load*(Configuration: type,
if cur_word.startsWith('-'): if cur_word.startsWith('-'):
# Show all the options matching the prefix input by the user # Show all the options matching the prefix input by the user
let isLong = cur_word.startsWith("--") let isFullName = cur_word.startsWith("--")
var option_word = cur_word var option_word = cur_word
option_word.removePrefix('-') option_word.removePrefix('-')
for i in countdown(cmdStack.len - 1, 0): for i in countdown(cmdStack.len - 1, 0):
let argFilter = let argFilter =
if isLong: if isFullName:
{argName} {argName}
elif len(cur_word) > 1: elif len(cur_word) > 1:
# If the user entered a single hypen then we show both long & short # If the user entered a single hypen then we show both long & short