| 1 | // @ts-check
|
|---|
| 2 | import packageJson from '../../../package.json'
|
|---|
| 3 |
|
|---|
| 4 | export function help({ message, usage, commands, options }) {
|
|---|
| 5 | let indent = 2
|
|---|
| 6 |
|
|---|
| 7 | // Render header
|
|---|
| 8 | console.log()
|
|---|
| 9 | console.log(`${packageJson.name} v${packageJson.version}`)
|
|---|
| 10 |
|
|---|
| 11 | // Render message
|
|---|
| 12 | if (message) {
|
|---|
| 13 | console.log()
|
|---|
| 14 | for (let msg of message.split('\n')) {
|
|---|
| 15 | console.log(msg)
|
|---|
| 16 | }
|
|---|
| 17 | }
|
|---|
| 18 |
|
|---|
| 19 | // Render usage
|
|---|
| 20 | if (usage && usage.length > 0) {
|
|---|
| 21 | console.log()
|
|---|
| 22 | console.log('Usage:')
|
|---|
| 23 | for (let example of usage) {
|
|---|
| 24 | console.log(' '.repeat(indent), example)
|
|---|
| 25 | }
|
|---|
| 26 | }
|
|---|
| 27 |
|
|---|
| 28 | // Render commands
|
|---|
| 29 | if (commands && commands.length > 0) {
|
|---|
| 30 | console.log()
|
|---|
| 31 | console.log('Commands:')
|
|---|
| 32 | for (let command of commands) {
|
|---|
| 33 | console.log(' '.repeat(indent), command)
|
|---|
| 34 | }
|
|---|
| 35 | }
|
|---|
| 36 |
|
|---|
| 37 | // Render options
|
|---|
| 38 | if (options) {
|
|---|
| 39 | let groupedOptions = {}
|
|---|
| 40 | for (let [key, value] of Object.entries(options)) {
|
|---|
| 41 | if (typeof value === 'object') {
|
|---|
| 42 | groupedOptions[key] = { ...value, flags: [key] }
|
|---|
| 43 | } else {
|
|---|
| 44 | groupedOptions[value].flags.push(key)
|
|---|
| 45 | }
|
|---|
| 46 | }
|
|---|
| 47 |
|
|---|
| 48 | console.log()
|
|---|
| 49 | console.log('Options:')
|
|---|
| 50 | for (let { flags, description, deprecated } of Object.values(groupedOptions)) {
|
|---|
| 51 | if (deprecated) continue
|
|---|
| 52 |
|
|---|
| 53 | if (flags.length === 1) {
|
|---|
| 54 | console.log(
|
|---|
| 55 | ' '.repeat(indent + 4 /* 4 = "-i, ".length */),
|
|---|
| 56 | flags.slice().reverse().join(', ').padEnd(20, ' '),
|
|---|
| 57 | description
|
|---|
| 58 | )
|
|---|
| 59 | } else {
|
|---|
| 60 | console.log(
|
|---|
| 61 | ' '.repeat(indent),
|
|---|
| 62 | flags.slice().reverse().join(', ').padEnd(24, ' '),
|
|---|
| 63 | description
|
|---|
| 64 | )
|
|---|
| 65 | }
|
|---|
| 66 | }
|
|---|
| 67 | }
|
|---|
| 68 |
|
|---|
| 69 | console.log()
|
|---|
| 70 | }
|
|---|