@caboodle-tech/node-simple-server 4.2.4 → 4.3.0

package/README.md

@@ -16,36 +16,42 @@ A small but effective node based server for development sites, customizable live
 
 ## Installation
 
-### Manually:
-
-Node Simple Server (NSS) can be manually incorporated into your development process/ application. Extract the `nss` folder from the [latest release](https://github.com/caboodle-tech/node-simple-server/releases/) and then `import` the server module into your code, similar to:
-
-```javascript
-import NodeSimpleServer from './nss.js';
-```
-
 ### Locally:
 
-You can install and use NSS locally in a project with:
+Like any other Node based application you can install NSS automatically with `pnpm` or `npm` and then reference it in your code. This is the recommended way to install and use NSS.
 
 ```bash
-# As a normal dependency:
+# Install using pnpm:
+pnpm add @caboodle-tech/node-simple-server
+
+# Or install using npm:
 npm install @caboodle-tech/node-simple-server
+```
+
+Then use in your code with:
 
-# or as a development dependency:
-npm install @caboodle-tech/node-simple-server --save-dev
+```javascript
+import NodeSimpleServer from '@caboodle-tech/node-simple-server';
 ```
 
-Depending on how you use and incorporate NSS into your project will determine the best dependency strategy to use.
+### Manually:
+
+Node Simple Server (NSS) can be manually incorporated into your development process/ application. Extract the `nss` folder from the [latest release](https://github.com/caboodle-tech/node-simple-server/releases/) and then `import` the server module into your code, similar to:
+
+```javascript
+import NodeSimpleServer from './nss.js';
+```
 
 ### Globally:
 
 You can install and use NSS globally with:
 
 ```bash
-npm install --global @caboodle-tech/node-simple-server
+pnpm install -g @caboodle-tech/node-simple-server
 ```
 
+Depending on how you use and incorporate NSS into your project will determine the best dependency strategy to use.
+
 ## Usage
 
 NSS is designed to be controlled and/or wrapped by another application. The bare minimum code needed to use NSS in your application is:
@@ -77,8 +83,12 @@ const serverOptions = {
 // Get a new instance of NSS.
 const Server = new NodeSimpleServer(serverOptions);
 
-// A bare minimum callback to handle most development changes.
-function watcherCallback(event, path, extension) {
+/**
+ * A bare minimum callback to handle most development changes. You register only for
+ * the events you need; unhandled events (e.g. unlink/unlinkDir if not listed) are ignored.
+ */
+const watcherCallback = (event, path, statsOrDetails) => {
+    const extension = statsOrDetails.ext;
     if (extension === 'css') {
         Server.reloadAllStyles();
         return;
@@ -95,7 +105,11 @@ function watcherCallback(event, path, extension) {
     if (event === 'change') {
         Server.reloadSinglePage(path);
     }
-}
+    // When a file or directory is removed, reload so the browser does not show stale content.
+    if (event === 'unlink' || event === 'unlinkDir') {
+        Server.reloadAllPages();
+    }
+};
 
 /**
  * A bare minimum callback to handle all websocket messages from the frontend. By
@@ -104,15 +118,12 @@ function watcherCallback(event, path, extension) {
  * 
  * NSS_WS.send([string|int|bool|object]) // Pathname lookup will be used.
  */
-function websocketCallback(messageObject, pageId) {
-    // Interpret and do what you need to with the message:
-    const datatype = messageObject.type
+const websocketCallback = (messageObject, pageId) => {
+    const datatype = messageObject.type;
     const data = messageObject.data;
-    console.log(`Received ${datatype} data from page ${pageId}: ${data}`)
-
-    // Respond to the page that sent the message if you like:
-    Server.message(pageId, 'Messaged received!');
-}
+    console.log(`Received ${datatype} data from page ${pageId}: ${data}`);
+    Server.message(pageId, 'Message received!');
+};
 Server.addWebsocketCallback('.*', websocketCallback);
 
 /**
@@ -122,21 +133,21 @@ Server.addWebsocketCallback('.*', websocketCallback);
  * 
  * NSS_WS.send([string|int|bool|object], [route string]) // Route lookup will be used.
  */
-function websocketCallback(messageObject, pageId) {
-    // Interpret and do what you need to with the message:
-    const datatype = messageObject.type
+const websocketCallbackRoute = (messageObject, pageId) => {
+    const datatype = messageObject.type;
     const data = messageObject.data;
-    console.log(`Route received ${datatype} data from page ${pageId}: ${data}`)
-
-    // Respond to the page that sent the message if you like:
-    Server.message(pageId, 'Route specific messaged received!');
-}
-Server.addWebsocketCallback('api/search', websocketCallback);
+    console.log(`Route received ${datatype} data from page ${pageId}: ${data}`);
+    Server.message(pageId, 'Route specific message received!');
+};
+Server.addWebsocketCallback('api/search', websocketCallbackRoute);
 
-// A bare minimum watcher options object; use for development, omit for production.
+/**
+ * Watcher options: the events you register are your intent. Only registered events
+ * are handled; others (e.g. unlink, unlinkDir) are ignored unless you add them.
+ */
 const watcherOptions = {
     events: {
-        all: watcherCallback, // Just send everything to a single function.
+        all: watcherCallback,
     },
 };
 
@@ -147,7 +158,7 @@ Server.start();
 Server.watch(websiteRoot, watcherOptions);
 ```
 
-The `options` object **required** by the `watch` method must include an `events` property with at least one watched event. The demo code above used `all` to capture any event. This object takes a lot of settings and is explained below in the **Watch Options** table.
+The `options` object **required** by the `watch` method must include an `events` property with at least one watched event. The demo code above used `all` to capture any event. You express intent by which events you register: only those are handled; others are ignored. If your app has a build step (e.g. source → output), register for `unlink` and `unlinkDir` in `events` to react when files or directories are removed (e.g. to keep your output in sync). This object takes a lot of settings and is explained below in the **Watch Options** table.
 
 NSS uses `process.cwd()` as the live servers root if omitted and is pre-configured with several additional default settings. You can change these by providing your own `options` object when instantiating the server. How this looks in code is shown below, the following table **Server Options** explains all available options.
 
@@ -203,7 +214,7 @@ const Server = new NodeSimpleServer(options);
 
 #### **events**
 
--   Set to an object that can have any combination of these properties: `all`, `add`, `addDir`, `change`, `unlink`, `unlinkDir`, `ready`, `raw`, `error`. Any property set on `events` should point to a callback function that will handle that event.
+-   Set to an object that can have any combination of these properties: `all`, `add`, `addDir`, `change`, `unlink`, `unlinkDir`, `ready`, `raw`, `error`. Any property set on `events` should point to a callback function that will handle that event. Only the events you register are handled; others are ignored. Use `unlink` and `unlinkDir` when you need to react to file or directory deletion (e.g. to sync your build output or trigger a reload).
 
 #### **persistent**    default: true
 

package/bin/nss.js

@@ -10,9 +10,8 @@ import ContentTypes from '../handlers/js/content-types.js';
 import HTTPStatus from '../handlers/js/http-status.js';
 import Print from './print.js';
 
-// eslint-disable-next-line no-underscore-dangle
 const __filename = fileURLToPath(import.meta.url);
-// eslint-disable-next-line no-underscore-dangle
+
 const __dirname = Path.dirname(__filename);
 const APP_ROOT = Path.join(__dirname, '../');
 
@@ -44,7 +43,7 @@ class NodeSimpleServer {
         map: {}
     };
 
-    #VERSION = '4.2.4';
+    #VERSION = '4.2.8';
 
     #watching = [];
 
@@ -125,16 +124,25 @@ class NodeSimpleServer {
      * Get an array of all the IP addresses you can reach this server at either from
      * the machine itself or on the LAN.
      *
+     * @param {number} [port] The port number to use in the addresses. If not provided,
+     *                        will use the port currently in use by the server, or the
+     *                        configured port if the server hasn't started yet.
      * @return {Array} An array of loop back ip addresses and LAN addresses to this server.
      */
     getAddresses(port) {
+        /*
+         * Use provided port, or fall back to portInUse (actual port server is using),
+         * or finally to the configured port. Check for undefined/null specifically to
+         * allow 0 if explicitly provided (though unlikely).
+         */
+        const actualPort = port !== undefined && port !== null ? port : this.#OPS.portInUse || this.#OPS.port;
         const locals = this.#getLocalAddresses();
         const addresses = [
-            `http://localhost:${port}`,
-            `http://127.0.0.1:${port}`
+            `http://localhost:${actualPort}`,
+            `http://127.0.0.1:${actualPort}`
         ];
         Object.keys(locals).forEach((key) => {
-            addresses.push(`http://${locals[key]}:${port}`);
+            addresses.push(`http://${locals[key]}:${actualPort}`);
         });
         return addresses;
     }
@@ -156,8 +164,8 @@ class NodeSimpleServer {
                 files.push(item);
             }
         });
-        files.sort((a, b) => a.localeCompare(b));
-        dirs.sort((a, b) => a.localeCompare(b));
+        files.sort((a, b) => { return a.localeCompare(b); });
+        dirs.sort((a, b) => { return a.localeCompare(b); });
         // Build the innerHTML for the directory and files unordered list.
         let fileHtml = '';
         let dirHtml = '';
@@ -222,18 +230,11 @@ class NodeSimpleServer {
         let hour = timestamp.getUTCHours();
         let minute = timestamp.getUTCMinutes();
         let second = timestamp.getUTCSeconds();
-        if (dayNum.length < 10) {
-            dayNum = `0${dayNum}`;
-        }
-        if (hour.length < 10) {
-            hour = `0${hour}`;
-        }
-        if (minute.length < 10) {
-            minute = `0${minute}`;
-        }
-        if (second.length < 10) {
-            second = `0${second}`;
-        }
+        // Convert to string and pad with leading zero if needed
+        dayNum = String(dayNum).padStart(2, '0');
+        hour = String(hour).padStart(2, '0');
+        minute = String(minute).padStart(2, '0');
+        second = String(second).padStart(2, '0');
         return `${dayStr}, ${dayNum} ${monStr} ${timestamp.getUTCFullYear()} ${hour}:${minute}:${second} GMT`;
     }
 
@@ -288,7 +289,7 @@ class NodeSimpleServer {
         // Standard headers that should always be set for NSS.
         let mtime = new Date().toUTCString();
         if (settings?.file) {
-            mtime = Fs.statSync(settings.file).mtime;
+            ({ mtime } = Fs.statSync(settings.file));
         }
         const nssHeaders = {
             'Cache-Control': 'public, max-age=0',
@@ -324,7 +325,7 @@ class NodeSimpleServer {
      * like directory listing, page not found, access denied, and so on.
      */
     #loadHandlers() {
-        // eslint-disable-next-line max-len, no-template-curly-in-string
+        // eslint-disable-next-line max-len
         const internalError = '<!DOCTYPE html><html><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>500 Internal Server Error</title><style>body,html{margin:0;padding:0}body{padding:15px}</style></head><body><h1>500 Internal Server Error</h1><p>Could not locate source file.</p><hr><p><i>Node Simple Server (NSS) {{version}} Server <script type="text/javascript">document.write(`${document.location.protocol}//${document.location.hostname}`);</script> Port <script type="text/javascript">document.write(document.location.port)</script></i></p>{{liveReloading}}</body></html>';
 
         const dirListingSrc = Path.join(APP_ROOT, 'handlers', 'dir-listing.html');
@@ -377,18 +378,32 @@ class NodeSimpleServer {
      * Print the addresses the server is listening on to the console; this is useful for users who
      * are not sure what address to use to access the server.
      *
+     * @param {number|boolean} [portOrReturn] If a number, the port to use in the addresses.
+     *                                         If a boolean, whether to return the message instead of printing.
      * @param {boolean} [returnInstead=false] If true the function will return the message string instead.
      */
-    // eslint-disable-next-line consistent-return
-    printListeningAddresses(returnInstead = false) {
+
+    printListeningAddresses(portOrReturn, returnInstead = false) {
+        // Handle backward compatibility: if first arg is boolean, it's returnInstead
+        let port;
+        let shouldReturn = returnInstead;
+        if (typeof portOrReturn === 'boolean') {
+            shouldReturn = portOrReturn;
+            port = undefined;
+        } else if (typeof portOrReturn === 'number') {
+            port = portOrReturn;
+        } else {
+            port = undefined;
+        }
+
         let message = 'Node Simple Server live @:\n';
-        const addresses = this.getAddresses(this.#OPS.port);
+        const addresses = this.getAddresses(port);
         addresses.forEach((address) => {
             message += `    ${address}\n`;
         });
         message += '\n';
 
-        if (returnInstead) {
+        if (shouldReturn) {
             return message;
         }
         Print.notice(message);
@@ -408,7 +423,7 @@ class NodeSimpleServer {
             }
             if (pattern[0] === '/' && pattern[pattern.length - 1] === '/') {
                 // eslint-disable-next-line no-param-reassign
-                pattern = pattern.substr(1, pattern.length - 2);
+                pattern = pattern.slice(1, -1);
             }
             return new RegExp(`^${pattern}$`);
         } catch (e) {
@@ -482,8 +497,8 @@ class NodeSimpleServer {
             pattern = this.makeRegex(pattern);
         }
         // See if the pattern is a page id first.
-        if (this.#sockets.map[original]) {
-            this.#sockets.map[original].send('reload');
+        if (this.#sockets.map[`S${original}`]) {
+            this.#sockets.map[`S${original}`].send('reload');
             return;
         }
         // See if the pattern matches a specific URL and reload all those pages.
@@ -528,8 +543,8 @@ class NodeSimpleServer {
             pattern = this.makeRegex(pattern) || original;
         }
         // See if the pattern is a page id first.
-        if (this.#sockets.map[original]) {
-            this.#sockets.map[original].send('refreshCSS');
+        if (this.#sockets.map[`S${original}`]) {
+            this.#sockets.map[`S${original}`].send('refreshCSS');
             return;
         }
         // See if the pattern matches a specific URL and reload all those pages.
@@ -669,29 +684,40 @@ class NodeSimpleServer {
             return;
         }
 
-        // Get the file.
-        const file = Fs.readFileSync(systemPath, { encoding: 'binary' });
-
-        // Output the file to the browser.
-        resp.writeHead(HTTPStatus.ok, this.#getHeaders({
-            contentType: ContentTypes[ext] || this.#OPS.contentType,
-            file: systemPath
-        }));
+        const contentType = ContentTypes[ext] || this.#OPS.contentType;
+        const isText = contentType.startsWith('text/') ||
+            contentType === 'application/json' ||
+            contentType === 'application/ld+json' ||
+            contentType === 'application/manifest+json' ||
+            contentType === 'application/xhtml+xml';
+
+        // Read with no encoding: returns Buffer of raw bytes (Node.js fs docs). Sending that
+        // Buffer preserves the file bytes; do not use 'binary' (alias for latin1) which
+        // misinterprets UTF-8 multi-byte sequences.
+        const file = Fs.readFileSync(systemPath);
+
+        // Output the file to the browser. Only set charset for text types.
+        const headerSettings = { contentType, file: systemPath };
+        if (isText) {
+            headerSettings.charset = 'utf-8';
+        }
+        resp.writeHead(HTTPStatus.ok, this.#getHeaders(headerSettings));
 
-        // If needed inject NSS's WebSocket at the end of the page.
+        // If needed inject NSS's WebSocket at the end of the page, decode to string, modify, re-encode.
         if (this.#reload.includes(ext)) {
-            let html = file.toString();
+            const html = file.toString('utf8');
             const last = html.lastIndexOf('</body>');
+            let body;
             if (last && last > 0) {
                 const start = html.substring(0, last);
                 const end = html.substring(last);
-                html = start + this.#handlers.liveReloading + end;
-                resp.write(html, 'utf-8');
+                body = Buffer.from(start + this.#handlers.liveReloading + end, 'utf8');
             } else {
-                resp.write(file, 'binary');
+                body = Buffer.from(html, 'utf8');
             }
+            resp.write(body);
         } else {
-            resp.write(file, 'binary');
+            resp.write(file);
         }
         resp.end();
     }
@@ -753,7 +779,8 @@ class NodeSimpleServer {
      */
     #socketListener(socket, request) {
         // Strip the page ID and /ws tag off the url to get the actual url.
-        let cleanURL = request.url.substr(1, request.url.indexOf('/ws?id=') - 1);
+        const wsIndex = request.url.indexOf('/ws?id=');
+        let cleanURL = wsIndex > 0 ? request.url.slice(1, wsIndex) : '';
         if (!cleanURL) {
             cleanURL = this.#OPS.indexPage;
         }
@@ -779,17 +806,16 @@ class NodeSimpleServer {
 
         let pageId;
         if (idStartIndex !== -1) {
-            pageId = request.url.substr(idStartIndex).replace('?id=', '');
+            pageId = request.url.slice(idStartIndex).replace('?id=', '');
         } else {
             pageId = 'unknown';
         }
 
-        // eslint-disable-next-line no-param-reassign
         socket.nssUid = pageId;
 
         // Overwrite the default send method to NSS's standard.
         const originalSend = socket.send.bind(socket);
-        // eslint-disable-next-line no-param-reassign
+
         socket.send = (message) => {
             originalSend(JSON.stringify({
                 message,
@@ -835,7 +861,7 @@ class NodeSimpleServer {
             // Pull out specific route if there is one.
             let route = null;
             if ('route' in msgObj) {
-                route = msgObj.route;
+                ({ route } = msgObj);
             }
 
             // See if the message belongs to a callback and send it there.
@@ -866,7 +892,7 @@ class NodeSimpleServer {
             for (let i = 0; i < connections.length; i++) {
                 if (connections[i].nssUid === pageId) {
                     connections.splice(i, 1);
-                    delete this.#sockets.map[pageId];
+                    delete this.#sockets.map[`S${pageId}`];
                     break;
                 }
             }
@@ -910,9 +936,11 @@ class NodeSimpleServer {
             return;
         }
 
-        // Create the HTTP server.
+        /*
+         * Create the HTTP server. Capture connection upgrade requests so we don't
+         * break WebSocket connections.
+         */
         this.#server = Http.createServer(this.#serverListener.bind(this));
-        // Capture connection upgrade requests so we don't break WebSocket connections.
         // eslint-disable-next-line no-unused-vars
         this.#server.on('upgrade', (request, socket) => {
             /*
@@ -927,13 +955,15 @@ class NodeSimpleServer {
              * requests so they get passed on to the this.#socket.connection listener.
              */
             if (request.headers.upgrade === 'websocket') {
-                // eslint-disable-next-line no-useless-return
+
                 return;
             }
         });
-        // Capture server errors and respond as needed.
+        /*
+         * Capture server errors and respond as needed. The port we tried to use is
+         * taken, increment and try to start again.
+         */
         this.#server.on('error', (error) => {
-            // The port we tried to use is taken, increment and try to start again.
             if (error.code === 'EADDRINUSE') {
                 if (port) {
                     // Stop trying new ports after 100 attempts.
@@ -955,7 +985,7 @@ class NodeSimpleServer {
             Print.error(`Server Error:\n${error}`);
         });
 
-        // Attempt to start the server now.
+        /* Attempt to start the server now. */
         // eslint-disable-next-line no-param-reassign
         port = port || this.#OPS.port;
         this.#server.listen(port, () => {
@@ -997,12 +1027,14 @@ class NodeSimpleServer {
             // If any back-end files are being watched for changes stop monitoring them.
             this.watchEnd();
             // Close all socket connections; these would force the server to stay up.
-            const keys = Object.keys(this.#sockets);
+            const keys = Object.keys(this.#sockets.routes);
             keys.forEach((key) => {
-                this.#sockets.routes[key].forEach((socket) => {
-                    socket.send('close');
-                    socket.close();
-                });
+                if (this.#sockets.routes[key]) {
+                    this.#sockets.routes[key].forEach((socket) => {
+                        socket.send('close');
+                        socket.close();
+                    });
+                }
             });
             // Now gracefully close SERVER and SOCKET.
             this.#server.close();
@@ -1064,7 +1096,7 @@ class NodeSimpleServer {
          * directory to NSS's root if the setting is missing.
          */
         if (!options.cwd) {
-            // eslint-disable-next-line no-param-reassign
+
             options.cwd = this.#OPS.root;
         }
         // Convert paths to array if it's not already.
@@ -1076,9 +1108,10 @@ class NodeSimpleServer {
             // Start watching the path(s).
             const watcher = Chokidar.watch(paths, options);
             this.#watching.push(watcher);
+
             // Prepare to modify some of the standard Chokidar listeners.
             const alterAddUpdates = ['add', 'addDir', 'change'];
-            const alterCatachAlls = ['all', 'raw'];
+            const alterCatchAlls = ['all', 'raw'];
             const alterUnlinks = ['unlink', 'unlinkDir'];
             // Hookup requested listeners; they are case sensitive so type them right in your code!
             Object.keys(options.events).forEach((key) => {
@@ -1088,12 +1121,12 @@ class NodeSimpleServer {
                  * Chokidar provides paths in the correct OS format but NSS will change
                  * all backslashes (\) into forward slashes (/).
                  */
-                if (alterCatachAlls.includes(key)) {
+                if (alterCatchAlls.includes(key)) {
                     watcher.on(key, (evt, path, statsOrDetails = {}) => {
                         // Capture the call and alter the path before passing it on.
                         const altPath = path.replace(/\\/g, '/');
                         // Since we're messing with the path already grab the extension for the user.
-                        // eslint-disable-next-line no-param-reassign
+
                         statsOrDetails.ext = Path.extname(altPath).replace('.', '');
                         options.events[key](evt, altPath, statsOrDetails);
                     });
@@ -1102,7 +1135,7 @@ class NodeSimpleServer {
                         // Capture the call and alter the path before passing it on.
                         const altPath = path.replace(/\\/g, '/');
                         // Since we're messing with the path already grab the extension for the user.
-                        // eslint-disable-next-line no-param-reassign
+
                         statsOrDetails.ext = Path.extname(altPath).replace('.', '');
                         options.events[key](altPath, statsOrDetails);
                     });
@@ -1145,7 +1178,7 @@ class NodeSimpleServer {
      */
     whatIs(unknown) {
         try {
-            return ({}).toString.call(unknown).match(/\s([^\]]+)/)[1].toLowerCase();
+            return {}.toString.call(unknown).match(/\s([^\]]+)/)[1].toLowerCase();
         } catch (e) { return undefined; }
     }
 

package/bin/print.js

@@ -1,5 +1,3 @@
-/* eslint-disable no-console */
-
 class Print {
 
     #enabled = true;

package/changelogs/v4.md

@@ -1,3 +1,39 @@
+### NSS 4.2.8 (unreleased)
+
+- fix: Socket map key on close and in reloadSinglePage/reloadSingleStyles use `S${pageId}` consistently.
+- fix: Serve file bodies as raw bytes (read with no encoding); only decode/re-encode when injecting live-reload script. Fixes UTF-8 mojibake (e.g. entities, em dashes, Arabic, CJK) that occurred when using `encoding: 'binary'` (latin1).
+- fix: Example controllers no longer call printListeningAddresses() after start(); start() already prints once.
+- refactor: README and example code use const arrow functions instead of function declarations; watcher examples clarify intent via events (e.g. unlink/unlinkDir).
+- docs: Example www-website includes character-test.html demo (entities, emojis, RTL/LTR, UTF-8).
+
+### NSS 4.2.7 (5 January 2026)
+
+- build: Migrate ESLint configuration to flat config format
+- build: Add custom ESLint rules for HTML, JavaScript, and JSON
+- deps: Update chokidar from ^3.5.3 to ^5.0.0
+- deps: Update ws from ^8.13.0 to ^8.19.0
+- deps: Replace eslint-config-airbnb-base with @html-eslint/eslint-plugin and eslint-plugin-jsonc
+- deps: Update ESLint from ^8.2.0 to ^9.39.2
+- deps: Add engines field specifying Node.js >=14.0.0 requirement
+- feat: Enhance getAddresses() to handle optional port parameter with fallback logic
+- feat: Enhance printListeningAddresses() to accept port parameter while maintaining backward compatibility
+- fix: Replace deprecated substr() with slice() method
+- fix: Use object destructuring for better code quality (prefer-destructuring rule)
+- fix: Update arrow functions to use block statements (arrow-body-style rule)
+- refactor: Replace manual string padding with padStart() method
+- refactor: Remove unused eslint-disable directives
+- style: Fix HTML meta tags formatting (remove self-closing, sort attributes)
+- style: Remove unnecessary type attributes from script tags
+- style: Fix SVG attribute ordering in HTML handlers
+- docs: Update README.md with pnpm installation instructions
+- docs: Improve installation documentation structure
+- docs: Update watcher callback example to reflect Chokidar v4+ API changes
+
+### NSS 4.2.5 (23 July 2024)
+
+- chore: Document changes since 4.2.2 here in the changelog:
+    - Allow users to control address printing instead or printing it automatically.
+
 ### NSS 4.2.2 (24 January 2024)
 
 - feat: Add WebSocket to connection with backend routes.

package/eslint/html-rules.js

@@ -0,0 +1,24 @@
+/**
+ * Caboodle Tech's opinionated rules for linting HTML with ESLint. Feel free to adapt or modify
+ * these rules to suit your needs.
+ *
+ * ESLint Plugin: {@link https://www.npmjs.com/package/@html-eslint/eslint-plugin @html-eslint/eslint-plugin}
+ * HTML ESLint Parser: {@link https://html-eslint.org/docs/rules HTML ESLint Docs}
+ */
+export default {
+    '@html-eslint/indent': ['error', 4],
+    '@html-eslint/no-duplicate-attrs': 'error',
+    '@html-eslint/no-duplicate-id': 'error',
+    '@html-eslint/no-extra-spacing-attrs': 'error',
+    '@html-eslint/no-inline-styles': 'warn',
+    '@html-eslint/no-multiple-empty-lines': ['error', { max: 1 }],
+    '@html-eslint/no-obsolete-tags': 'error',
+    '@html-eslint/no-script-style-type': 'error',
+    '@html-eslint/no-trailing-spaces': 'error',
+    '@html-eslint/require-button-type': 'warn',
+    '@html-eslint/require-closing-tags': 'error',
+    '@html-eslint/require-doctype': 'error',
+    '@html-eslint/require-li-container': 'warn',
+    '@html-eslint/require-meta-viewport': 'error',
+    '@html-eslint/sort-attrs': 'warn'
+};