Rewrite comments

1ef04ffc4dc7d4be5e2cc499bfe1154b0490f4a1

Cohee <18619528+Cohee1207@users.noreply.github.com>

Parents: 68eecc77bb2a9bff0e560cafa687f8e3699fd219

src/command-line.js+16 -19 Viewed

  */
 /**
 - * Gets the hostname to use for autorun in the browser.
 + * Provides a command line arguments parser.
 - * @param {boolean} useIPv6 If use IPv6
 - * @param {boolean} useIPv4 If use IPv4
 - * @returns {Promise<string>} The hostname to use for autorun
  */
+-
 export class CommandLineParser {
     constructor() {
         /** @type {CommandLineArguments} */

     /**
      * Parses command line arguments.
 +     * Arguments that are not provided will be filled with config values.
      * @param {string[]} args Process startup arguments.
      * @returns {CommandLineArguments} Parsed command line arguments.
      */
     parse(args) {
         const cliArguments = yargs(hideBin(args))
             .usage('Usage: <your-start-script> <command> [options]\nOptions that are not provided will be filled with config values.')
             .option('enableIPv6', {
                 type: 'string',
                 default: null,
                 describe: 'Enables IPv6 protocol.',
             }).option('enableIPv4', {
                 type: 'string',
                 default: null,
                 describe: 'Enables IPv4 protocol.',
             }).option('port', {
                 type: 'number',
                 default: null,
 -                describe: 'Sets the port under which SillyTavern will run.\nIf not provided falls back to yaml config \'port\'.',
 +                describe: 'Sets the server listening port',
             }).option('dnsPreferIPv6', {
                 type: 'boolean',
                 default: null,
                 describe: 'Prefers IPv6 for DNS\nyounYou should probably have the enabled if you\'re on an IPv6 only network\nIf not provided falls back to yaml config \'dnsPreferIPv6\'.',
             }).option('autorun', {
                 type: 'boolean',
                 default: null,
 -                describe: 'Automatically launch SillyTavern in the browser.\nAutorun is automatically disabled if --ssl is set to true.\nIf not provided falls back to yaml config \'autorun\'.',
 +                describe: 'Automatically launch SillyTavern in the browser',
             }).option('autorunHostname', {
                 type: 'string',
                 default: null,

             }).option('listen', {
                 type: 'boolean',
                 default: null,
 -                describe: 'SillyTavern is listening on all network interfaces (Wi-Fi, LAN, localhost). If false, will limit it only to internal localhost (127.0.0.1).\nIf not provided falls back to yaml config \'listen\'.',
 +                describe: 'Whether to listen on all network interfaces',
             }).option('listenAddressIPv6', {
                 type: 'string',
                 default: null,
                 describe: 'Set SillyTavern to listen to a specificSpecific IPv6 address. If not set, it will fallback to listen to all.',
             }).option('listenAddressIPv4', {
                 type: 'string',
                 default: null,
                 describe: 'Set SillyTavern to listen to a specificSpecific IPv4 address. If not set, it will fallback to listen to all.',
             }).option('corsProxy', {
                 type: 'boolean',
                 default: null,
                 describe: 'Enables CORS proxy\nIf not provided falls back to yaml config \'enableCorsProxy\'',
             }).option('disableCsrf', {
                 type: 'boolean',
                 default: null,
                 describe: 'Disables CSRF protection - NOT RECOMMENDED',
             }).option('ssl', {
                 type: 'boolean',
                 default: false,

             }).option('certPath', {
                 type: 'string',
                 default: 'certs/cert.pem',
                 describe: 'Path to yourSSL certificate file.',
             }).option('keyPath', {
                 type: 'string',
                 default: 'certs/privkey.pem',
                 describe: 'Path to yourSSL private key file.',
             }).option('whitelist', {
                 type: 'boolean',
                 default: null,

             }).option('avoidLocalhost', {
                 type: 'boolean',
                 default: null,
                 describe: 'Avoids using \'localhost\' for autorun in auto mode.\nusenUse if you don\'t have \'localhost\' in your hosts file',
             }).option('basicAuthMode', {
                 type: 'boolean',
                 default: null,