Spaces:
Running
Running
File size: 865 Bytes
78c921d |
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 |
/**
* @module command-line-usage
*/
/**
* Generates a usage guide suitable for a command-line app.
* @param {Section|Section[]} - One or more section objects ({@link module:command-line-usage~content} or {@link module:command-line-usage~optionList}).
* @returns {string}
* @alias module:command-line-usage
*/
function commandLineUsage (sections) {
const arrayify = require('array-back')
sections = arrayify(sections)
if (sections.length) {
const OptionList = require('./lib/section/option-list')
const ContentSection = require('./lib/section/content')
const output = sections.map(section => {
if (section.optionList) {
return new OptionList(section)
} else {
return new ContentSection(section)
}
})
return '\n' + output.join('\n')
} else {
return ''
}
}
module.exports = commandLineUsage
|