[chore] Fix grammar, add JSDocs

cb7185fa125468716f656f31d637c0e282ee2b6c

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

default/config.yaml+8 -4 Viewed

 # -- SERVER CONFIGURATION --
 # Listen for incoming connections
 listen: false
 # Enables IPv6 and/or IPv4 protocols. Need to have at least one enabled!
 protocol:
     ipv4: true
     ipv6: false
 # Prefers IPv6 for dns, you should probablyDNS. enableEnable this on ISPs that don't have issues with IPv6
 dnsPreferIPv6: false
 -# the hostname that autorun opens probably best left on auto. use options like 'localhost', 'st.example.com'
 +# The hostname that autorun opens.
 +# - Use "auto" to let the server decide
 +# - Use options like 'localhost', 'st.example.com'
 autorunHostname: "auto"
 # Server port
 port: 8000
 -# overrides the port for autorun with open your browser with this port and ignore what port the server is running on. -1 is use server port
 +# Overrides the port for autorun in browser.
 +# - Use -1 to use the server port.
 +# - Specify a port to override the default.
 autorunPortOverride: -1
 # -- SECURITY CONFIGURATION --
 # Toggle whitelist mode

server.js+34 -52 Viewed

     getConfigValue,
     color,
     forwardFetchResponse,
 +    removeColorFormatting,
 +    getSeparator,
 } = require('./src/util');
 const { ensureThumbnailCache } = require('./src/endpoints/thumbnails');

     if (net.setDefaultAutoSelectFamily) net.setDefaultAutoSelectFamily(false);
+}
+-
+-
+-
+-
 const DEFAULT_PORT = 8000;
 const DEFAULT_AUTORUN = false;
 const DEFAULT_LISTEN = false;

     (':' + server_port),
 );
+-
 /**
  * Tasks that need to be run before the server starts listening.
  */

     });
 };
 -function removeColorFormatting(text) {
 +/**
 -    // ANSI escape codes for colors are usually in the format \x1b[<codes>m
 + * Gets the hostname to use for autorun in the browser.
 -    return text.replace(/\x1b\[\d{1,2}(;\d{1,2})*m/g, '');
 + * @returns {string} The hostname to use for autorun
 -}
 + */
+-
 -function getSeparator(n) {
 -    return '='.repeat(n);
 -}
+-
+-
+-
 function getAutorunHostname() {
+-
     if (autorunHostname === 'auto') {
         if (enableIPv6 && enableIPv4) {
             if (avoidLocalhost) return '[::1]';

     return autorunHostname;
+}
+-
 /**
  * Tasks that need to be run after the server starts listening.
 + * @param {boolean} v6Failed If the server failed to start on IPv6
 + * @param {boolean} v4Failed If the server failed to start on IPv4
  */
 const postSetupTasks = async function (v6Failed, v4Failed) {
+-
+-
     const autorunUrl = new URL(
         (cliArguments.ssl ? 'https://' : 'http://') +
         (getAutorunHostname()) +

         ((autorunPortOverride >= 0) ? autorunPortOverride : server_port),
     );
+-
     console.log('Launching...');
     if (autorun) open(autorunUrl.toString());
     setWindowTitle('SillyTavern WebServer');
+-
 -    let ipv6Color = color.green;
 -    let ipv4Color = color.green;
 -    let autorunColor = color.blue;
+-
     let logListen = 'SillyTavern is listening on';
     if (enableIPv6 && !v6Failed) {
         logListen += ipv6Colorcolor.green(' IPv6: ' + tavernUrlV6.host);
+    }
     if (enableIPv4 && !v4Failed) {
         logListen += ipv4Colorcolor.green(' IPv4: ' + tavernUrl.host);
+    }
     letconst goToLog = 'Go to: ' + autorunColorcolor.blue(autorunUrl) + ' to open SillyTavern';
     letconst plainGoToLog = removeColorFormatting(goToLog);
     console.log(logListen);
     console.log('\n' + getSeparator(plainGoToLog.length) + '\n');

     process.exit(1);
+}
+-
 +/**
+-
 + * Handles the case where the server failed to start on one or both protocols.
 + * @param {boolean} v6Failed If the server failed to start on IPv6
 + * @param {boolean} v4Failed If the server failed to start on IPv4
 + */
 function handleServerListenFail(v6Failed, v4Failed) {
     if (v6Failed && !enableIPv4) {
         console.error('fatal error: Failed to start server on IPv6 and IPv4 disabled');

+    }
+}
+-
 +/**
 + * Creates an HTTPS server.
 + * @param {URL} url The URL to listen on
 + * @returns {Promise<void>} A promise that resolves when the server is listening
 + * @throws {Error} If the server fails to start
 + */
 function createHttpsServer(url) {
     return new Promise((resolve, reject) => {
         const server = https.createServer(

     });
+}
 +/**
 + * Creates an HTTP server.
 + * @param {URL} url The URL to listen on
 + * @returns {Promise<void>} A promise that resolves when the server is listening
 + * @throws {Error} If the server fails to start
 + */
 function createHttpServer(url) {
     return new Promise((resolve, reject) => {
         const server = http.createServer(app);

     });
+}
+-
+-
+-
 async function startHTTPorHTTPS() {
     let v6Failed = false;
     let v4Failed = false;
     letconst createFunc = cliArguments.ssl ? createHttpsServer : createHttpServer;
 -    if (cliArguments.ssl) {
 -        createFunc = createHttpsServer;
 -    }
     if (enableIPv6) {
         try {
             await createFunc(tavernUrlV6);
         } catch (error) {
             if (enableIPv4) {
                 console.error('non-fatal error: failed to start server on IPv6', error);
+            }

     if (enableIPv4) {
         try {
             await createFunc(tavernUrl);
         } catch (error) {
             if (enableIPv6) {
                 console.error('non-fatal error: failed to start server on IPv4', error);
+            }

             v4Failed = true;
+        }
+    }
++
     return [v6Failed, v4Failed];
+}
+-
+-
+-
 async function startServer() {
     letconst [v6Failed, v4Failed] = falseawait startHTTPorHTTPS();
 -    let v4Failed = false;
+-
+-
 -    [v6Failed, v4Failed] = await startHTTPorHTTPS();
     handleServerListenFail(v6Failed, v4Failed);
     postSetupTasks(v6Failed, v4Failed);
+}
+-
+-
 async function verifySecuritySettings() {
     // Skip all security checks as listen is set to false
     if (!listen) {

src/util.js+21 -0 Viewed

+    }
+}
 +/**
 + * Removes color formatting from a text string.
 + * @param {string} text Text with color formatting
 + * @returns {string} Text without color formatting
 + */
 +function removeColorFormatting(text) {
 +    // ANSI escape codes for colors are usually in the format \x1b[<codes>m
 +    return text.replace(/\x1b\[\d{1,2}(;\d{1,2})*m/g, '');
 +}
++
 +/**
 + * Gets a separator string repeated n times.
 + * @param {number} n Number of times to repeat the separator
 + * @returns {string} Separator string
 + */
 +function getSeparator(n) {
 +    return '='.repeat(n);
 +}
++
 module.exports = {
     getConfig,
     getConfigValue,

     trimV1,
     Cache,
     makeHttp2Request,
 +    removeColorFormatting,
 +    getSeparator,
 };