clinntp/src/help.js

A cli nntp news reader

import chalk from 'chalk'

import { name } from '../package.json'

const menus = {
  help: `
${chalk.greenBright(name + ' [options]')}

    ${chalk.blueBright('-l, --limit')} ${chalk.redBright('<news limit>')}
        Limit the number of news you load when choosing a newsgroup.
        ${chalk.blackBright('Default:')} Loads ${chalk.yellowBright('all')} of the news in the selected newsgroup

    ${chalk.blueBright('-p, --port')} ${chalk.redBright('<port number>')}
        Sets the port number to use when connecting to the host
        ${chalk.blackBright('Default:')} Set to ${chalk.yellowBright('119')}

    ${chalk.blueBright('-h, --host')} ${chalk.redBright('<host address>')}
        Sets the address to use when connecting to the host
        ${chalk.blackBright('Default:')} Set to ${chalk.yellowBright('\'news.epita.fr\'')}

    ${chalk.blueBright('-n, --newsgroups')} ${chalk.redBright('<match regex>')}
        Sets the regex to use when looking up newsgroups
        ${chalk.blackBright('Default:')} Set to ${chalk.yellowBright('\'*\'')}

    ${chalk.blueBright('-H, --help')}
        Prints ${name} help menu with options info

    ${chalk.blueBright('-v, --version')}
        Prints ${name} version number

    ${chalk.blueBright('-s, --save')}
        Saves the current settings as defaults

    ${chalk.blueBright('-c, --clear')}
        Resets the settings to initial default

    ${chalk.blueBright('-d, --dryrun')}
        Tries to connect with the current or specified settings without fetching the news
`
}

export function help () {
  console.log(menus.help)
}