File size: 2,447 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
import type { Command, Help } from 'next/dist/compiled/commander'
import { bold } from '../lib/picocolors'
// Copy-pasted from Commander's Help class -> formatHelp().
// TL;DR, we're overriding the built-in help to add a few niceties.
// Link: https://github.com/tj/commander.js/blob/master/lib/help.js
const formatCliHelpOutput = (cmd: Command, helper: Help) => {
const termWidth = helper.padWidth(cmd, helper)
const helpWidth = helper.helpWidth || 80
const itemIndentWidth = 2
const itemSeparatorWidth = 2 // between term and description
function formatItem(term: string, description: string) {
let value = term
if (description) {
if (term === 'directory') {
value = `[${term}]`
}
const fullText = `${value.padEnd(
termWidth + itemSeparatorWidth
)}${description}`
return helper.wrap(
fullText,
helpWidth - itemIndentWidth,
termWidth + itemSeparatorWidth
)
}
return term
}
function formatList(textArray: string[]) {
return textArray.join('\n').replace(/^/gm, ' '.repeat(itemIndentWidth))
}
// Usage
let output = [`${bold('Usage:')} ${helper.commandUsage(cmd)}`, '']
// Description
const commandDescription = helper.commandDescription(cmd)
if (commandDescription.length > 0) {
output = output.concat([helper.wrap(commandDescription, helpWidth, 0), ''])
}
// Arguments
const argumentList = helper.visibleArguments(cmd).map((argument) => {
return formatItem(
helper.argumentTerm(argument),
helper.argumentDescription(argument)
)
})
if (argumentList.length > 0) {
output = output.concat([
`${bold('Arguments:')}`,
formatList(argumentList),
'',
])
}
// Options
const optionList = helper.visibleOptions(cmd).map((option) => {
return formatItem(
helper.optionTerm(option),
helper.optionDescription(option)
)
})
if (optionList.length > 0) {
output = output.concat([`${bold('Options:')}`, formatList(optionList), ''])
}
// Commands
const commandList = helper.visibleCommands(cmd).map((subCmd) => {
return formatItem(
helper.subcommandTerm(subCmd),
helper.subcommandDescription(subCmd)
)
})
if (commandList.length > 0) {
output = output.concat([
`${bold('Commands:')}`,
formatList(commandList),
'',
])
}
return output.join('\n')
}
export { formatCliHelpOutput }
|